This event is fired every time we receive a confirmation of delivery from a carrier, the status field indicates how the text has been delivered. To receive these events your system must have capability for processing a large number of simultaneous requests, we forward such events in real time as soon as we receive it from carriers.
The data payload format is the Message Log Object.
Note: If we never received any confirmation from carriers, we do not generate any receipts on our own.
Delivered Event:
{
"type": "DELIVERY_RECEIPT",
"ctime": 1619552282398,
"data": {
"cid": "c_k123g456c789",
"phone": "5555555555",
"name": "John Smith",
"proxy": "8443035634",
"logid": "rl_1234.....",
"flags": [],
"text": "Hey, would you like to take a short survey?",
"sent_time": "02/04/2025 02:35PM EST",
"update_time": "02/04/2025 02:36PM EST",
"action": "1",
"status": "delivered"
}
}The status can either be delivered or undelivered.
Undelivered Event:
{
"type": "DELIVERY_RECEIPT",
"ctime": 1619552282398,
"data": {
"cid": "c_k123g456c789",
"phone": "5555555555",
"name": "John Smith",
"proxy": "8443035634",
"logid": "rl_1234.....",
"flags": [],
"text": "Hey, would you like to take a short survey?",
"sent_time": "02/04/2025 02:35PM EST",
"update_time": "02/04/2025 02:36PM EST",
"action": "1",
"status": "undelivered",
"error_code": "landline",
"error_text": "Undelivered destination",
"status_code": "12345"
}
}