To receive delivery reports directly to your application, you can register a callback url in your Dashboard. We then update the delivery status information using POST requests made to that page.
Here is how it works:
- When you send us a message, we usually send you back a messageId field which uniquely
identifies every message that was sent out.
- When we subsequently receive a delivery report for that message, we can call the URL that you
specify above with the id , status and failureReason values for that message.
- failureReason is only provided where status is Rejected or Failed.
Please note: not all telcos support this feature.
The possible values for the status of your message are:
|Sent||The message has successfully been sent by our network.|
|Submitted||The message has successfully been submitted to the MSP (Mobile Service Provider).|
|Buffered||The message has been queued by the MSP.|
|Rejected||The message has been rejected by the MSP. This is a final status.|
|Success||The message has successfully been delivered to the receiver's handset. This is a final status.|
|Failed||The message could not be delivered to the receiver's handset. This is a final status.|
The possible values for failureReason are:
|InsufficientCredit||This occurs when the subscriber don't have enough airtime for a premium subscription service/message|
|InvalidLinkId||This occurs when a message is sent with an invalid linkId for an onDemand service|
|UserIsInactive||This occurs when the subscriber is inactive or the account deactivated by the MSP (Mobile Service Provider).|
|UserInBlackList||This would occur if the user has been blacklisted not to receive messages from a paricular service (shortcode or keyword)|
|UserAccountSuspended||This would occur when the mobile subscriber has been suspended by the MSP.|
|NotNetworkSubcriber||This occurs when the message is passed to an MSP where the subscriber doesn't belong.|
|UserNotSubscribedToProduct||This is for a subscription product which the subscriber has not subscribed to.|
|UserDoesNotExist||This occurs when the message is sent to a non-existent mobile number.|
|DeliveryFailure||This occurs when message delivery fails for any reason not listed above or where the MSP didn't provide a delivery failure reason.|