API Function: send_sms
API Function Application: Send an SMS to a subscriber
API Function Request Type: HTTP Request is sent from your server to our server.
API Function Status: Available as standard
API Function Examples: Click Here to view online examples.


To send an SMS to a subscriber, send a HTTP request like so:

 

http://api.wire9.com/sms.cgi?transaction_id=1003&request_type=send_sms&carrier_id=1&password=test
&timestamp=2007-0308%2023:43:43&smsto=%2B447924510004&smsfrom=%2B447700000000
&message=this%20is%20a%20test%20message

IMPORTANT: You must URL Encode your HTTP string. URL Encoding replaces unsafe ASCII characters with "%" followed by their hex equivalent. Safe characters are defined in RFC2396. For example a '+' will become '%2B'

PLEASE NOTE: For SMS sending you need to point your request to SMS.CGI and NOT API.CGI

 

The URL is made up of the following variables:


URL

http://api.wire9.com/api.cgi

TRANSACTION_ID

The transaction ID your system assigned to the SEND SMS request.

REQUEST_TYPE

This variable must be set to SENDSMS. This setting tells our system that you wish to send an SMS to a subscriber.

CARRIER_ID

This variable must contain the carrier ID that has been assigned to you for use with our API. Please contact support@cloud9-mobile.co.uk if you do not have your API carrier ID.

PASSWORD

This variable must contain the password that has been assigned to you for use with our API. Please contact support@cloud9-mobile.co.uk if you do not have your API password.

TIMESTAMP

This variable is set by your system. It should contain a valid date and time in yyyy-mm-dd HH:mm:ss format. This time stamp is used for the API CDR records.

SMSTO

The MSISDN of the subscriber you with to send a text to. Please note that the number MUST be passed in full international format prefixed with a '+' or message sending will fail (e.g. send to +44770000000)

SMSFROM

This field can contain a numerical value or character valued string. Examples: SMSFROM=+447700000000 or SMSFROM=cloud9 Please note: The SMSFROM field can not contain more than 13 characters. If you are sending a character based SMS FROM then only lower case letters are allowed (a-z), numerical characters (0-9) and the '_' (underscore) character.

MESSAGE

The message field can contain a maximum of 168 characters. Valid charters are A-Z, a-z, 0-9, <space>, comma (,), minus sign (-), plus sign (+), full stop (.). Our system will except and process all other characters but message sending may fail due to the recipient network rejecting the message due to unknown character types.

 

Please Note: All of the above variables are required within the HTTP request string. The Send SMS request will fail if the required
variables are not passed in the correct format. Sending of messages is only allowed to your own subscriber base and all UK OFCOM
regulations in regards to sending SMS messages apply.

When a valid Send SMS Request is made our system will return a standard XML (version 1 tree) which will contain the following
data which your system must phase through and pull out the required data:

 

<?xml version="1.0" ?>

<Wire9_data>

<SMS_Response>

<REQUEST_STATUS>1</REQUEST_STATUS>

<TIME_STAMP>2007-03-08 23:43:43</TIME_STAMP>

<TRANSACTION_ID>1000</TRANSACTION_ID>

<SMSTO>+447924510004</SMSTO>

<SMSFROM>+447700000000</SMSFROM>

<SMSMessage>This is a test message</SMSMessage>

</SMS_Response>

</Wire9_data>


The XML output is made up like so:

IMSI

This variable contains the IMSI you passed within your HTTP request.

REQUEST_STATUS

This variable will contain the request status responce.
Options: 0 = Request Failed 1 = Request Successful

TIME_STAMP

The returned TIMESTAMP that you passed within the HTTP request string.

TRANSACTION_ID

The transaction ID your system assigned to the IMSI Status request.

SMSTO

The MSISDN of the subscriber you wish to send the SMS message to.

SMSFROM

The MSISDN or name to be displayed on the receiving parties handset.

SMSMessage

The message that was sent to the subscriber.

 

If our server is unable to process the request or a system error occurs we will send back a formatted XML
error message like so stating what error occurred within the <Error_Message></Error_Message> tag:

 

<? xml version="1.0" ?>

<Error>

 <Error_Message>Error: Unknown user </Error_Message>
</Error>

 

ERROR_MESSAGE

This variable will contain information to why the request could not be processed by our system.

 

Top of page      Email page    Print page

Last Review 16/08/2008 @ 21:08:19

Privacy Statement | HTTP/XML System API © 2010 Cloud9 Mobile International Ltd. All Rights Reserved.