Whatsapp API
  • Getting Started
    • Dashboard API Overview
    • Register WhatsApp Business API Number
    • Get Channel ID & Link Your App
    • Get Access Token
    • Create WhatsApp Template
  • Whatsapp API
    • WhatsApp API's Overview
    • Media
      • Upload Media
      • Download Media
    • Send Messages
      • Text Mesage
      • Reaction Message
      • Media Message
      • Contact Message
      • Interactive Message
      • Template Message
      • Reply Message
    • Mark Message as Read
    • Set-up Webhook
      • Received Messages
      • Message Status
    • Error Codes
Powered by GitBook
On this page
  1. Whatsapp API
  2. Set-up Webhook

Message Status

PreviousReceived MessagesNextError Codes

Last updated 2 years ago

These are the sample payloads for Outbound Notification you will receive on your webhook

please refer to this as well to see the possible of status message object

Status: Message Sent

The following notification is received when a business sends a message

{
    "statuses": [
        {
            "id": "WHATSAPP_MESSAGE_ID",
            "status": "sent",
            "timestamp": "TIMESTAMP",
            "recipient_id": "CUSTOMER_PHONE_NUMBER",
            "conversation": {
                "id": "CONVERSATION_ID",
                "expiration_timestamp": "CONVERSATION_EXPIRATION_TIMESTAMP",
                "origin": {
                    "type": "user_initiated"
                }
            },
            "pricing": {
                "billable": true,
                "pricing_model": "CBP",
                "category": "user_initiated"
            }
        }
    ]
}

Status: Message Delivered

The following notification is received when a business message is delivered

{
    "statuses": [
        {
            "id": "wamid.ID",
            "recipient_id": "PHONE_NUMBER",
            "status": "delivered",
            "timestamp": "TIMESTAMP",
            "conversation": {
                "id": "CONVERSATION_ID",
                "expiration_timestamp": TIMESTAMP,
                "origin": {
                    "type": "user_initiated"
                }
            },
            "pricing": {
                "pricing_model": "CBP",
                "billable": true,
                "category": "user_initiated"
            }
        }
    ]
}

Status: Message Read

{
    "statuses": [
        {
            "id": "WHATSAPP_MESSAGE_ID",
            "status": "read",
            "timestamp": "TIMESTAMP",
            "recipient_id": "CUSTOMER_PHONE_NUMBER"
        }
    ]
}

Status: Message Failed

{
    "statuses": [
        {
            "id": "wamid.ID",
            "status": "failed",
            "timestamp": TIMESTAMP,
            "recipient_id": PHONE_NUMBER,
            "errors": [
                {
                    "code": 131014,
                    "title": "Request for url https://URL.jpg failed with error: 404 (Not Found)"
                }
            ]
        }
    ]
}
document