HTTP/XML/SS7 System API V2.3
The 'sms_call_message_status' function enables you view if SMS call cost/ remainder balance sending is enabled or disabled for a particular subscriber. When enabled if a subscriber makes a call back call on call completion the system will send a SMS push message telling the subscriber how much the call cost and what the subscribers remaining balance is. To use this function send a formatted HTTP string like so:
http://api.wire9.com/api.cgi?transaction_id=1000&query=%2B447700000000 &request_type=sms_call_message_status&carrier_id=1&password=test×tamp=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 query. If passing a MSISDN you may use the following formats: 07xxx, 447xxx or +447xxx.
REQUEST_TYPE
This variable must be set to sms_call_message_status. This setting tells our system that you wish to carry out a SMS end of call 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 SMS_call_message_status request will fail if the required variables are not passed in the correct format.
When a valid SMS_call_message_status 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>
<SMS_Response>
<SEND_SMS>1</SEND_SMS>
<IMSI>234180000000000</IMSI>
<MSISDN>+447700000000</MSISDN>
<REQUEST_STATUS>1</STATUS>
<TIME_STAMP>2007-03-08 23:43:43</TIME_STAMP>
<TRANSACTION_ID>1000</TRANSACTION_ID>
</SMS_Response>
</Wire9_data>
IMSI
This variable contains the IMSI of the subscriber.
MSISDN
This variable will contain the MSISDN of the subscriber.
SEND_SMS
This variable will contain a either a 1 (one) or a 0 (zero). 0 = SMS end of call is disabled, 1 = SMS end of call is enabled.
REQUEST_STATUS
Options: 0 = Fail 1 = Success
TIME_STAMP
The returned TIMESTAMP that you passed within the HTTP request string.
The transaction ID your system assigned to the GET MSRN request.
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:20
Privacy Statement | HTTP/XML System API © 2010 Cloud9 Mobile International Ltd. All Rights Reserved.