Cloud9 HTTP/XML/SS7 GSM System API - Function 'imsi

HTTP/XML/SS7 System API V2.3

Email page

Print page

Tuesday, September 07, 2010 01:09:31

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: imsi_status
API Function Application: Query the status of a subscribers IMSI
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 query the status of a subscribers IMSI simply send a HTTP request like so:

http://api.wire9.com/api.cgi?transaction_id=1001&query=%2B447700000000&request_type=imsi_status&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 cloud9 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 who 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 IMSI_STATUS. This setting tells our system that you wish to carry out a IMSI Status 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 IMSI Status request will fail
if the required variables are not passed in the correct format.

When a valid IMSI Status Request is made the Cloud9 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>

<STATUS_Response>

<COUNTRY>United Kingdom</COUNTRY>

<IMSI>234180000000004</IMSI>

<MSISDN>+447700000000</IMSI>

<MCC>234</MCC>

<MNC>18</MNC>

<OPERATOR>cloud9 mobile</OPERATOR>

<REQUEST_STATUS>1</STATUS>

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

<TRANSACTION_ID>1000</TRANSACTION_ID>

<LAST_LU>2007-06-08 17:43:50</LAST_LU>

<VLR>+447802000166</VLR>

</STATUS_Response>

</Wire9_data>

The XML output is made up like so:

COUNTRY	This variable contains the name of the country of where the subscriber is currently located (if the data is available).
IMSI	This variable contains the IMSI you passed within your HTTP request.
MSISDN	This variable contains the assigned MSISDN associated with the IMSI.
MCC	This variable will contain (if the data is available) the MCC country code of where the handset 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 handset is logged onto). For example 18 for the cloud9 Network.
OPERATOR	This variable will contain the name of the GSM network operator (if the data is available).
REQUEST_STATUS	Options: 0 = IMSI is disabled 1 = IMSI is enabled
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.
LAST_LU	The date and time of the last LU attempt in yyyy-mm-dd HH:mm:ss format.
VLR	The GT of the last LU attempt as issued by the roaming 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