Message Status Callbacks
The recommended way to keep track of the status of your outbound messages is to setup a server endpoint to receive status update events in real time.
Once you’ve configured this endpoint, specify its url and HTTP method in the Send Message API request. Plivo will call this endpoint with the latest message details as and when the message status changes.
Attributes
The following message attributes are passed on to the status update url with every status change event.
These attributes are passed as Form Data if the method configured is POST, and as Query Params if it is GET.
| MessageUUID |
The unique ID for the message. |
| To |
Phone number of the recipient. |
| From |
The sender ID used as the source address for the message. |
| Type |
The type of message - “sms” or “mms”. |
| Status |
Status of the message including "queued", "sent", "failed", "delivered", "undelivered" or "rejected". |
| Units |
Number of units into which a long SMS was split |
| TotalRate |
This is the charge applicable per outbound SMS unit. |
| TotalAmount |
Total charge for sending the SMS (TotalRate * No. of Units) |
| MCC |
Mobile Country Code of the To number. (See here for more details) |
| MNC |
Mobile Network Code of the To number. (See here for more details) |
| ErrorCode |
The Plivo error code which identifies the reason for the message delivery failure. This parameter is only defined for 'failed' or 'undelivered' messages. |
| ParentMessageUUIDreserved for future use |
Same as the MessageUUID. This parameter is reserved for future use, and should be ignored for now. |
| PartInforeserved for future use |
This parameter is reserved for future use, and should be ignored for now. |
| Sequence |
Use this attribute to track the sequence in which callbacks for this SMS were generated by the Plivo system. |
| MessageTime |
The timestamp at which the SMS was initiated. Format: YYYY-mm-dd HH:MM:SS.SSSSSS |
| QueuedTime |
The timestamp at which the SMS was queued. Format: YYYY-mm-dd HH:MM:SS.SSSSSS |
| SentTime |
The timestamp at which the SMS was submitted to the downstream carrier for delivery. Format: YYYY-mm-dd HH:MM:SS.SSSSSS |
| DeliveryReportTime |
The timestamp at which the delivery report for this SMS was received from the downstream carrier. Format: YYYY-mm-dd HH:MM:SS.SSSSSS |
| PowerpackUUID |
The SMS Powerpack UUID used for the message. This will be empty if a Powerpack was not used. |