API Function: auth_callback_sig
API Function Application: Authenticate outbound call back request.
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.


This request is used to authenticate and route outbound callback calls received from your subscribers.
PLEASE NOTE: This function is ONLY used if Cloud9 is offering a signalling ONLY service. If you wish Cloud9
to terminate all call traffic then please see Authenticate CallBack Call 1

When a call is received from one of your assigned MSISDN’s we will pass a HTTP request like so to your HTTP Server.

 

http://api.yourdomain.net/moc_sig.asp?&timestamp=2008-08-01%2000:00:18&imsi=234180000000000&msisdn=%2B44770000000&calldestination=%2B441234567890&transactionid=1000&mcc=214
&mnc=01&request_type=auth_callback_sig&carrierid=1&tadig=GBWC9&iot=0&iot_charge=0.0000&ecc=0

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

 

The URL is made up of the following variables:

 

TIMESTAMP

 

This variable will contain a time stamp of when the inbound call was received by our network. The date and time will be in yyyy-mm-dd HH:mm:ss format.

IMSI

This variable will contain the IMSI of the subscriber who has made the outbound call request.

TRANSACTIONID

This variable will contain a numerical ID as assigned by our network for the call authentication request.

CARRIERID

The carrier ID that has been assigned to you for use with our API.

MSISDN

This variable will contain the MSISDN of the subscriber who has made the outbound call 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.

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.

REQUEST_TYPE

This variable will contain the API HTTP request type. For Outbound Call Back Call authorisation this will be AUTH_CALLBACK_SIG

CALLDESTINATION

This variable will contain the subscribers dialed destination. The information passed in this variable will be as entered by the subscriber. The destination could contain dialed destinations or USSD short codes. All destination strings will be suffixed with a '#' character. e.g. If a user calls +441283123456# the string passed will contain +441283123456#. If the user sends a USSD code such as *100*# the string passed will be *100*#. It down to your systems to format the dial string into the correct format for processing.

IOT

If the user is in an IOT chargeable country then this variable will be set to 1 else this variable will be set to 0

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.

ECC

This variable will contain a value of 0 or 1. If 0 then the Sim Call Control application was not used when the call was placed (so the user dialed the destination number suffixed with a '#') If 1 then the destination number was dialed by the Sim Call Control application.

 

When a request is received by your HTTP server you will be required to process the reqest and then output the following
XML output (to version 1 specifications) so our server can then read your responce:

 

<? xml version="1.0" ?>

<MOC_response>

 <transaction_id>1002</transaction_id>

 <display_message>Calling +441234567890</display_message>
</MOC_response>


Your XML response needs to contain the following data fields. Please note that these data fields are caps sensitive so please output as
exactly shown below:

<MOC_response>

 

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

<TRANSACTION_ID ></TRANSACTION_ID>

The transaction_id tag must contain the transaction ID we passed you within the HTTP request. In the above example this would be 1002.

<DISPLAY_MESSAGE></DISPLAY_MESSAGE>

The display message tag needs to contain the message that you want displayed on the subscribers handset. You can use characters 0-9, a-z, A-Z '. , < > " () . The display message has a maximum limit of 159 characters. This field MUST be populated at all times regardless if you allow the call or not.

</MOC_response>

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

 

Please Note: If the XML data is not received back in the required format the USSD session will be
dropped and a system default error message will be sent back to the subscriber.

 

If your server is unable to process the request or a system error occurs please 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 needs to contain information to why the request could not be processed.

 

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.