Chat

List a thread’s messages

  • Sandbox: available
  • On your own host? Choose https://{host} in the playground.
GET
/v1/chat/threads/{threadId}/messages

A thread's messages, newest first.

Behaviour

  • since keeps only messages sent after an instant: after a socket reconnect, fetch since the newest message you have to get what was missed.
  • limit is 1–100 (default 30). Pass nextCursor as cursor to page back; it is null on the oldest page.

Example

curl 'https://api.sandbox.ovok.com/v1/chat/threads/<threadId>/messages?limit=30' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Authorization

bearer
headerAuthorizationBearer <JWT>

Path Parameters

threadId*string

The thread id.

Match^[A-Za-z0-9\-.]{1,64}$

Query Parameters

since?string

Only messages sent after this instant: the catch-up after a reconnect.

Formatdate-time
cursor?string

nextCursor from the previous page.

Length1 <= length <= 200
limit?integer
Range1 <= value <= 100
Default30

Response Body

The messages, newest first.

application/json
  1. response
items*array<>
nextCursor*string
Example Request
curl -X GET 'https://api.sandbox.ovok.com/v1/chat/threads/string/messages'
Example Response
{  "items": [    {      "id": "string",      "threadId": "string",      "sender": {        "reference": "string",        "display": "string"      },      "text": "string",      "attachments": [        {          "id": "string",          "title": "string",          "contentType": "string"        }      ],      "sentAt": "string",      "replyTo": "string",      "clientId": "string"    }  ],  "nextCursor": "string"}

Get a chat thread GET

One chat thread you take part in: its people, its newest message, your unread count and who read it up to when. Any other id answers **404** `CHAT_THREAD_NOT_FOUND`. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/chat/threads/<threadId>' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```

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" }' ```