Chat: Get messages by token
GET {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}/chat?pageToken=eyJ0eXBlIjoiTE9DQUxfRklORCIsInBhZ2VTaXplIjoyLCJib3JkZXJEYXRlIjoiMjAyMS0wMy0wNVQxNjowNzozMS4yOThaIiwiYmVmb3JlIjp0cnVlfQ==
Get messages for patient.
URL Structure: {{url}} / {{tenantName}} / {{instanceName}} / patient / {{patientId}} / chat
in our example it would be:
https://api.live.welkincloud.io/gh/sb-demo/patient/7272b601-bb09-4abf-87c0-ade48ddfaea0/chat?pageToken=eyJ0eXBlIjoiTE9DQUxfRklORCIsInBhZ2VTaXplIjoyLCJib3JkZXJEYXRlIjoiMjAyMS0wMy0wNVQxNjowNzozMS4yOThaIiwiYmVmb3JlIjp0cnVlfQ==
Response meta fields
| Field | Description |
|---|---|
| nextPageToken | Token for receiving next page (null if this page is last) |
| prevPageToken | Token for receiving previous page (null if this page is first) |
Response content fields
| Field | Description |
|---|---|
| externalId | unique message ID |
| sender.clientType | PATIENT, USER |
| sender.titleName | User firstname and lastname, joined by space. Exists only if clientType = USER |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageToken | string | token for fetching specific page, mutually exclusive with pageSize | |
includeArchived | boolean | if true, include archived messages to the result | |
size | number | page size, mutually exclusive with pageToken |