Skip to main content

North America - Message Failed

When sending to Two-Factor Authentication's (2FA) North America 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.
platformstringA field that indicates whether the message DLR was from the 2FA North America or International platform. For North America, this is set to NorthAmericaSMS.
messageObjectAn object that represents information about the message sent.
message.idstringThe unique ID of this message.
errorCodeintegerThe error code associated with the failure. See list of error codes here.

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" : "forbidden to country",
"platform" : "NorthAmericaSMS",
"message" : {
"id" : "14762070468292kw2fuqty55yp2b2",
},
"errorCode": 4432
}