Skip to main content

Incoming Answered

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 incoming answered call details.

Base URL

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

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

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 .
pagenumberThe Number of page per 10 record. By default the page is 1.
limitnumberThe Number of record for request, By default the limit is 10.
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,
"page": 2,
"limit": 5
}

Sample Response

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

{
"total": 19,
"cdr": [
{
"_id": "5d95dabd04eaac7de3aa20c8",
"to": 9100000000,
"time": 1570101934939,
"from": 9200000000,
"agent": "201_1111113",
"billedsec": 14,
"rate": "0.00",
"record": "true",
"filename": "15700821185415026428427_1111113.mp3",
"name": "unknown"
},
{
"_id": "5d95daa804eaac7de3aa20c1",
"to": 9300000000,
"time": 1570101916018,
"from": 9400000000,
"agent": "201_1111113",
"billedsec": 12,
"rate": "0.00",
"record": "true",
"filename": "157008212492320417337498_1111113.mp3",
"name": "unknown"
},
{
"_id": "5d95dadb04eaac7de3aa20d0",
"to": 9500000000,
"time": 1570101820557,
"from": 9600000000,
"agent": "201_1111113",
"billedsec": 10,
"rate": "0.00",
"record": "true",
"filename": "15700821786156624298395_1111113.mp3",
"name": "unknown"
},
{
"_id": "5d95dad104eaac7de3aa20cd",
"to": 9700000000,
"time": 1570101807162,
"from": 9800000000,
"agent": "202_1111113",
"billedsec": 13,
"rate": "0.00",
"record": "true",
"filename": "157008211915747906964588_1111113.mp3",
"name": "unknown"
},
{
"_id": "5d95da8f04eaac7de3aa20b9",
"to": 9900000000,
"time": 1570101739436,
"from": 9100000000,
"agent": "201_1111113",
"billedsec": 15,
"rate": "0.00",
"record": "true",
"filename": "157008209657297373120208_1111113.mp3",
"name": "unknown"
}
],
"code": 200
}

Properties

These are the list of properties and its description

PropertyTypeDescription
totalnumberThe total count of call detail record(cdr) available
cdrJSON arrayThe list of total cdr in detail
_idstringA unique identifier of the call
tonumberThe number of user(agent) received the call
timenumberTimestamp of the call
fromnumberThe number of the call came from
agentstringA unique Id of the user(agent)
billedsecnumberThe duration of call in seconds
ratestringThe call cost of the call
recordstringCall recording is enabled
filenamestringThe file name of the recorded conversation
namestringThe name of the caller

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