Use this method to retrieve the message status for an individual message. See Getting Message Statuses for more info.
The status response will contain the messages overall status in the status property and further details in the statusDetails property. Within the statusDetails you will find the channelStatus property which will contain details of all channels that were attempted to be used with this message, for instance if using Branch routing and it tried Facebook prior to successfully delivering via SMS then a fbMessenger and sms object would be present in the channelStatus property. A example of the data retrieved can be found below:
{
"_createdOn": "2017-09-12T08:40:12.035Z",
"_updatedOn": "2017-09-12T08:40:13.579Z",
"_createdBy": "access:91c59b6a-5ff9-4a97-84a7-1b1ca4a0fe82",
"_updatedBy": "access:91c59b6a-5ff9-4a97-84a7-1b1ca4a0fe82",
"to": {
"phoneNumber": "447234123123"
},
"senderProfileId": "Acme",
"body": "Your order is ready for pickup.",
"rules": [
"sms"
],
"channelOptions": {
"sms": {
"from": "Comapi",
"allowUnicode": true
}
},
"metadata": {
"data": "My correlation data"
},
"submittedOn": "2017-09-12T08:40:12.020Z",
"messageParts": [],
"status": "sent",
"statusDetails": {
"channel": "sms",
"additionalInfo": {
"to": "447234123123",
"successful": true,
"clientRef": "287d32c0-170e-4a80-bfc3-48f376d17682"
},
"channelStatus": {
"sms": {
"status": "sent",
"details": {
"to": "447234123123",
"successful": true,
"clientRef": "287d32c0-170e-4a80-bfc3-48f376d17682"
},
"updatedOn": "2017-09-12T08:40:13.705Z"
}
}
},
"sentOn": "2017-09-12T08:40:12.035Z",
"messageId": "287d32c0-170e-4a80-bfc3-48f376d17682"
}