Once we receive a delivery report from the MNO, we will update the status of the message and push the same to your callback URL.
To configure a callback URL, click on your user icon on the top-right corner, followed by "My Client Account".
Once on the details page, click on the "API" tab and scroll to the "Callback URL" section.
A POST request will be made to the URL that you set.
The following JSON payload will be sent to your callback URL immediately we receive a delivery report from the MNO.
{
"description": "DeliveredToTerminal",
"messageid": "ISS9hUcsMuaB5Ex2",
"timeTaken": "9s",
"timestamp": "2021-12-02 09:11:50"
}
The following delivery descriptions will be sent via the webhook.
These are invalid (do not exist) or inactive Safaricom numbers. The status is sent back from the MNO 18 to 24 hours after a message has been sent.
These are messages that have been delivered to the specified phone numbers. These are Safaricom, Airtel and Telkom numbers. The status is sent back from the MNO immediately the message is delivered.
These are similar to AbsentSubscribers but specific to numbers that are inactive or blocked. The status is sent back from the MNO in seconds or minutes.
These are Safaricom numbers that have blacklisted a sender ID, or blocked all promotional messages.
These are numbers that are either in a poor network coverage area, or turned off. Also, messages might have been delivered but the Mobile Network Operator failed to send back a delivery report.
These are Airtel and Telkom numbers that are either unreachable, inactive or invalid. Airtel and Telkom have a blanket response of "Unknown" for such numbers.