API Reference

Message Acknowlegded Event

Description

This event is triggered when a message acknowledgement status changes.

The acknowledged field and the ack field in the message in the data object indicates the acknowledgement status of the message. Here's a breakdown of the possible values:

  • ERROR (-1): An error occurred while sending the message.
  • PENDING (0): The message is still pending and has not yet been sent to the server.
  • SERVER (1): The message has been successfully sent to the WhatsApp server.
  • DEVICE (2): The message has been delivered to the recipient's device.
  • READ (3): The recipient has read the message.
  • PLAYED (4): The recipient has played the audio/video message.

Webhook Request

HTTP Method

POST

Request Headers

NameValue
Content-Typeapplication/json
User-AgentWaAPI Webhook User Agent

Request Body

{ "event": "message_ack", "instanceId": "1", "data": { "message": { "_data": { "id": { "fromMe": true, "remote": "123456789@c.us", "id": "AAABBBCCCDDDEEEFFF111222333", "_serialized": "true_123456789@c.us_AAABBBCCCDDDEEEFFF111222333" }, "viewed": false, "body": "sample message", "type": "chat", "t": 1738927717, "notifyName": "test user", "from": "987654321@c.us", "to": "123456789@c.us", "author": "987654321@c.us", "ack": 2, "invis": false, "isNewMsg": true, "star": false, "kicNotified": false, "recvFresh": true, "isFromTemplate": false, "pollInvalidated": false, "isSentCagPollCreation": false, "latestEditMsgKey": null, "latestEditSenderTimestampMs": null, "mentionedJidList": [], "groupMentions": [], "isEventCanceled": false, "eventInvalidated": false, "isVcardOverMmsDocument": false, "isForwarded": false, "hasReaction": false, "viewMode": "VISIBLE", "messageSecret": { "0": 204, "1": 190, "2": 141, "3": 71, "4": 130, "5": 121, "6": 62, "7": 66, "8": 75, "9": 145, "10": 80, "11": 35, "12": 228, "13": 100, "14": 254, "15": 225, "16": 250, "17": 49, "18": 174, "19": 132, "20": 228, "21": 180, "22": 167, "23": 58, "24": 94, "25": 22, "26": 202, "27": 124, "28": 114, "29": 114, "30": 101, "31": 159 }, "productHeaderImageRejected": false, "lastPlaybackProgress": 0, "isDynamicReplyButtonsMsg": false, "isCarouselCard": false, "parentMsgId": null, "callSilenceReason": null, "isVideoCall": false, "isMdHistoryMsg": false, "stickerSentTs": 0, "isAvatar": false, "lastUpdateFromServerTs": 0, "invokedBotWid": null, "bizBotType": null, "botResponseTargetId": null, "botPluginType": null, "botPluginReferenceIndex": null, "botPluginSearchProvider": null, "botPluginSearchUrl": null, "botPluginSearchQuery": null, "botPluginMaybeParent": false, "botReelPluginThumbnailCdnUrl": null, "botMsgBodyType": null, "requiresDirectConnection": false, "bizContentPlaceholderType": null, "hostedBizEncStateMismatch": false, "senderOrRecipientAccountTypeHosted": false, "placeholderCreatedWhenAccountIsHosted": false, "links": [] }, "id": { "fromMe": true, "remote": "123456789@c.us", "id": "AAABBBCCCDDDEEEFFF111222333", "_serialized": "true_123456789@c.us_AAABBBCCCDDDEEEFFF111222333" }, "ack": 2, "hasMedia": false, "body": "sample message", "type": "chat", "timestamp": 1738927717, "from": "987654321@c.us", "to": "123456789@c.us", "author": "987654321@c.us", "deviceType": "ios", "isForwarded": false, "forwardingScore": 0, "isStatus": false, "isStarred": false, "fromMe": true, "hasQuotedMsg": false, "hasReaction": false, "vCards": [], "mentionedIds": [], "groupMentions": [], "isGif": false, "links": [] }, "acknowledged": 2 } }