Get a chat message
- Sandbox: available
- On your own host? Choose https://{host} in the playground.
One message of a thread you take part in. A message of another thread, or none, answers 404 CHAT_MESSAGE_NOT_FOUND.
Example
curl 'https://api.sandbox.ovok.com/v1/chat/threads/<threadId>/messages/<messageId>' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'bearerAuthorizationBearer <JWT>threadId*stringThe thread id.
^[A-Za-z0-9\-.]{1,64}$messageId*stringThe message id.
^[A-Za-z0-9\-.]{1,64}$The message.
application/json- response
id*stringthreadId*stringsender*text*stringattachments*array<>Files sent with the text.
sentAt*stringWhen the server took the message.
replyTo*stringclientId*stringcurl -X GET 'https://api.sandbox.ovok.com/v1/chat/threads/string/messages/string'{ "id": "string", "threadId": "string", "sender": { "reference": "string", "display": "string" }, "text": "string", "attachments": [ { "id": "string", "title": "string", "contentType": "string" } ], "sentAt": "string", "replyTo": "string", "clientId": "string"}Send a chat message POST
Sends a message to everyone else in the thread. Their open apps hear `chat.message` on the `chat` socket topic, and their phones get a push that names you, never the text. ## Behaviour - `text` is 1–4000 characters. `replyTo` optionally names the message this one answers. - `attachments` sends up to 5 files with the text: your own uploads from `POST /v1/chat/attachments`. Anything else answers **422** `CHAT_ATTACHMENT_NOT_OWN`. Readers download them with `GET /v1/chat/threads/<threadId>/messages/<messageId>/attachments/<attachmentId>`. - `clientId` is your app's id for the message. The same `clientId` from you in this thread again answers **200** with the message already sent, so a retried send never sends twice; a new one answers **201** with `Location`. - A closed thread answers **409** `CHAT_THREAD_CLOSED`. - Your own access policy must let you create a `Communication` about the thread's patient, else **403** `CHAT_WRITE_NOT_ALLOWED`. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/chat/threads/<threadId>/messages' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "text": "Thanks, see you on Monday.", "attachments": [], "replyTo": null, "clientId": "0f8f2b8e-6a1c-4f5e-9d63-8f2c4b9e7a10" }' ```
Download a chat attachment GET
Answers a link that downloads a file sent with a message. Whoever can read the message can download its files. ## Behaviour - The link works for an hour and needs no bearer, so it fits a browser tab, a download or a PDF viewer. Ask again for a fresh one when it has run out. - An id the message does not carry answers **404** `CHAT_ATTACHMENT_NOT_FOUND`. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/chat/threads/<threadId>/messages/<messageId>/attachments/<attachmentId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```