Get all SMS
GET {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}/sms
Following Query Parameters can be used to sort or find approporiately
We can use any combination of this parameters in single request: Example: {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}/sms?status=DELIVERED,FAILED&phone=+15625345678&starred=true
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
size | number | When specified, size per page | |
phone | string | When specified, search by 'to' or 'from' phone | |
status | string | When specified, search by status [SCHEDULED, ACCEPTED, SENT, RECEIVED, DELIVERED, UNDELIVERED, FAILED, UNRECOGNISED] | |
page | number | When specified, page number | |
sort | string | Allows one to specify the sort order of the returned sms collection | |
search | null | When specified, will execute a search based on message field | |
sender | null | When specified, search by sender id | |
receiver | null | When specified, search by receiver id | |
direction | null | When specified, search by direction (IN or OUT) | |
starred | null | When specified, search by starred (boolean value) field (as an important sms) | |
from | null | When specified, search by 'from' phone | |
to | null | When specified, search by 'to' phone | |
senderName | null | When specified, search by sender name | |
receiverName | null | When specified, search by receiver name |