|
|
HTTP Interface Configuration for Mobile Terminated SMS
Last updated: January 3, 2008
This section is applicable to the lab application and to a test application with the required feature license.
If you wish to use the HTTP interface in the test set to route SMS messages to the mobile station attached to the test set, you must do the following:
-
Enable the Test Set's HTTP Interface
-
Specify the SMSC IP Address and Port
-
Configure the Request URL
You also can determine the state of the last MT SMS message by sending an HTTP request. See
State Determination for Sent Messages
for details.
Specify the SMSC IP Address and Port
You can send SMS messages from several different types of clients to the test set such as SMS Gateway, another test set and internet browser. It is necessary to specify the IP Address and port number as follows:
-
IP Address/Host Name: The IP address of the test set receiving the messages. (See
Configuring the Test Set's LAN
for more information.)
-
Port number: 80.
When configuring an SMS Gateway, these parameters apply to the SMSC configuration. In a test system with more than one test set, each test set may be thought of as a separate SMSC and configured as such in the gateway.
Configure the Request URL
When using the HTTP interface in the test set for sending SMS messages you must configure a request URL. The accepted format of the request URL is:
-
"/sms/send/?" must be specified at the beginning of the request URL in order for the test set to recognize the HTTP request as a request to send an SMS message.
-
The parameters and values provide the content of the SMS message as well as other information. All configurations for parameters and values are detailed in
Request URL Parameters
.
-
TEXT and DATA are mandatory parameters which must be included in the request URL. If any mandatory parameters are not present, "HTTP SMS request ignored; Missing mandatory parameter in request" will be generated on the test set.
|
SMS Message Content Type |
Mandatory Parameters |
|
7-bit text |
TEXT |
|
8 or 16 bit data |
DATA |
-
-
With the exception of SENDER, Optional parameters may be set to an empty value which indicates the default value for optional parameters are used. For example, if
parameter2
is an optional parameter, then the request URL can be /sms/send/?parameter1=value1&
parameter2=
¶meter3=value3.
-
For the SENDER optional parameter, if the parameter is included, it must be set to a sender address in the request URL. If you do not want to include a sender address with the message, leave out the SENDER parameter rather than setting it to an empty value.
-
Parameters in the request URL can be in any order.
Request URL Parameters
|
Parameter
|
Type
|
Use and expected value
|
Inclusion
|
|
TEXT |
Mandatory |
0-112 character string of ASCII characters. (the length of TEXT values must not exceed 112 characters). |
This parameter must be included in all HTTP requests to send ASCII based SMS messages. It must not be included in the same request as the DATA parameter outlined below. |
|
DATA |
Mandatory |
0-224a ASCII formatted hex characters (the length of DATA values must not exceed 224 characters).
If the length of hex message is odd, or can't divide exactly by the length of the encoded character, the actual message sent to DUT will be padded with trailing "0"s (zeros) as necessary to make the message contain a whole number of encoded characters, and the error "SMS message padded with trailing zeros to define whole characters" will be generated on the test set.
|
This parameter must be included in all HTTP requests to send binary SMS messages. It must not be present in the same request as the TEXT parameter outlined above.
|
|
MSGENCODING
|
Optional |
Set the encoding scheme for the user entered message contents. See
Message Encoding
.
|
Default = ASCII7
|
|
TELESERVICE |
Optional |
The teleservice type of the SMS message sent to the MS. See
Teleservice
. |
Default = WMT |
|
PRIORITY |
Optional
|
Set the priority level of the SMS message sent to the MS. See
Priority
. |
Default = Normal |
|
PRIVACY |
Optional
|
Set the privacy level of the SMS message. See
Privacy
. |
Default = None |
|
UDI
|
Optional
|
Specify whether include the user entered message content in the SMS message sent to the mobile station. See
Message (Optional User Data)
.
|
Default = Include
|
|
SENDER
|
Optional
|
The phone number of the sending client as a 0 - 14 character ASCII formatted string of BCD digits from 0-9, * and #.
|
Default = 1000
|
|
MMTS
|
Optional
|
The More Messages to Send (MMTS) is used to indicate to the receiving entity if more messages are waiting in the service center to be sent to the phone after the current message. It should be 0 or 1. If it is set to 1, the MESSAGE_ID in Data Burst Message will be kept unchanged, so the mobile phone will concatenate the consecutive messages with same MESSAGE_ID to be a single SMS message. If it is set to 0, there is no more messages.It is valid only when the teleservice type of a SMS message is set to WAP. If the teleservice type is not WAP, MMTS will always be 0 regardless of the presence/value of this parameter.
|
Default = 0
|
|
MDMI |
Optional
|
the Message Display Mode Inclusion (MDMI) determines if the Message Display Mode sub-parameter is sent for teleservice types. See
MDMI
. |
Default = Exclude |
|
MDM |
Optional |
Set the Message Display Mode which is used to indicate to the mobile station when to display the receive message. See
MDM
. |
Default = 0 |
|
IGNORELENLIMIT
|
Optional
|
The IGNORELENLIMIT is used to control if the limit of maximum length (TEXT 112 characters, DATA 224 characters) can be ignored.
Should be either TRUE or FALSE. TRUE means the limit of maximum length in http interface can be ignored. This does not ensure SMS with arbitrary length can be sent without data loss on radio interface. If the SMS is too long, it may still be truncated according to 3GPP2 standard. FALSE means the limit of maximum length is TEXT 112/DATA 224 characters.
|
Default = FALSE
|
-
When a text message is being submitted via the 'TEXT' parameter, HTTP URL escaping restrictions apply. It is only necessary for you to use the escape characters when building a request URL manually. If you are sending messages to the mobile station through either an SMS gateway or from another test set, the escaping is performed automatically. Characters that require escape characters when used in URLs are detailed in the following table.
URL Escape Codes
|
Decimal character code(s)
|
7-bit US-ASCII representation
|
URL Escape sequence
|
|
0-31
|
control characters
|
%00 - %1F
|
|
32
|
SP
|
%20
|
|
34-38
|
" # $ % &
|
%22 - %26
|
|
43
|
+
|
%2B
|
|
44
|
,
|
%2C
|
|
47
|
/
|
%2F
|
|
58-64
|
: ; < = > ? @
|
%3A - %40
|
|
91-94
|
[ \ ] ^
|
%5B - %5E
|
|
96
|
`
|
%60
|
|
123-126
|
{ | }
|
%7B - %7E
|
Example Request URL Strings
Text Message:
To send a text based SMS message with the following message details:
-
Originating number: 1001
-
Message text: "This is a simple text message"
You would format the HTTP request URL as follows:
/sms/send/?TEXT=This%20is%20a%20simple%20text%20message&SENDER=1001 ("20%" represents a space character.)
Binary Message:
To send a binary message with the following message details:
-
Originating number: 987654321
-
Message content: 140601AE02056A0045C60D036262632E636F2E756B2F6D6F62696C6500070103424243206D6F62696C652073697465000101
-
Teleservice type: WAP
-
Massage encoding: OCTET
You would format the HTTP request URL as follows:
/sms/send/?DATA=140601AE02056A0045C60D036262632E636F2E756B2F6D6F62696C6500070103424243206D6F62696C652073697465000101&TELESERVICE=WAP&MSGENCODING=Octet&SENDER=987654321
State Determination for Sent Messages
The state of the last MT SMS message (see
SMS Status Description
) can be determined by sending an HTTP request to the test set (for example: "/sms/mtstate"). This can be done either by writing a simple program or by using an internet browser.
In the case of an Ack state being returned, if the mobile station sends an Ack cause code, then the body of the HTTP response shall also contain the value of the MS Ack cause code as well as the associated string. See
MS Ack Cause Code & String
for details.
Operation Considerations
-
It is not recommended that SMS messages are sent to the HTTP input interface in conjunction with sending SMS messages to a DUT via the test set MUI or RUI.
-
It is recommended to set the Slot Cycle Index to be no greater than 5 when sending MT HTTP SMS messages on common control channel.
-
If you want to do a stress test and send a lot of HTTP SMS messages to MS, it is recommended to establish a call connection and send HTTP SMS messages on traffic channel.
|
|