API Function: mosms_cdr
API Function Application:
Send MO SMS CDR data to your server
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 mosms_cdr function enables you to receive mobile originated SMS CDR data to your server.
Our system will pass a URL string like so to your server:

 

http://api.yourdomain.net/cdr.asp?request_type=MOSMS_CDR&timestamp=2008-08-15%2017:49:21
&message_date=2008-08-15%2017:49:21&transactionid=100744&cdr_id=123456&carrierid=1
&mcc=222&mnc=10&imsi=234180000000000&msisdn=%2B4477000000000
&destination=%2B447700000001&message_status=0&reseller_charge=0.0000&client_charge=0.0000
&user_charge=0.0000&IOT=0&user_balance=10.00&service_id=1

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 MOSMS_CDR.

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.

MESSAGE_DATE

This variable will contain the date and time of the SMS in yyyy-mm-dd HH:mm:ss format.

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.

CDR_ID

This variable will contain a unique ID which has been assigned to the CDR.

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 who has made the outbound SMS request.

MSISDN

This variable will contain the MSISDN of the subscriber who has made the outbound SMS request.

DESTINATION

This variable will contain the destination number that subscriber set a message to. The destination number will be in full international format prefixed with a '+' (so for the UK you will see +44xxx)

MESSAGE_STATUS

This variable will contain the SMS sending status. 0 = Sending failed 1 = Sending was successful.

RESELLER_CHARGE

This variable will contain the reseller charge (your charge) in 0.00 format. The currency will be in your system default currency.

CLIENT_CHARGE

This variable will contain the client charge (your clients charge) in 0.00 format. The currency will be in your system default currency.

USER_CHARGE

This variable will contain the user charge (your users charge) in 0.00 format. The currency will be in your system default currency.

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

USER_BALANCE

This variable will contain the users balance after charges have been deducted (your users charge) in 0.00 format. The currency will be in your system default currency.

SERVICE_ID

The ID of the service used to send the SMS. This field will contain one of the following values:

1 = MSC (For SMS sent via Handset)
2 = Missed Call / VM Alert (For SMS sent via VM server)
3 = API (For SMS sent via Cloud9 API)
4 = OTA (For SMS sent via Cloud9 OTA server)
5 = Welcome (For SMS sent via Cloud9 server)
6 = Balance (For SMS sent via Cloud9 accounts server)
7 = Email (For SMS sent via Cloud9 email server)

 

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

 

<?xml version="1.0" ?>

<CDR_response>

<cdr_id>123456</cdr_id>

<cdr_status>1</cdr_status>

</<CDR_response>


The XML output is made up like so:

<CDR_RESPONCE>

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

<CDR_ID></CDR_ID>

This variable must contain the CDR ID we passed you within the HTTP post.

<CDR_STATUS></CDR_STATUS>

This variable must contain either 0 or 1 If 0 then this tells our system that the CDR post failed, if 1 then this tells are system the CDR post was successful. By default reply with these field set to 1.

</CDR_RESPONCE>

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

 

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

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