Skip to main content

Message Failed

Description

The event will be triggered if a message sent through the Chat API has failed
any of the client validations. This can happen even after a successful request status
(status code 0) has been received.

The following flow outlines what happens when a message fails client validation:

  1. The message is sent.
  2. A response with a status of 0 is received, indicating a successful request.
  3. The message reaches the client and fails client validation.
  4. The failed callback is sent to the webhook, containing the unique message token
    and a string explaining the failure.

Note that failed messages will not be displayed to the recipient and no message delivered
or message seen events will be returned for it.

Event Payload

The event payload is a JSON object with the following properties:

Example
{  
"event":"failed",
"timestamp":1457764197627,
"message_token":4912661846655238145,
"user_id":"jc9HsWTZ2Yf2NkRZ8KcNug==",
"desc":"message validation failed"
}
PropertyDescriptionNotes
eventThe event name.Always failed
timestampThe time the event was triggered.Unix timestamp in milliseconds
message_tokenUnique ID of the message.
user_idThe unique ID of the subscriber
descA string explaining the failure.