Skip to main content

International - Message Failed

When sending to Two-Factor Authentication's (2FA) International platform, you will receive a message-failed delivery receipt (DLR) upon unsuccessful delivery to the carrier.

Parameters#

ParameterTypeDescription
typestringThe Webhook (Callback) type. For message failed, this is set to message-failed.
timestringThe time of the event described in the receipt.
descriptionstringA detailed description of the event described by the receipt. Descriptions for failed messages are not always guaranteed, and can sometimes be populated with values such as No error even though a message has failed to send.
platformstringA field that indicates whether the message DLR was from the 2FA North America or International platform. For International, this is set to GlobalSMS.
messageObjectAn object that represents information about the message sent.
message.idstringThe unique ID of this message.
errorCodeintegerThe error code associated with the failure. For any questions regarding error codes in response to International Messaging, contact support.

Example 1 of 1: SMS Message failed#

POST /your_url HTTP/1.1
Content-Type: application/json; charset=utf-8
{
"type" : "message-failed",
"time" : "2016-09-14T18:20:16Z",
"description" : "Undeliverable",
"platform" : "GlobalSMS",
"message" : {
"id" : "14762070468292kw2fuqty55yp2b2",
},
"errorCode": 995
}