Skip to main content
GET
Get Message Status
This endpoint is currently under construction. Please reach out to support if you'd like to use it.
Returns the status of a specific message request - use this to check the progress of that message.
We recommend using the message.status webhook to receive delivery status updates instead of polling this endpoint.

Path Params

string
required
The ID of the message. This is returned when you send a message.

Response

Returns the Message at the top level (not wrapped).
string
required
The ID of the message.
string
required
The ID of the Patient the message relates to.
string
required
One of outbound or inbound.
string
required
The delivery status. One of processing, completed, or failed.
string
required
How the message is transported. One of xdr or direct.
string
The network used for XDR delivery. One of EHEX, CAREQUALITY, or COMMONWELL. Required when transportMethod is xdr.
string
required
Where the message is delivered. An OID or a Direct email address.
string
required
The subject of the message.
string
Plain-text content of the message, when present.
string[]
Document IDs attached to the message, when present.
string[]
Intended recipient NPIs, when present.
string
required
ISO 8601 timestamp of when the message was created / accepted for send.
string
required
ISO 8601 timestamp of the latest status update.
string
Failure reason. Only present when status is failed.