Delivery Status
This API is used by Sprint to send delivery status to the client.
After you send message, you will receive a delivery status that will be sent with the following parameters. Before that, the client must create an endpoint that can be accessed by Sprint to send a delivery status
Request
Request on channels SMS, Email, Line, Telegram, Facebook
This section describes the request parameters and provides JSON request examples that will be sent by Sprint to your endpoint to provide the message delivery status.
Description Parameter Request
| FIELD | TYPE ALLOWED | DESCRIPTION |
|---|---|---|
| status | Integer | 1 : Delivered 2 : Undelivered 3 : Pending 4 : Unsent Sprint 5 : Failed 6 : Unknown 7 : Opened 8 : Clicked 9 : Read 10 : Spam 11 : Bounced 12 : Blacklist 13 : Ringing Not Answered (RNA) 14 : Delivery Backup Not Used 15 : Unsent From Opt 16 : Sent From Opt |
| channel | Integer | 1 : SMS 2 : Line 3 : Email 4 : Facebook 5 : Telegram 7 : WhatsApp |
| ref_id | AN (Alpha Numeric) ( ≤50) | Unique Id |
| time | Date time | Delivery time. |
| division_id | AN (Alpha Numeric) | Unique id from division |
Sample JSON Request on channels SMS, Email, Line, Telegram, Facebook
{
"status": 1,
"channel": "1",
"ref_id": "sample-refid-0djr8-0001",
"time": "2024-01-01 10:00:00",
"division_id": "ccacbcc8-xxx-xxxx-xxx-68832955c"
}
Request on WhatsApp channel
This section describes the request parameters and provides JSON request examples that will be sent by Sprint if you send a message using the WhatsApp channels.
Description Parameter Request
| FIELD | TYPE ALLOWED | DESCRIPTION |
|---|---|---|
| status | Integer | 1 : Delivered 2 : Undelivered 3 : Pending 4 : Unsent Sprint 5 : Failed 6 : Unknown 7 : Opened 8 : Clicked 9 : Read 10 : Spam 11 : Bounced 12 : Blacklist 13 : Ringing Not Answered (RNA) 14 : Delivery Backup Not Used 15 : Unsent From Opt 16 : Sent From Opt |
| channel | Integer | 1 : SMS 2 : Line 3 : Email 4 : Facebook 5 : Telegram 7 : WhatsApp |
| ref_id | AN (Alpha Numeric) ( ≤50) | Unique Id |
| time | Date time | Delivery time. |
| division_id | AN (Alpha Numeric) | Unique id from division |
| price | AN (20) | PAID: berbayar FREE: tidak berbayar ON PROCESS: sedang process Note: parameter “Price” only applies for channel “WhatsApp” |
Sample JSON Request on WhatsApp channel
{
"status": 1,
"channel": "7",
"ref_id": "732cbaf1-e6a6-40b5-839c-6be4d442ba60",
"time": "2024-06-05 16:27:02",
"division_id": "ccacbcc8-xxx-xxxx-xxx-68832955c",
"price": "FREE"
}
Request on channels SMS Include counter_message (Optional)
This section describes the request parameters and provides JSON request examples that will be sent by Sprint if you send a message using the SMS channels with Include counter message.
Description Parameter Request
| FIELD | TYPE ALLOWED | DESCRIPTION |
|---|---|---|
| status | Integer | 1 : Delivered 2 : Undelivered 3 : Pending 4 : Unsent Sprint 5 : Failed 6 : Unknown 7 : Opened 8 : Clicked 9 : Read 10 : Spam 11 : Bounced 12 : Blacklist 13 : Ringing Not Answered (RNA) 14 : Delivery Backup Not Used 15 : Unsent From Opt 16 : Sent From Opt |
| channel | Integer | 1 : SMS 2 : Line 3 : Email 4 : Facebook 5 : Telegram 7 : WhatsApp |
| ref_id | AN (Alpha Numeric)(≤50) | Unique Id |
| time | Date time | Delivery time. |
| division_id | AN (Alpha Numeric) | Unique id from division |
| counter_message | Integer | Total messages per SMS Note: parameter “counter_message” only applies for channel “SMS” |
Sample JSON Request on channels SMS Include counter_message (Optional)
{
"status": 1,
"channel": "1",
"ref_id": "TestQA-s79dDRmV35ko-190999701919",
"time": "2024-10-12 01:45:11",
"division_id": "ccacbcc8-xxx-xxxx-xxx-68832955c",
"counter_message": 1
}
Request on WhatsApp channel use format Pass Thru (Optional)
This section describes the request parameters and provides JSON request examples that will be sent by Sprint directly from the provider (WhatsApp) without being processed by Sprint, if you send a message using the WhatsApp channel.
Description Parameter Request
| FIELD | TYPE ALLOWED | DESCRIPTION |
|---|---|---|
| messaging_product | String | Product used to send the message. Value is always WhatsApp |
| metadata | JSON Object | Details information from metadata |
| display_phone_number | String | Displayed phone number |
| phone_number_id | String | unique id from phone number |
| statuses | Array | Details information from statuses |
| conversation | JSON Object | Details information from conversation |
| id | String | The ID for the message that the business that is subscribed to the webhooks sent to a customer |
| origin | JSON Object | Details information from origin |
| type | JSON Object | Type from conversation: marketing, utility, service, authentication |
| id | String | Uniq id from conversation |
| pricing | JSON Object | Details information from pricing |
| billable | true | Indicates if the given message or conversation is billable. Default is true for all conversations |
| category | String | category – Indicates the conversation category: marketing, utility, service, authentication |
| pricing_model | String | pricing_model – Type of pricing model used by the business. Current supported value is CBP |
| recipient_id | String | The customer's WhatsApp ID |
| reff_id | AN (Alpha Numeric) ( ≤50 ) | Unique Id |
| status | String | status delivery message: Delivered, read, sent |
| timestamp | Unix timestamp | Date for the status message |
Sample JSON Request on WhatsApp channel use format Pass Thru (Optional)
{
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "6287xxxxxxxx1",
"phone_number_id": "101471619726642"
},
"statuses": [
{
"conversation": {
"id": "a4f11a5343b44xxxxxa86911b8f",
"origin": {
"type": "marketing"
}
},
"id": "wamid.HBgNNjI4OTDIxNxQkRGMERGOAA=",
"pricing": {
"billable": true,
"category": "marketing",
"pricing_model": "CBP"
},
"recipient_id": "62896217",
"reff_id": "",
"status": "delivered",
"timestamp": "1717579622"
}
]
}
Response
This section explains the response codes used and include JSON response examples returned by the Sandeza platform after a message is sent.