2.4 Funkcia check_message

Funkcia slúži na overenie stavu správy. Príkaz:

https://api.smsgate.sk/xml/check_message?data=<XML>

XML s použitím tokenu:

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <token>xxxxx</token>
    <message_id>xxxxx</message_id>
</request>

XML s použitím session ID:

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <session_id>xxxxx</session_id>
    <message_id>xxxxx</message_id>
</request>

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:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <result>
        <status>success</status>
        <description></description>
        <code>OK</code>
    </result>
    <message>
        <status>Doručená</status>
        <code>DELIVERED</code>
        <deliveryDateTime>2017-01-01 10:45:00</deliveryDateTime> /** Tvar timestamp alebo prázdny reťazec v prípade, že správa nebola ešte doručená */
    </message>
</response>
                                

V prípade chyby (príklad s konkrétnou chybou):

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <result>
	<status>error</status>
	<description>Relácia nebola nájdená alebo expirovala</description>
	<code>SESSION_NOT_FOUND</code>
    </result>
</response>
                                

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.