SMS HTTP API

Request format

GET request to HTTP port:

http://1.1.1.1:8001/api?username=<username>&password=<password>&ani=<ani>&dnis=<dnis>&message=<message>$command=submit&serviceType=<serviceType>&longMessageMode=<longMessageMode>

GET request to HTTPs port:

https://domainname:8002/api?username=<username>&password=<password>&ani=<ani>&dnis=<dnis>&message=<message>$command=submit&serviceType=<serviceType>&longMessageMode=<longMessageMode>

POST request (credentials are part of the link) to HTTP port:

curl -H 'Content-Type: application/json' -X POST -d '{"ani":"dnis":"date":"message":"test"}' 'http://1.1.1.1:8001/api?command=submit&username=username&password=password

POST request (credentials are a part of the JSON body) to HTTP port:

curl -H 'Content-Type: application/json' -X POST -d '{"username":"username","password":"password","command":"submit","ani":"ani","dnis":"dnis","date":"message":"test"}' 'http://1.1.1.1:8001/api?'

NOTE: To send multiple SMS messages, add several comma-separated DNIS to the <dnis> field.

Response format

In case of successful processing, the status in the header of the HTTP response is 200 OK. Response body contains the message_id.

Sample of a response in JSON format:

HTTP/1.1 200 OK
Content-Type: application/json
{"message_id":"alss-a1b2c3d4-e5f67890"}

In case
1) the request contains more than one DNIS (comma-separated);
2) the longMessageMode=split/split_sar and the message is longer than 160/70 symbols (GSM/ Unicode respectively), the response will look as follows:

HTTP/1.1 200 OK
Content-Type: application/json
[{"dnis":"34511121","message_id":"5b4c46a8-8dc9-44b4-f55f-3bef56819305", "segment_num":"1"},{"dnis":"34511121", "message_id":"5b4c46a8-46bc-7ee6-4a16-7d4e5a0d14af","segment_num":"2"}]

In case of rejected SMS (for example, no compatible routes found), the HTTP response status is 400 Bad Request. The response body contains a string describing the reason for rejection, for example NO ROUTES.

HTTP/1.1 400 Bad Request
Content-Type: text/html; charset=UTF-8
NO ROUTES

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)

If the service_type field exceeds 6 bytes, the response will look as follows:

HTTP/1.1 400 Bad request\n
Content-Type: text/html; charset=UTF-8\n
Service type is invalid\n

If a message is considered a loop in accordance with the Loop Detection functionality, the response will be as follows:

HTTP/1.1 508 Loop Detected
Content-Type: text/html; charset=UTF-8
loop detected

SMS status request

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

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:

Response sample:

HTTP/1.1 200 OK
Content-Type: application/json
{"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 YYMMDDHHMMSS, 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: application/json
{"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)

Allowed marker names for outgoing HTTP callbacks

This section contains allowed marker names for outgoing HTTP callbacks (sending of delivery report with the help of cURL in a generated script).

It is possible to specify the _noencode suffix for markers. This allows, for example, transmitting text without URL encoding to the client. Example:

curl 'http://1.1.1.1/api/callback/api?msg-id=$message_id$&state=$delivery_status$&reason-code=$result_code$&to=$dnis$&time=$done_date_noencode$&msg-id=$messageId$&mcc=$mcc$&mnc=$mnc$

Deliver

Last updated: 12 Sep 2025