Receive a detailed report of your message blast.
Body Parameters
Parameter | Description |
---|---|
push_id | The key for the specific push message. |
request_id | The key for the specific request. |
status | The result of delivered message. |
delivery_report | The result of a sent message including any reason for failure. See Delivery Report Object table below. |
blocked_mobile | The mobile number is inactive due to being blocked by carrier. See Blocked Mobile Object table below. |
status_code | A code notifying the member of the reason for the error. Status Code List |
> Delivery Report Object
Parameter | Description |
---|---|
sms | See SMS Object table below. |
>> SMS Object
Parameter | Description |
---|---|
task_id | The message's unique ID number. |
number | Mobile phone number. |
country_code | Country code of the number. |
dr_code | Delivery report code of the sent message. DR Code List |
> Blocked Mobile Object
Parameter | Description |
---|---|
number | The mobile phone number. |
country_code | Country code of the number. |
Example (Success)
{
"push_id" : 7778889990000,
"request_id" : "1234561234567asdf123",
"status" : "sent",
"sms":
{
"total" : 1,
"sent" : 1,
"failed" : 0
},
"delivery_report" :
{
"sms" :
[
{
"task_id" : 789789789001,
"number" : "4564564561",
"country_code" : 1,
"dr_code" : "DR000"
}
]
}
}
Example (Concatenated SMS _ US / CA)
{
"push_id" : 7778889990000,
"request_id" : "1234561234567asdf123",
"status" : "sent",
"sms":
{
"total" : 1,
"sent" : 1,
"failed" : 0
},
"delivery_report" :
{
"sms" :
[
{
"task_id" : "789789789001",
"number" : "4564564561",
"country_code" : 1,
"dr_code" : "DR000",
"multipart": [
{
"multipart_id": 120001,
"dr_code": "DR000",
"status": "sent"
},
{
"multipart_id": 120002,
"dr_code": "DR000",
"status": "sent"
}
]
}
]
}
}
Example (Concatenated SMS _ International)
{
"push_id" : 7778889990011,
"request_id" : "1234561234567asdf128",
"status" : "sent",
"sms":
{
"total" : 1,
"sent" : 1,
"failed" : 0
},
"delivery_report" :
{
"sms" :
[
{
"task_id" : "789789789007",
"number" : "4564564562",
"country_code" : 1,
"dr_code" : "DR000",
"multipart": [
]
}
]
}
}
Example (Failure)
{
"push_id" : 7778889990000,
"request_id" : "140408152912b21c08c7",
"status" : "failed",
"status_code" : "MRME0101"
}
Example (Failure)
When an outbound message is blocked by the recipient's carrier.
{
"push_id" : 7778889990000,
"request_id" : "1234561234567asdf123",
"task_id" : 987987987987,
"status" : "failed",
"blocked_mobile" :
{
"number" : "4564564560",
"country_code" : 1
}
}
Example (Concatenated SMS Failure)
{
"push_id" : 7778889990002,
"request_id" : "1234561234567asdf124",
"status" : "failed",
"status_code" : "MRME1010"
}
Example
When the delivery report is updated by the recipient's carrier after the first push message is sent.
{
"push_id" : 7778889990000,
"request_id" : "1234561234567asdf123",
"status" : "sent",
"sms":
{
"total" : 1,
"sent" : 0,
"failed" : 1
},
"delivery_report" :
{
"sms" :
[
{
"task_id" : 789789789001,
"number" : "4564564561",
"country_code" : 1,
"dr_code" : "DR007"
}
]
}
}