Home | Downloads | Support | Newsletter | Documentation | Search
 
Documentation
Home
Downloads
Support
Documentation
Related Links

Url Parameters for Sending Messages

To send an SMS message via a menu driven interface, please see the help section titled “Web Menu Interface”. This section describes how to send a text message programmatically via URL parameters.

To send a message via SMS, use the following URL format:

http://127.0.0.1:8800/?PhoneNumber=xxxxxxxx&...

For 127.0.0.1, please substitute the IP address or host name assigned to your gateway PC. (Note: 127.0.0.1 is a local loopback address that can be utilized when you are connecting to the gateway from the same computer.)

For 8800, please substitute the port number that the gateway is configured to use.

Substitute the phone number that you wish to send the SMS message to for the “xxxxxxxx” in the “PhoneNumber” parameter. Use either the local phone number format, or the international phone number format (your network provider may or may not allow you to send to international phone numbers). If the international phone number format is used, note that you must substitute “%2B” for the “+” character, because of URL escaping restrictions. For example, to send an SMS to +447778001210, use the following URL format:

http://127.0.0.1:8800/?PhoneNumber=%2B447778001210&...

Parameters after the “…” are dependent on the type of message being sent. The following table summarizes available URL parameters:



URL Parameter
Message Type
Description
PhoneNumber
All
Recipient phone number
User
All
If an "Authorization:" header is not present in the request, this parameter specifies the user account (from "SMS Users") that is submitting the message.
Password
All
If an "Authorization:" header is not present in the request, this parameter specifies the password for the user account ("User" parameter) that is submitting the message.
Text
Text SMS, Binary SMS, WAP Push, WAP OTA Bookmark

For SMS text messages, this specifies the text of the message. For binary SMS messages, this is a string of hexadecimal characters representing the data being sent in the binary message. For WAP Push messages, this is the text associated with a Service Indication (SI) Push. For a WAP OTA Bookmark, this is the text name of the bookmark.
Data
Same as “Text” parameter
Interchangeable with the “Text” parameter. Officially documented only for binary SMS messages.
UDH
Binary SMS
A text string of hexadecimal characters representing the User Data Header (UDH) of the binary SMS message.
DCS
Binary SMS
A hex value representing the value of the SMS Data Coding Scheme (DCS) for this message. F5 is a common value for most binary SMS message types.
PID
Binary SMS
A hex value representing the SMS Protocol ID (PID) of this SMS message.
Binary
Binary SMS
Set to 1 for binary message submission
Sender
All
Sender phone number for this SMS message.
ContinueURL
All
URL to continue to after SMS message submission.
VoiceMail
Voice Mail Notification
Set to “On” to turn on voice mail waiting indication, “Off” to turn off voice mail waiting indication.

WAPURL
WAP Push
URL to be referenced in the WAP Push message.
WAPSL
WAP Push
Set to any value to send the WAP Push as a “Service Load” (SL) message, instead of the default “Service Indication” (SI) message.
MMSText
MMS Message
Text to be included when sending an MMS Message.
MMSFile
MMS Message
Contains the contents of an uploaded file posted via a form with a MIME encoding of “multpart/form-data”, or specifies an HTTP URL pointing to the file content when specified in an HTTP GET request.
MMSSubject
MMS Message, MMS Notification
Subject for the MMS Message or MMS Notification Message.
MMSFrom
MMS Message, MMS Notification
Sender for the MMS Message or MMS Notification Message
MMSURL
MMS Notification
URL that contains the MMS Message content for which an MMS Notification Message should be generated.
WAPBookmark
WAP Bookmark
URL to be sent as a bookmark.
OTA
WAP OTA Config
Name of an “.ota” file in the OTA subdirectory which contains WAP OTA Configuration information.
         
OTAOMA  
OMA Provisioning Content OTA
  Name of an ".ota" file in the OTA subdirectory which contains an OMA Provisioning Content docuemnt, or value "POST" when provisioning content is being submitted via HTTP POST.
OTAPIN  
OMA Provisioning Content OTA
  PIN associated with the OMA Provisioning Content Request. (PIN is the SIM card IMSI when OTAPINTYPE=NETWPIN)
         
OTAPINTYPE  
OMA Provisioning Content OTA
  Specifies the type of PIN specified in the OTAPIN variable. Can either be a value of USERPIN or NETWPIN.
         
OTABookmark
WAP OTA Config
Name of a “.bm” file in the OTA subdirectory which contains WAP OTA bookmark configuration information.
OTA_BEARER
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=BEARER
OTA_PPP_AUTHTYPE
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=PPP_AUTHTYPE
OTA_PPP_AUTHNAME
WAP OTA Config
Maps to TYPE=ADDRESS PARM NAME=PPP_AUTHNAME
OTA_PPP_AUTHSECRET
WAP OTA Config
Maps to TYPE=ADDRESS PARM NAME=PPP_AUTHSECRET
OTA_PPP_LOGINTYPE
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=PPP_LOGINTYPE
OTA_PROXY
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=PROXY
OTA_PROXY_TYPE
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=PROXY_TYPE
OTA_PROXY_AUTHNAME
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=PROXY_AUTHNAME
OTA_PROXY_AUTHSECRET
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=PROXY_AUTHSECRET
OTA_PROXY_LOGINTYPE
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=PROXY_LOGINTYPE
OTA_PORT
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=PORT
OTA_CSD_DIALSTRING
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=CSD_DIALSTRING
OTA_CSD_CALLTYPE
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=CSD_CALLTYPE
OTA_CSD_CALLSPEED
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=CSD_CALLSPEED
OTA_ISP_NAME
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=ISP_NAME
OTA_SMS_SMSC_ADDRESS
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=SMS_SMSC_ADDRESS
OTA_USSD_SERVICE_TYPE
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=USSD_SERVICE_TYPE
OTA_GPRS_ACCESSPOINTNAME
WAP OTA Config
Maps to TYPE=ADDRESS, PARM NAME=GPRS_ACCESSPOINTNAME
OTA_URL
WAP OTA Config
Maps to TYPE=URL
OTA_MMSURL
WAP OTA Config
Maps to TYPE=MMSURL
OTA_NAME
WAP OTA Config
Maps to TYPE=NAME PARM NAME=NAME
OTA_BOOKMARK_NAME
WAP OTA Config
Maps to TYPE=BOOKMARK, PARM NAME=NAME
OTA_BOOKMARK_URL
WAP OTA Config
Maps to TYPE=BOOKMARK, PARM NAME=URL
OTA_ID
WAP OTA Config
Maps to TYPE=ID, PARM NAME=NAME

When a text message is being submitted via the “Text” parameter, note that due to URL escaping restrictions, space characters should be replaced with “+” characters. Also, certain special characters, such as “?”, “&”, “:” and “=” need to be replaced with an escape character. The gateway expects characters to be encoded in UTF-8 (Unicode-based) format, therefore some characters, including the Euro (€) may require multiple escaped characters. (Note: The Web Menu Interface automatically performs this escaping.) The following table shows common characters that must be escaped:

"
%22
<
%3C
>
%3E
&
%26
+
%2B
#
%23
%
%25
*
%2A
!
%21
,
%2C
'
%27
\
%5C
=
%3D
%E2%82%AC

Message text up to 160 characters in length can be sent in a single SMS message. The gateway automatically supports the sending of longer messages by utilizing “concatenated SMS” to send messages larger than 160 characters in length. Note that some older mobile phones will not support longer SMS messages. For longer SMS messages, one message is sent for every 153 characters of text in the message.



Return to Now SMS/MMS Gateway Help