Sending mobile terminated SMS messages

Delivers Mobile Terminated (MT) SMS messages to an AnyNet or third party SIM when the following conditions are met:

  • The authenticated user has access rights to send an SMS
  • If an optional IP address Allowlist exists, the source device is listed on it
  • The SIM is not barred from receiving SMS messages

    Enabling or disabling SMS Messages is linked to the SIM package, which is outside the scope of the SMS API.

MT SMS pathway

The following diagram displays the main pathways used by mobile terminated SMS, with the codes for the pathway in square brackets. The SMS API serves the message to the AnyNet Messaging Service, which then distributes the message to the correct SIM.

Authentication

  • SMS API credentials

Request application/x-www-form-urlencoded

Schema

Parameters Description Required?

username

The Eseye-assigned SMS API username
password The Eseye-assigned SMS API password
destination The destination Mobile Station International ISDN Number (MSISDN).
text

The SMS message content. For 7-bit mode, SMS API only supports characters from the ETSI USSD default alphabet, as defined in GSM 03.38.

Uses mode to validate how the data is transported.

If both text and short_message are defined, then text is given priority.

Use data_coding and short_message for 16-bit Unicode messages.

For a quick reference on non-alphanumeric ASCII characters, see Coding non-alphanumeric ASCII characters.

(or short_message)
short_message

The hex-encoded short message octets (user data).

Uses data_coding to validate how the data is transported.

If both text and short_message are defined, then text is given priority.

Use data_coding and short_message for 16-bit Unicode messages.

Encode 16-bit ASCII characters using the Unicode equivalent. For example, where A is 65 (8-bit Hex), instead use 0065 (16-bit Unicode).

(or text)
message_id A user-generated unique message identifier for tracking responses.  
receipt_url The URL where the delivery receipt is sent.  
source The source MSISDN. If blank, then the AnyNet Messaging Service sends the message.  
mode

How text data is transported, either as:

Value Description Maximum length
7 7-bit encoded (default) 160 characters
8 8-bit encoded 140 bytes

If the mode value is left blank when text is specified, the default value is used.

 
expiry

The date and time that the message will expire if undelivered, in the format:

YYYY-MM-DD hh:mm:ss

 
data_coding

How the short_message data is processed. For more information, see Data Coding Scheme.

Allowed values include:

Value Character/Data set Message class Maximum length
0 GSM 7-bit, ASCII (default) Default 160 characters
4 8-bit data Default 140 bytes
8 UCS2, 16-bit Default 70 characters
F6 8-bit data Class 2 (SIM/USIM-specific) 140 bytes

If the data_coding value is left blank when short_message is specified, the default value is used.

 
pid For Eseye use only. Protocol identifier that indicates the protocol used. The default value is 0 – default store and forward short message.  
esm

For Eseye use only. User data header that indicates special message attributes associated with short_message.

40 indicates the user data header is included.

 
Replace Cancel any queued messages  

Creating 16-bit Unicode messages

You can convert text into Unicode using freely available internet tools, such as http://smstools3.kekekasvi.com/topic.php?id=288.

Example

The Chinese characters for Hello World are: 你好世界

  1. Using the SMS Server Tools 3 PDU Converter, select an Alphabet Size of 16.
  2. Type 你好世界 into the PDU SMS message creator Text box.
  3. Select Convert >.

    The USSD Entry/Display returns the Unicode for 你好世界, which is 4F60597D4E16754C.

  4. Copy and paste the Unicode into your request.

Example

Copy
HTTP POST request
http://messaging.eseye.com/mtsmsapi/index/post

Example POST parameters for this request:

  • usernameUserName
  • passwordUserPassword
  • destination447924939016
  • text (message content) – Hello World

Example POST request using 16-bit Unicode:

http://messaging.eseye.com?username=UserName&password=UserPassword&destination=447924939016&message_id=20220302155049&data_coding=8&short_message=4F60597D4E16754C

Response text/html

Simple text, either:

Example

OK!