Zpracování doručenky pro jednotlivé zprávy
Intro
Doručenky jsou způsob, jak zjistit, zda zpráva byla doručena příjemci.
Pokud odesíláte hromadné zprávy na endpoint /messages, tak je nutné postupovat podle dokumentace pro zpracování doručenek při hromadném odesílání zpráv.
Pokud odesíláte jednotlivé zprávy na endpoint /message, tak je nutné postupovat podle této dokumentace.
Příklad požadavku, který je zaslán na zadanou URL callback adresu
Na zadanou adresu je vždy odesíláno pole JSON objektů. V jednom HTTP požadavku je možné obdržet až 100 JSON objektů. V případě, že odpověď není HTTP 200 OK (nebo pokud server neodpoví do 5 sekund), bude doručení callbacku opakováno.
[{
"request_id": "db013db1-d1e7-47e6-92d1-0f894a6ba9d5",
"message_id": "bbc1d463-8a68-4215-89ea-643344fb7ee1",
"gateway": "sms",
"type": "outgoing",
"to": {
"phone_number": "420777777771",
"message_id": "bbc1d463-8a68-4215-89ea-643344fb7ee1"
},
"status": "delivered"
}]
| Parametr | Popis | Povinný |
|---|---|---|
request_id | ID požadavku | Ano |
message_id | ID zprávy | Ano |
gateway | Kanál, přes který byla zpráva odeslána (sms, viber, email, whatsapp, push) | Ano |
type | Typ notifikace (outgoing, incoming) | Ano |
to | Příjemce zprávy | Ano |
status | Status zprávy (delivered, failed, expired, rejected, sending, sent, undelivered) | Ano |
status_info | Bližší informace o doručení nebo nedoručení zprávy (obvykle tento parametr není uveden. Používá se většinou pro vysvětlení odmítnutí zprávy ve stavu rejected) | Ne |
Stav zprávy sending
Stav sending je speciální stav, který nastává pouze u zpráv odeslaných přes Viber nebo WhatsApp. V tomto stavu byla zpráva zadání k odeslání (na API Viber nebo WhatsApp), ale dosud nebylo potvrzeno, zda skutečně došlo k odeslání (např. pokud příjemce aplikaci Viber nebo WhatsApp smazal, nebo ji nikdy neaktivoval).
Z tohoto stavu zároveň zpráva není nikdy označena jako sent, ale vždy jako již dále pouze jako delivered (doručena) nebo undelivered (zpráva nebyla a nebude nedoručena).
Tento stav se u SMS nepoužívá, protože operátor vždy přijme požadavek na odeslání zprávy i když telefonní číslo neexistuje nebo není aktivní. Proto u SMS nikdy nedostanete stav sending, ale vždy rovnou sent. Dále z tohoto stavu může být zpráva označena jako delivered (doručena) nebo undelivered (nebyla doručena).