Analysis API

Each API request in TeleCMI platform includes App id and secret. Get your App id and secret in TeleCMI 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.

https://rest.telecmi.com/v2/analysis

Sample JSON Request

Below is the following sample JSON POST method request.

{
  "appid": 1111113,
  "secret": "xxxx-xxxx-xxxx-xxx",
  "start_date": 1569911400000,
  "end_date": 1570167249853
} 

Required Parameters

These are the required POST method parameters with a description.

Parameter Name	Type	Description
*appid	number	Your app id.
*secret	string	Your app secret.
start_date	number	The timestamp of start date and time in UTC timezone. By default the timestamp will be last 24 hours from current time.
end_date	number	The timestamp of end date and time in UTC timezone. By default the timestamp will be current time.

Note

The * marked parameter is mandatory.

Sample Response

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

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

Properties

This is the list of properties and their descriptions.

Property	Type	Description
total	number	The overall call includes missed and answered.
answered	number	The total number of answered calls.
missed	number	The total number of missed calls.

HTTP status codes

The TeleCMI API platform represents the following status code to identify the errors.

Status code	Status code	Description
200	OK	There was a successful response to your request.
404	Error	Authentication Failed.
400	Error	Parameter missing.