SMS

Access SMS message records and attachments for patients.

The SMS API provides read access to SMS message records associated with patients.

Base path: /{tenantName}/{instanceName}/patients/{patientId}/sms

---

Endpoints

GET Get All SMS

GET /{tenantName}/{instanceName}/patients/{patientId}/sms

Returns all SMS messages associated with a patient.

Query Parameters

Parameter	Type	Default	Description
page	integer	0	Page number
size	integer	20	Results per page
direction	string	—	Filter by INBOUND or OUTBOUND
startDate	string	—	Start of date range (ISO 8601)
endDate	string	—	End of date range (ISO 8601)

Example Response 200 OK

{
  "data": [
    {
      "id": "sms-uuid",
      "patientId": "a1b2c3d4",
      "direction": "OUTBOUND",
      "body": "Your appointment is confirmed for March 20 at 2:00 PM.",
      "sentAt": "2026-03-19T09:15:00Z",
      "status": "DELIVERED",
      "hasAttachment": false
    }
  ]
}

---

GET Get SMS by ID

GET /{tenantName}/{instanceName}/patients/{patientId}/sms/{smsId}

Returns a single SMS record with full message metadata.

---

GET Download SMS Attachment

GET /{tenantName}/{instanceName}/patients/{patientId}/sms/{smsId}/attachment

Downloads the file attachment from an SMS message.

Response

Header	Value
Content-Type	MIME type of the attachment (e.g., image/jpeg, application/pdf)
Content-Disposition	attachment; filename="{originalFilename}"

Only available for messages where hasAttachment: true.