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.

https://piopiy.telecmi.com/v1/analysis

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
appid	number	Your app ID
token	string	Your app secret
start_date	number	The from date and time in timestamp. By default the timestamp will be last 24 hours from current timestamp.
end_date	number	The to date and time in timestamp, By default the timestamp will be current timestamp .

Note

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
}

Properties

These are the list of properties and its description

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

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

Status code	Status code	Description
200	OK	We received the request
404	Error	Invalid app id or secret, authentication failed