Cloud9 HTTP/XML/SS7 System API

HTTP/XML/SS7 System API V2.3

Email page

Print page

Tuesday, September 07, 2010 01:09:58

Balance Functions

DDI Mapping

CDR Functions

IMSI Control Functions

Inbound Call Functions

MSRN Functions

Outbound Call Functions

Pin Functions

Routing Functions

SMS Functions

USSD Functions

Voicemail Functions

Cloud9 HTTP/XML System API

Communication into the Cloud9 API is carried out by sending a formatted HTTP string into the Cloud9 HTTP/XML/SS7 gateway server.
The example below shows a formatted HTTP string to return a MSRN of a subscriber:

http://api.wire9.com/api.cgi?transaction_id=1000&query=%2B447700000000&request_type=get_msrn&carrier_id=1
&password=test&timestamp=2007-03-08%2023:43:43

The string is made up of several variables which tells the Cloud9 API server what action to carry out and what data to return.

URL	http://api.wire9.com/api.cgi
Transaction_ID	This variable must be set to a numerical value by your system. The ID is used to track the HTTP request through the Wire9 system. The data returned by our system will contain the ID that you assign. The transaction ID can be assigned a value from 0 – 999999.
QUERY	This variable must contain the MSISDN or IMSI of the subscriber of whom to return a MSRN for. If passing a MSISDN you may use the following formats: 07xxx, 447xxx or +447xxx.
REQUEST_TYPE	This variable must be set to get_msrn. This setting tells our system that you wish to carry out a GET MSRN request.
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.

When a valid HTTP request is received the Cloud9 server will reply with a XML response like so:

<?xml version="1.0" ?>

<Wire9_data>

<MSRN_Response>

<HLR_ID>2532</HLR_ID>

<IMSI>234180000000004</IMSI>

<MCC>234</MCC>

<MNC>18</MNC>

<MSISDN>+447924510004</MSISDN>

<MSRN>+447872201220</MSRN>

<REQUEST_STATUS>1</REQUEST_STATUS>

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

<TRANSACTION_ID>1000</TRANSACTION_ID>

<USER_BALANCE>0.0000</USER_BALANCE>

<IOT>0</ IOT>

</MSRN_Response>

</Wire9_data>

The response contains data which your system can then phase through. In the above example the returned MSRN for the
subscriber is contained within the <MSRN></MSRN> tag. You can use the returned data to populate your own database or to
trigger functions on your own servers.

The Cloud9 system, depending on enabled API functions can also send data to your systems via a HTTP string. When this data is received
your system needs to work through the passed variables and then produce a XML output as defined in this HTTP/XML guide.

The Cloud9 API offers and supports a wide range of HTTP input and output functions which enable you to control call routing to
user balances. Please use the menu to your left to explore the range Cloud9 functions which can help you personalize your Cloud9
roaming solution.

Top of page Email page Print page

Last Review 07/09/2010 @ 01:09:58