Analysis API

Each API request in TeleCMI platform includes App id and secret. Get your App id and secret in CHUB dashboard. After getting the app id and secret, make a POST request to the below base URL to retrieve the overall missed and answered call details.

Base URL

Send your POST method request with valid parameters, to the following base URL.

Required Parameters

These are the required POST method parameters with description

Parameter NameTypeDescription
appidnumberYour app ID
tokenstringYour app secret
start_datenumberThe from date and time in timestamp. By default the timestamp will be last 24 hours from current timestamp.
end_datenumberThe to date and time in timestamp, By default the timestamp will be current timestamp .
The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

"appid": 1111113,
"token": "xxxx-xxxx-xxxx-xxx",
"start_date": 1569911400000,
"end_date": 1570167249853

Sample Response

If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below

"code": 200,
"total": 59,
"answered": 19,
"missed": 40


These are the list of properties and its description

totalnumberThe overall call includes missed and answered
answerednumberThe total number of answered calls
missednumberThe total number of missed calls

HTTP status codes

TeleCMI API platform represents the following status code to identity the errors.

Status codeStatus codeDescription
200OKWe received the request
404ErrorInvalid app id or secret, authentication failed