Intercom API (unofficial showcase)
GET/messages/whatsapp/status

Retrieve WhatsApp message delivery status

Retrieves the delivery status and conversation details for a specific WhatsApp message. Supply the message's message_id to check whether it was sent, delivered, read, or failed. The response includes error details when delivery fails.

2 parameters
message_idstringrequired
The identifier of the WhatsApp message whose delivery status you want to retrieve.
Intercom-Versionstringoptional
The API version to use. Defaults to 2.17 when omitted; supported values include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

4 status codes
200Returns the message's delivery status, conversation identifier, timestamps, template name, and message identifier. Includes error details when the status is failed.
conversation_idstringoptional
ID of the conversation
statusstringoptional
Current delivery status of the message
Allowed:sentdeliveredreadfailed
typestringoptional
Event type
created_atintegeroptional
Creation timestamp
updated_atintegeroptional
Last update timestamp
template_namestringoptional
Name of the WhatsApp template used
message_idstringoptional
The WhatsApp message ID
errorobjectoptional
Error details, present only when status is "failed"
400Returned when the required message identifier is missing.
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the WhatsApp message cannot be found.

One documented failure

  • whatsapp_message_not_found

    Whatsapp message not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned when the required message_id query parameter is missing. A 401 is returned when the request is unauthorized. A 404 is returned when the WhatsApp message cannot be found.