The links below are intended for request of delivery reports over HTTP from the client side.

Request format:

http://1.1.1.1:8001/api?username=<username>&password=<password>&messageId=<messageId>&command=query

https://1.1.1.1:8002/api?username=<username>&password=<password>&messageId=<messageId>&command=query

Parameters:

username:

Login

password:

Password

messageId:

Message identifier received with the submission response

command:

Request type. Must be set to “query” value

All parameters are obligatory.

Response format:

In case of successful processing, the status in the header of the HTTP response is 200 OK. The response body contains the one of the following possible values:

ENROUTE:

Message is in routing stage. The status can be returned to the client if the message is in the SENT status

DELIVRD:

Message is delivered to the Subscriber

EXPIRED:

Message storage period expired

DELETED:

Message was deleted

UNDELIV:

Message cannot be delivered

ACCEPTD:

Message is accepted by SMSC

UNKNOWN:

Unknown message status. Information on statuses is stored in the in-memory database for 24 hours (by default). Therefore, this status may be returned if the client has requested a status quite late and it was already removed from the memory.

REJECTD:

Message was rejected by SMSc. The status can also be returned for internal failed statuses, for example, for the NO ROUTES status.

IM_EXPD

Delivery report was not received from the IM provider within the im_ttl timeout

Response sample:

HTTP/1.1 200 OK

Content-Type: text/html; charset=UTF-8

 

{"status": "DELIVRD", "delivery_time": "20210922093309", "mccmnc": "214099", "error_code": "000", "system_delivery_time": "210922093309"}

where delivery_time is the done date received from the vendor (if not received the field will be empty); mccmnc is the E212 code; error_code is the delivery error code; system_delivery_time is the delivery report receipt time by the System (in the format YYMMDDHH24MISS, for example, 210325153842).

The status can be requested within 24 hours after the message submission.

In case the message with the requested message ID is not found the response HTTP status is 200 OK. The response body contains the error description in the “status” field:

HTTP/1.1 200 OK

Content-Type: text/html; charset=UTF-8

 

{"status": "UNKNOWN", "delivery_time": "", "mccmnc": ""}

In case an incorrect user name or password is provided, the HTTP status is 401 Unauthorized. The response body contains the string describing the reason for rejection.

HTTP/1.1 401 Unauthorized

Content-Type: text/html; charset=UTF-8

 

not authorized (check login and password)