Callback - SMS Delivery reports

Notifications you receive about the status of your messages.

Example:

POST http://www.yourserver.com/sms-delivery-reports

The following parameters are sent in as delivery reports - callback.

When you send an SMS, you have to set the "callback" parameter in order to receive notification when the delivery status of an SMS changes.

Your callback service will receive a POST HTTP request with the following request body:

{
   "messageId":"string",
   "smsId":"string",
   "campaignTrackingId":"string",
   "part":"number",
   "parts":"number",
   "label":"string",
   "to":"string",
   "from":"string",
   "country":"string",
   "operator":"string",
   "groups":[
      "string"
   ],
   "campaignName":"string",
   "status":{
      "name":"string",
      "reason":{
         "detailedStatus":"string",
         "description":"string"
      },
      "updatedDate":"string"
   },
   "message":"string",
   "applicationName":"string",
   "latency":"number",
   "price":"number",
   "direction":"string",
   "originatingService":"string"
}

PARAMETERS:

KEY

DESCRIPTION

messageId

The trackingId of the SMS (all the parts of a multipart SMS have the same messageId).

smsId

The unique id of each SMS part included in a message. If the message is multipart then these values will be different for each part.

campaignTrackingId

The trackingId of the campaign (if the SMS was sent using the /SMS/campaign resource).

part

The number of the current SMS part.

parts

The total number of SMS parts.

label

A generic label used for tagging the SMS.

to

The recipient of the SMS message (in E.164 format).

from

The senderId of the SMS message.

country

The country of the recipient.

operator

The operator of the recipient.

groups

All contact groups (tags) that this contact belongs to.

campaignName

The name of the SMS Campaign (if the SMS was part of a campaign).

status

The full status object of the SMS message.

status.name

The status name of the SMS message.

status.updatedDate

The date of the last status change of the SMS.

status.reason

The reason of the status.

status.reason.detailedStatus

The detailed status.
Possible values: Sent, Delivered, Undelivered, Failed, Undelivered on Handset, Unknown Number, Roaming, Call Barred, Unknown Status, Carrier Violation, Expired.

status.reason.description

The description of the detailed status.

message

The message that was sent.

applicationName

The name of the application that was used to send this message.

latency

The overall delivery latency of the message.

price

The cost of the SMS.

direction

The direction of the SMS.

originatingService

The service that sent this message.

See details about SMS callbacks here Callbaks (WebHooks)