API Function: balance_trigger
API Function Application: Send user balance to your server on balance change
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.


The balance_trigger function enables you to receive a subscribers balance every time the subscribers
balance is updated.

 

http://api.yourdomain.net/balance_update.asp?request_type=balance_trigger&timestamp=2008-08-15%2018:27:01&transactionid=123456&carrierid=1&mcc=310&mnc=01&imsi=234180000000000
&msisdn=%2B447700000000&balance=45.00

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

 

The URL is made up of the following variables:

 

REQUEST_TYPE

This variable will be set to BALANCE_TRIGGER.

TIMESTAMP

The date and time the HTTP request was created in yyyy-mm-dd HH:mm:ss format. This time stamp is used for the API CDR records.

TRANSACTIONID

This variable will be set to a numerical value by our system. The ID is used to track the HTTP request through the Cloud9 system.

CARRIERID

This variable will contain the carrier ID that has been assigned to you for use with our API.

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 Wire9 Network.

IMSI

This variable will contain the IMSI of the subscriber.

MSISDN

This variable will contain the MSISDN of the subscriber.

BALANCE

The variable will contain the subscribers balance in 0.00 format. Please note the currency used will be your system default currency.

 

When a BALANCE_TRIGGER function request is sent your server is required to respond like so:

 

<?xml version="1.0" ?>

<BALANCE_response>

<request_status>1</request_status>

</BALANCE_response>

The XML output is made up like so:

<BALANCE_RESPONCE>

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

<REQUEST_STATUS></REQUEST_STATUS>

This variable must either 0 (zero) or 1 (one). If 0 then the request failed, if 1 then the request was successful.

</BALANCE_RESPONCE>

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

 

If your server is unable to process the request or a system error occurs 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

Privacy Statement | HTTP/XML System API © 2010 Cloud9 Mobile International Ltd. All Rights Reserved.