API Function: mo_sms
API Function Application: Authenticate outbound SMS request.
API Function Request Type: HTTP Request is sent from Cloud9 to your server.
API Function Status: Requires enablment by Cloud9 before use.
API Function Examples: Click Here to view online examples.


This request is used to authenticate and allow the routing of outbound SMS's received into the Cloud9 network.
When a SMS is received to one of your assigned MSISDN’s we will pass a HTTP request like so to your HTTP Server.

 

http://api.yourdomain.net/mo_sms.asp?timestamp=2008-08-13%2012:12:51&imsi=234180000000000&transactionid=1000
&carrierid=1&msisdn=%2B447700000000&destination=%2B447700000001&mcc=222
&mnc=10&request_type=MO_SMS&user_balance=0.0000&IOT=0&tadig=GBWC9&iot_charge=0.0000

IMPORTANT: The string we send you will be URL encoded.

 

The URL is made up of the following variables:

 

TIMESTAMP

 

This variable will contain a time stamp of when the inbound call was received by our network. The date and time will be in yyyy-mm-dd HH:mm:ss format.

IMSI

This variable will contain the IMSI of the subscriber who is to receive the inbound call.

TRANSACTIONID

This variable will contain a numerical ID as assigned by our network for the call authentication request.

CARRIERID

The carrier ID that has been assigned to you for use with our API.

MSISDN

This variable will contain the MSISDN of the subscriber who is to receive the inbound call.

MCC

This variable will contain (if the data is available) the MCC country code of where the subscriber is located. For example 234 for the UK.

MNC

This variable will contain (if the data is available) the MNC operator code (The network name that the subscriber is logged onto). For example 18 for the Cloud9 Network.

TADIG

This variable will contain (if the data is available) the TADIG network code (The network identifier of the network that the subscriber is logged onto). For example GBWC9 for the Cloud9 Network.

REQUEST_TYPE

This variable will contain the API HTTP request type. For Inbound Call authorisation this will be MO_SMS

DESTINATION

The destination number of the text message. The destination will always be in full international format prefixed with a '+' (so for a UK destination you would see +447xxx).

USER_BALANCE *

The amount of credit available to the user in £ and pence format (or $, cents or €, cents depending on the subscribers currency setings)
* If your system is holding the user balance then this variable can be ignored as it will be set to 0.00

IOT

If the user is in an IOT chargeable country then this variable will be set to 1 else this variable will be set to 0

IOT_CHARGE

If the user is in an IOT chargeable country then this variable will contain the IOT charge per text that Cloud9 will change. This change is for IOT ONLY and doesn't include Cloud9's standard SMS termination charge. The charge is in UK Sterling in £0.00 format. Please add your markup to this charge when charging your users.

 

When a request is received by your HTTP server you will be required to process the request and then output the following
XML output (to version 1 specifications) so our server can then read your response:

 

<? xml version="1.0" ?>

<MO_SMS_response>

 <transaction_id>1000</transaction_id>

 <request_status>1</request_status>
</MO_SMS_response>


Your XML response needs to contain the following data fields. Please note that these data fields are caps sensitive so please output as
exactly shown below:

<MO_SMS_response>

 

The <MTC_response tag> is required so our system can detect your server’s XML reply.

<TRANSACTION_ID ></TRANSACTION_ID>

The transaction_id tag must contain the transaction ID we passed you within the HTTP request. In the above example this would be 1002.

<REQUEST_STATUS ></ REQUEST_STATUS>

The request status tag must contain either a 0 (zero) or 1 (one). 0 = Failure 1 = Success If set to 0 then our system will not allow the SMS. If set to 1 then our system will process the SMS and allow it to forwarded to the destination.

</MO_SMS_response>

The </MTC_response> tag is required so our system can detect your server’s XML reply.

 

Please Note: If the XML data is not received back in the required format then the SMS will NOT be
authenticated and the SMS request will be dropped.

 

If your server is unable to process the request or a system error occurs please 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 needs to contain information to why the request could not be processed.

 

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.