username:

Login

Yes

used when command = “submit”, “query” or “mo”

password:

Password

Yes

used when command = “submit”, “query” or “mo”

ani:

Caller ID. Technical limitation – alpha-numeric up to 32 symbols. Additional limitations can be caused by destination route peculiarities 

Yes

used when command = “submit” or “mo”

dnis:

Destination number. Must be sent in international E.164 format (up to 15 digits allowed)

Yes

used when command = “submit” or “mo”

message:

Message text.

Yes

used when command = “submit” or “mo”

messageId:

Message ID

No

used when command = “query”

command:

Request type. Possible values: “submit”, “query”, “mo”

Yes

serviceType:

Service type, provided by the system owner for the registered interconnection. Can be blank.

No

used when command = “submit” or “mo”

longMessageMode:

Type of long message processing. The following values allowed:

cut (trim message text to 140 bytes) – shortens the message leaving only first 140 bytes to be sent.

split and split_sar – split the message according to the logics described below. The difference between them is in the header to be used, for split it is UDH header, for split_sar it is sar accordingly.

single_id_split – split the message but return the message ID common for all segments

payload – message_payload field is used for sending the message text

The splitting (options 2/3) depends on the coding:

– dataCoding = 0, 1 or 3: one message can contain up to 160 bytes, if more – segment count = message length / 153

– dataCoding 2, 4 – 8: one message can contain up to 140 bytes, if more – segment count = message length / 134 bytes

No

used when command = “submit” or “mo”

the default value is “сut”

incMsgId (inc_msg_id)

The client message ID (64 symbols maximum) that can be used for incoming HTTP requests with longMessageMode=cut or no longMessageMode (which equals to longMessageMode=cut). When the SMS switch receives this parameter it will use its value as a client ID. This will allow clients to use their ID to request information on the message if, for example, no routes are available. 

No

used when longMessageMode=cut or no longMessageMode is indicated (which equals to longMessageMode=cut)

srcTon, srcNpi, dstTon, dstNpi

the respective parameters for Sender ID and Destination number. Format: integer. Optional 

No

used when command = “submit”

dataCoding

data coding scheme for sending the SMPP to the client. Format: integer. Optional. Allowed values are: 0, 1, 3, 6, 7, 8, 10, 14, where: 

0: SMSC Default Alphabet (SMPP 3.4)/MC Specific (SMPP 5.0)

1: IA5 (CCITT T.50)/ASCII (ANSI X3.4)

3: Latin 1 (ISO-8859-1)

6: Cyrillic (ISO-8859-5)

7: Latin/Hebrew (ISO-8859-8)

8: UCS2 (ISO/IEC-10646)

10: ISO-2022-JP (Music Codes)

14: KS C 5601

No

used when command = “submit”

esmClass

corresponds to the same name parameter in SMPP. Format: integer. Optional. Allowed values are: 0-255

No

used when command = “submit”

priorityFlag

corresponds to the same name parameter in SMPP. Format: integer. Optional. Allowed values are: 0 and 1

No

used when command = “submit”

registeredDelivery

corresponds to the same name parameter in SMPP. Format: integer. Optional. Allowed values are: 0 and 1

No

used when command = “submit”

replaceIfPresentFlag

corresponds to the same name parameter in SMPP. Format: integer. Optional. Allowed values are: 0 and 1

No

used when command = “submit”

silent

Flag that allows sending silent SMS (message that arrives with no sound and is not displayed on the screen)

Allowed values are: 0 and 1, where 0 means NOT silent. Any value other than 1 is treated as true, for example, silent=false is interpreted as silent=1. 

No

Whether the silent SMS arrives as a silent one to the end user depends on the vendor and the other carriers that handle it

HTTP/1.1 200 OK

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

{“message_id”:”alss-a1b2c3d4-e5f67890″}

HTTP/1.1 200 OK

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

[{“dnis”:”791003044222″,”message_id”:”5b4c46a8-8dc9-44b4-f55f-3bef56819305″,

“segment_num”:”1″},{“dnis”:”791003044222″,

“message_id”:”5b4c46a8-46bc-7ee6-4a16-7d4e5a0d14af”,”segment_num”:”2″}]

HTTP/1.1 400  Bad Request

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

NO ROUTES

HTTP/1.1 401 Unauthorized

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

not authorized (check login and password)