Skip to content
Home/
/WhatsApp

WhatsApp

Everything about your WhatsApp messages

Operations

Retrieve WhatsApp message delivery status

Request

Retrieves the delivery status of a specific WhatsApp message by its message ID.

Returns the current status, conversation details, and any error information if the message failed to deliver.

Security
bearerAuth
Query
message_idstringrequired

The WhatsApp message ID to check status for

Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"2.16"
Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.16
curl -i -X GET \
  'https://api.intercom.io/messages/whatsapp/status?message_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.16'

Responses

Successful response

Bodyapplication/json
conversation_idstring

ID of the conversation

Example:"123456789"
statusstring

Current delivery status of the message

Enum:"sent""delivered""read""failed"
Example:"delivered"
typestring

Event type

Example:"broadcast_outbound"
created_atinteger

Creation timestamp

Example:1734537980
updated_atinteger

Last update timestamp

Example:1734538000
template_namestring

Name of the WhatsApp template used

Example:"appointment_reminder"
message_idstring

The WhatsApp message ID

Example:"wamid_abc123"
errorobject or null

Error details, present only when status is "failed"

Response
{
  "conversation_id": "123456789",
  "status": "delivered",
  "type": "broadcast_outbound",
  "created_at": 1734537980,
  "updated_at": 1734538000,
  "template_name": "appointment_reminder",
  "message_id": "wamid_abc123"
}