Skip to main content

Get RCS message status

GET 
/api/partner-gateway/v1/rcs/messages/:messageId

Returns the current delivery status of an RCS (Rich Communication Services) message identified by its messageId. Use this endpoint to track the lifecycle of a specific RCS message after it has been sent. The messageId is the identifier returned in the response when you originally sent the message through the RCS send endpoint. Store this identifier on your side at send time so you can poll for status later. RCS delivery statuses and their meanings: DELIVERED - the RCS platform confirmed that the message was successfully delivered to the recipient device. This is a reliable delivery receipt provided by the RCS infrastructure, confirming the message arrived on the handset. Note that unlike WhatsApp, standard RCS does not report read receipts through this API, so readDate stays null. ERROR - the message could not be delivered. Common causes include: the carrier rejected the message, the agent ID is not properly registered, or the destination number is invalid. Consider implementing an SMS fallback strategy when RCS delivery fails. DISABLED - the recipient has RCS switched off. UNSUPPORTED - the recipient's device or number does not support RCS. EXPIRED - the message exceeded its time-to-live window without being delivered and was discarded by the carrier. This can happen when the recipient device is offline for an extended period. UNKNOWN - no status information is available, either because the carrier did not return a delivery receipt or because the message is still being processed. RCS has no separate in-flight status, so a message still awaiting its first receipt reads UNKNOWN. The Delivery Statuses table in the API overview lists the numeric code the delivery webhook sends for each of these statuses. RCS availability depends on carrier support and the recipient having an RCS-capable device with RCS enabled. If you need guaranteed delivery, consider pairing RCS sends with an SMS fallback by checking the status after a reasonable timeout and re-sending via SMS if the status is ERROR or EXPIRED. This endpoint is a per-channel shortcut over the same delivery-status source as GET /partner-gateway/v1/messages/status/{customerMessageId}?channel=RCS, which returns the identical payload and can also look up SMS — prefer it when you track more than one channel. Error responses: 401 is returned if the API key is missing or invalid. 404 is returned if the messageId does not exist or does not belong to the authenticated company.

Request​

Responses​

Message status retrieved successfully

Last updated on