English | Slovak

deliveryXML

Description
Status of sent message
Functionality
All requests are sent to URL listed below. Message body format have to be kept for succesful identification of delivery report.
The delivery information is sent in the body. In case of error, the error HTTP response is returned back with the error description.
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) user name
password
required Varchar (16) password
Delivery - non billing SMS
id
optional varchar (14) unique message ID
Parameter Type Description
id
varchar (14) unique message ID
received timestamp date of delivery report from mobile operator or date of last check in case of waiting
status varchar (50) delivered - message delivered, undeliverable - message is undelivered, waiting - unknown status, expired - message was expired, rejected - message was rejected by operator
Error response
EN
Error ID Description Detail
400 missing parameter mandatory parameter is missing
401 unknown username/password wrong username or password
500 unknown error unknown error, detailed description is in response
Revision
Version Date Description
6.0 16.7.2014 added suport to billed msg
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 first version