Skip to main content

Get single message delivery status

GET 
/api/partner-gateway/v1/messages/status/:customerMessageId

Returns the current delivery status of a single message identified by its customerMessageId. The customerMessageId is the unique identifier that the platform assigns to your message when you send it through one of the send endpoints (POST /partner-gateway/v1/sms/messages, POST /partner-gateway/v1/rcs/messages, or POST /partner-gateway/v1/whatsapp/messages). You should store this identifier on your side immediately after a successful send call so that you can track the message lifecycle later. Typical workflow: (1) Send a message via the appropriate channel endpoint and receive the customerMessageId in the response. (2) Wait a reasonable amount of time for carrier processing (a few seconds for SMS, potentially longer for RCS and WhatsApp). (3) Call this endpoint with the customerMessageId and the matching channel to retrieve the current status. The channel query parameter is mandatory and must exactly match the channel used to send the message. Supplying a mismatched channel (for example, querying an SMS message with channel=RCS) will result in a 404 because the lookup is scoped to the specified channel. Possible delivery statuses and their meanings: ACCEPTED (SMS) - the message has been accepted by the platform and forwarded to the carrier, but no delivery receipt has come back yet. This is the status an SMS carries while it is in flight. DELIVERED - the carrier or channel provider confirmed that the message reached the recipient device. REJECTED (SMS) - the carrier refused the message. UNDELIVERABLE (SMS) - the destination cannot receive the message, typically an unreachable or invalid number. DELETED (SMS) - the message was cancelled before it could be delivered. EXPIRED - the message was not delivered within the allowed time-to-live window and the carrier discarded it. ERROR (RCS, WhatsApp) - the message could not be delivered; check the deliveryStatusDescription field for the specific reason (common causes include invalid destination number, carrier rejection, or account suspension). DISABLED (RCS, WhatsApp) - the recipient has the channel switched off. UNSUPPORTED (RCS, WhatsApp) - the recipient's device or number does not support the channel. CONVERSATION_CLOSED (WhatsApp) - the 24-hour customer-service window had closed. UNKNOWN - the platform has no status information for this message, which on RCS and WhatsApp also covers a message still awaiting its first receipt, since those channels have no in-flight code of their own. The Delivery Statuses table in the API overview lists the numeric code the delivery webhook sends for each of these statuses. Error responses: 400 is returned when the channel parameter is missing or not one of RCS, WHATSAPP, SMS. 404 is returned when the customerMessageId does not exist for the given channel and company, or when the channel parameter does not match the original send channel. 500 indicates an unexpected server-side error; retry the request after a short delay. For bulk status checks, use the batch endpoint GET /partner-gateway/v1/messages/status instead.

Request​

Responses​

Delivery status found

Last updated on