1. Home
  2. Docs
  3. SMS API popis
  4. 1. JSON
  5. 1.4 Funkcia check_message

1.4 Funkcia check_message

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
ParameterTypPopis
token || session_idstringAPI token alebo session_id vrátené pomocou metódy auth. (Povinné)
message_idstringID 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“

codestatusPopis
UNSENTNeodoslanáNeodoslaná – Správa ešte nebola spracovaná.
SCHEDULEDPlánovanáPlánovaná – Správa je načasovaná na neskoršie odoslanie.
QUEUEDVo fronteSpráva bola prijatá a čaká na odoslanie.
SENDINGOdosiela saSpráva sa aktuálne odosiela.
SENTOdoslanáSpráva bola odoslaná do SMS centra.
DELIVEREDDoručenáSpráva bola doručená adresátovi.
EXPIREDExpirovanáČasový limit na doručenie správy vypršal.
DELETEDZmazanáSpráva bola odstránená z doručovacej fronty.
UNDELIVERABLENedoručiteľnáSprávu nie je možné doručiť.
DENIEDZamietnutáSpráva bola zamietnutá SMS centrom.
IN_GROUPV skupineSpráva je zaradená do kadenčnej skupiny
BLACKLISTEDBlokovanáSpráva bola zaradená na blacklist a zablokovaná
ERRORChybaSprá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.
UNKNOWNNeznámySpráva bola odoslaná, ale nie je možné zistiť stav doručenia.