deliveryXML

Popis

Zistenie stavu doručenia SMS.

Funkčnosť

Všetky requesty sa zasielajú na URL uvedené nižšie. Formát tela správy je nutné dodržať pre úspešné zistenie delivery reportu.
V body sa vracia informácia o doručení. V prípade chyby je vrátený chybový HTTP response s popisom chyby.

Request

POST http://text421.naimar.sk/api/v6/rest/delivery/xml/

Request body - only non billed SMS

<deliveries>
    <username>test</username>
    <password>test</password>
    <delivery>
        <id>0qwedf5e8e8r7w</id>
        <id>abcdefghijklab</id>
    </delivery>
</deliveries>

Response

<response>
    <delivery>
        <id>abcdefghijklab</id>
        <received>2012-09-05 22:59:00</received>
        <status>delivered</status>
    </delivery>
    <delivery>
        <id>0qwedf5e8e8r7w</id>
        <received>2012-09-05 22:59:00</received>
        <status>waiting</status>
    </delivery>
</response>

Request body - only billed SMS

<deliveries>
    <username>test</username>
    <password>test</password>
    <billing>
        <id>25481979</id>
        <id>25481980</id>
    </billing>
</deliveries>

Response

<response>
    <billing>
        <id>25481979</id>
        <received>2012-09-05 22:59:00</received>
        <status>delivered</status>
    </billing>
    <billing>
        <id>25481980</id>
        <received>2012-09-05 22:59:00</received>
        <status>undeliverable</status>
    </billing>
</response>

Request body - non billed and billed SMS

<deliveries>
    <username>test</username>
    <password>test</password>
    <delivery>
        <id>0qwedf5e8e8r7w</id>
        <id>abcdefghijklab</id>
    </delivery>
    <billing>
        <id>25481979</id>
    </billing>
</deliveries>

Response

<response>
    <delivery>
        <id>abcdefghijklab</id>
        <received>2012-09-05 22:59:00</received>
        <status>delivered</status>
    </delivery>
    <delivery>
        <id>0qwedf5e8e8r7w</id>
        <received>2012-09-05 22:59:00</received>
        <status>waiting</status>
    </delivery>
    <billing>
        <id>25481979</id>
        <received>2012-09-05 22:59:00</received>
        <status>delivered</status>
    </billing>
</response>

Parameter	Required	Type	Description
username	required	Varchar (16)	prihlasovacie meno užívateľa
password	required	Varchar (16)	heslo užívateľa
Delivery - non billing SMS
id	optional	varchar (14)	unikátne ID zaslanej SMS

Parameter	Typ	Popis
id	varchar (14)	unikátne ID zaslanej SMS
received	timestamp	dátum prijatia delivery reportu od operátora alebo v prípade waiting dátum poslednej kontroly
status	varchar (50)	delivered - správa doručená, undeliverable - správa nedoručená, waiting - neznámy stav, expired - správa bol nedoručená, rejected - správa bola odmietnutá mobilným operátorom

Error response

Chybové návratové hodnoty

ID chyby	Description	Vysvetlenie
400	missing parameter	chýba povinný parameter
401	unknown username/password	nesprávne meno alebo heslo
500	unknown error	neznáma chyba, bližší popis je zaslaný v response

Revízia

Verzia	Dátum	Popis
6.0	16.7.2014	doplnená podpora pre spoplatnené SMS
1.2	28.4.2013	pridané nové status kódy (rejected, expired), ošetrené nesprávne statusy od operátora
1.1	30.10.2012	opravená drobná chyba v implementácii XML, zmena XML formátovania pri Response a Error response
1.0	24.8.2012	prvá verzia