Funkcia slúži na overenie stavu správy. Príkaz s použitím tokenu:
https://api.smsgate.sk/json/check_message?token=XXXXXXX&message_id=xxxxx
Príkaz s použitím session ID:
https://api.smsgate.sk/json/check_message?session_id=XXXXXXXX&message_id=xxxxx
Parameter | Typ | Popis |
---|---|---|
token || session_id | string | API token alebo session_id vrátené pomocou metódy auth. (Povinné) |
message_id | string | ID SMS správy vygenerovanej funkciou send_sms(Povinné) |
Odpoveď
V prípade, že overenie prebehlo úspešne:
{
"result": {
"status": "success",
"description": "",
"code": "OK"
},
"message_id": "154786",
"status": "Doručená",
"code": "DELIVERED",
"deliveryDateTime": "2017-01-01 10:45:00" // Tvar timestamp alebo prázdny reťazec v prípade, že správa nebola ešte doručená
}
V prípade chyby (príklad s konkrétnou chybou):
{
"result": {
"status": "error",
"description": "Relácia nebola nájdená alebo expirovala",
"code": "SESSION_NOT_FOUND"
}
}
Stavy parametrov „code“ a „status“
code | status | Popis |
---|---|---|
UNSENT | Neodoslaná | Neodoslaná – Správa ešte nebola spracovaná. |
SCHEDULED | Plánovaná | Plánovaná – Správa je načasovaná na neskoršie odoslanie. |
QUEUED | Vo fronte | Správa bola prijatá a čaká na odoslanie. |
SENDING | Odosiela sa | Správa sa aktuálne odosiela. |
SENT | Odoslaná | Správa bola odoslaná do SMS centra. |
DELIVERED | Doručená | Správa bola doručená adresátovi. |
EXPIRED | Expirovaná | Časový limit na doručenie správy vypršal. |
DELETED | Zmazaná | Správa bola odstránená z doručovacej fronty. |
UNDELIVERABLE | Nedoručiteľná | Správu nie je možné doručiť. |
DENIED | Zamietnutá | Správa bola zamietnutá SMS centrom. |
IN_GROUP | V skupine | Správa je zaradená do kadenčnej skupiny |
BLACKLISTED | Blokovaná | Správa bola zaradená na blacklist a zablokovaná |
ERROR | Chyba | Správu nie je možné odoslať z dôvodu chyby. Systém sa pokúsi opätovne správu doručiť ešte 5 krát v priebehu 60 minút. |
UNKNOWN | Neznámy | Správa bola odoslaná, ale nie je možné zistiť stav doručenia. |