Cloud9 HTTP/XML/SS7 GSM System API

HTTP/XML/SS7 System API V2.3

Email page

Print page

Tuesday, September 07, 2010 01:09:08

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

API Function: get_msrn
API Function Application: Return assigned MSRN of subscriber
API Function Request Type: HTTP Request is sent from your server to our server.
API Function Status: Requires enablment by Cloud9 before use.
API Function Examples: Click Here to view online examples.

To allow routing of a call to a subscriber’s handset from your telecommunications switch you must first carry out a GET MSRN request.
Whilst a handset is logged on to a network calls are routed to the handset via a temporary number that is assigned by the network
operator, this is known as a MSRN. The MSRN will stay open for approximately 60 seconds before the network operator terminates the
GET MSRN session, so the returned MSRN must be dialled within 60 seconds or else the call setup will fail.

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

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'

The URL is made up of the following variables:

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.

Please Note: All of the above variables are required within the HTTP request string.
The GET MSRN request will fail if the required variables are not passed in the correct format.

When a valid GET MSRN request is made the Cloud9 system will return a standard XML (version 1 tree)
which your system must then phase through and pull out the required data:

<?xml version="1.0" ?>

<Wire9_data>

<MSRN_Response>

<HLR_ID>2532</HLR_ID>

<IMSI>234180000000000</IMSI>

<MCC>234</MCC>

<MNC>18</MNC>

<MSISDN>+447700000000</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>

<TADIG>GBWC9</ TADIG>

<IOT>0</ IOT>

<IOT_CHARGE>0.0000</ IOT_CHARGE>

</MSRN_Response>

</Wire9_data>

The XML output is made up like so:

HLR_ID	This variable contains the network ID that was assigned to the HLR GET MSRN session request.
IMSI	This variable contains the IMSI you passed within your HTTP request.
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.
MSISDN	This variable will contain the MSISDN that is assigned to the IMSI.
MSRN	The returned MSRN for the subscriber. The MSRN will be in full international format prefixed with a '+' sign (e.g. +447xxx for the UK). If the subscriber is off line this field will contain the value ‘OFFLINE’
REQUEST_STATUS	Options: 0 = Fail 1 = Success
TIME_STAMP	The returned TIMESTAMP that you passed within the HTTP request string.
TRANSACTION_ID	The transaction ID your system assigned to the GET MSRN request.
USER_BALANCE*	The amount of credit available to the user in £ and pence format (or $, cents or €, cents depending on currency format) * If your system is holding the user balance then this variable can be ignored.
IOT	This variable will contain either a 0 or 1. If 0 then the destination MSRN is NOT within a IOT chargeable destination. If 1 then the destination MSRN IS AN IOT destination destination.
IOT_CHARGE	If the user is in an IOT chargeable country then this variable will contain the IOT charge per minute that Cloud9 will change for the call. This charge is for IOT ONLY and doesn't include Cloud9's call termination charges. The charge is in UK Sterling in £0.00 format. Please add your markup to this charge when charging your users.
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.

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