Conversion API

Adding conversion details for each message helps you to keep insight into conversions using Analytics and it helps CM.com to improve the quality of our service. We recommended looking into using the Conversion web API.

A conversion is a confirmation that an end-user has used the contents of the sms/voice/push message that was processed by CM.

Introduction

The purpose of the Conversion web API is to enable third parties to deliver conversion details per message to CM.com.

A conversion is a confirmation by a third party that their end-user has used the contents of the sms/voice/push message that was processed by CM.com.

Credentials will be provided by your account manager

Conversion

Every request will get an HTTP response with status 200-OK. If the request was correct, the response will be empty. If the authorization failed the HTTP response will have status 401. General errors or internal issues will have status 500 or 503 in its response.

POST

The interface expects a valid JSON or XML document to be posted.

https://api.cmtelecom.com/v1.0/conversion

Every request will get an HTTP response with status 200-OK. If the request was correct, the response will be empty. If the request was incorrect or malformed, the HTTP response will have status 401/403 – Unauthorized or status 500 – Internal Server Error.

JSON example

{
    "ProductToken": "00000000-0000-0000-00000000000000000",
    "Msisdn": "00310687654321"
    "Reference": "demo_00002_20171234",
    "ConvertedTimestamp": "2017-12-07T14:40:00"
}

XML Example

<Conversion>
    <Customer>12345</Customer>
    <Login>BrandName</Login>
    <Password>Secret2</Password>
    <Reference>ABCDEF</Reference>
    <Msisdn>0031612345678</Msisdn>
    <ConvertedTimestamp>2014-08-26T09:06:30.123</ConvertedTimestamp>
    <NotificationTimestamp>2014-08-26T09:06:31.456</NotificationTimestamp>
</Conversion>

JSON/XML Elements

namerequiredtypeDescription
ProductTokenTrue*AlphanumericUsed for authentication. Visit https://gateway.cmtelecom.com to retrieve your product token, if you are entitled to do so.
CustomerTrue*NumericUnique client ID (provided by CM).
loginTrue*AlphanumericLogin name (provided by CM).
PasswordTrue*AlphanumericPassword (provided by CM).
ReferenceTrue**AlphanumericUnique ID of the sms/voice/push message that was processed by CM.com
MsisdnTrue**NumericRecipient mobile number in international format with 00 prefix. Example: 0031612345678
ConvertedTimestampTrueDateTime (UTC)Moment of confirmed code by end-user in UTC. Format: yy-MM-ddThh:mm:ss Example: 2014-08-26T09:06:31.45

🚧

Note

* Authentication should either be done by a ProductToken or a combination of customer, login and password.
** At least one of the fields is required to be filled. If available, post both the Reference and Msisdn

Responses

http codestatus description
200Success
401Unauthorized
403Forbidden
500Error
503Error

Did this page help you?