Unrecognized SMS

Base URL: https://api.welkinhealth.com/{tenantName}/{instanceName}/unrecognized-sms

Unrecognized SMS messages are inbound texts from phone numbers not associated with any known patient.

---

Get All Unrecognized SMS

GET /unrecognized-sms

Returns a paginated list of unrecognized inbound SMS messages.

Query Parameters

Parameter	Type	Required	Description
startDate	string (ISO 8601)	No	Filter from date
endDate	string (ISO 8601)	No	Filter to date
status	string	No	PENDING or RESOLVED
page	integer	No	Page number (default: 0)
size	integer	No	Page size (default: 20)

Example Request

curl -X GET "https://api.welkinhealth.com/acme/live/unrecognized-sms?status=PENDING" \
  -H "Authorization: Bearer {access_token}"

Example Response

{
  "content": [
    {
      "id": "usms_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "fromNumber": "[phone]",
      "toNumber": "[phone]",
      "body": "Hello, I would like to schedule an appointment",
      "receivedAt": "2026-03-19T09:30:00Z",
      "status": "PENDING",
      "resolvedBy": null,
      "patientId": null
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "page": 0,
  "size": 20
}

---

Get Unrecognized SMS by ID

GET /unrecognized-sms/{smsId}

Returns a single unrecognized SMS record.

Path Parameters

Parameter	Type	Required	Description
smsId	string	Yes	ID of the unrecognized SMS

Example Request

curl -X GET "https://api.welkinhealth.com/acme/live/unrecognized-sms/usms_a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer {access_token}"

Example Response

{
  "id": "usms_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "fromNumber": "[phone]",
  "toNumber": "[phone]",
  "body": "Hello, I would like to schedule an appointment",
  "receivedAt": "2026-03-19T09:30:00Z",
  "status": "PENDING",
  "resolvedBy": null,
  "patientId": null
}

---

Resolve Unrecognized SMS

PATCH /unrecognized-sms/{smsId}

Links the SMS to a known patient and marks it as resolved.

Path Parameters

Parameter	Type	Required	Description
smsId	string	Yes	ID of the unrecognized SMS

Request Body

Field	Type	Required	Description
patientId	string	Yes	ID of the patient to link
status	string	Yes	Must be RESOLVED

Example Request

curl -X PATCH "https://api.welkinhealth.com/acme/live/unrecognized-sms/usms_a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{"patientId": "pt_7f3a9b2c-1d4e-4f8a-b5c6-d7e8f9a0b1c2", "status": "RESOLVED"}'

Example Response

{
  "id": "usms_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "fromNumber": "[phone]",
  "toNumber": "[phone]",
  "body": "Hello, I would like to schedule an appointment",
  "receivedAt": "2026-03-19T09:30:00Z",
  "status": "RESOLVED",
  "resolvedBy": "usr_1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  "patientId": "pt_7f3a9b2c-1d4e-4f8a-b5c6-d7e8f9a0b1c2"
}