Message Status

Status Report

Message Status Event

whatsapp_message_status_updated

Field	Data Type	Required	Description
id	String	Yes	Message Id
accountName	String	Yes	API account
wabaId	String	Yes	Waba Id
status	String	Yes	Send status:delivered、read、failed、SMECL:FAILED
wamid	String	Yes	WhatsApp message Id
sendPhone	String	Yes	WhatsApp user number
uid	String	No	Customer batch number, the batch number sent by the customer (uid)
conversation	JSON	No	Conversation information, has a value when status is delivered
billable	Boolean	Yes	Billable: true: billed, false: not billed
category	String	Yes	Message type: authentication verification code utility notification marketing marketing marketing_lite MMLite marketing service service message
price	String	Yes	Unit price, keep 5 decimal places.
currency	String	Yes	Currency

conversation object

Field	Data Type	Required	Description
initiateType	String	Yes	Conversation initiation type business_initiated: Conversation initiated by the businessreferral_conversion: Conversation initiated from a free entry point; this type of conversation is initiated by the usercustomer_initiated: Conversation initiated by the user
expireAt	String	Yes	Conversation expiration time, e.g.: 2023-02-22 12:00:00

errorData object

Field	Data Type	Required	Description
errorCode	String	Yes	Meta error code
errorMessage	String	Yes	Meta error description

Response message example

delivered: response example

{
    "id": "e5cb1bc6-ad90-419d-8f83-aa394c0b7cc7",
    "type": "whatsapp_message_status_updated",
    "eventTime": "2023-02-22T12:00:00.000Z",
    "body": {
        "id": "356139161272397824",
        "accountName": "IW123456",
        "wabaId": "11231231212331",
        "wamid": "wamid.BgNODYxN...", 
        "status": "delivered",
        "uid":"2002302023002010121",
        "sendPhone":"65123101212312",
        "conversation": {
            "id": "00e5a7e14a588d96bd2343d105d03ec5",
            "initiateType": "business_initiated",
            "expireAt": "2023-02-23T12:00:00.000Z"
        },
        "currency": "USD"
    }
}

read: response example

{
    "id": "cd0a316c-a781-4589-9f5f-5502ccf1f60f",
    "type": "whatsapp_message_status_updated",
    "eventTime": "2023-05-26T02:18:44.115Z",
    "body": {
        "accountName": "15902677617",
        "id": "356139161272397824",
        "status": "read",
        "uid":"2002302023002010121",
        "sendPhone":"65123101212312",
        "wabaId": "WHATSAPP_BUSINESS_ACCOUNT_ID",
        "wamid": "wamid.HBgNODYxNjY4NTE3NzYxMhUCABEYEjQ0RTYyQTM5QzAyMkU0QkNERgA="
    }
}

failed: response example

{
    "id": "e5cb1bc6-ad90-419d-8f83-aa394c0b7cc7",
    "type": "whatsapp_message_status_updated",
    "eventTime": "2023-05-25T10:31:08.167Z",
    "body": {
        "accountName": "15902677617",
        "errorData": {
            "errorCode": "131014",
            "errorMessage": "Request for url https://URL.jpg failed with error: 404 (Not Found)"
        },
        "id": "356139161272397824",
        "status": "failed",
         "uid":"2002302023002010121",
        "sendPhone":"65123101212312",
        "wabaId": "WHATSAPP_BUSINESS_ACCOUNT_ID",
        "wamid": "wamid.HBgNODYxNjY4NTE3NzYxMhUCABEYEjQ0RTYyQTM5QzAyMkU0QkNERgA="
    }
}