Skip to main content

Outgoing Answered

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

Base URL

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

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

Sample JSON Request

Below is the following sample JSON POST method request.

{
"appid": 1111112,
"secret": "xxxx-xxxx-xxxx-xxx",
"start_date": 1649238593000,
"end_date": 1654509008000,
"page": 1,
"limit": 5
}

Required Parameters

These are the required POST method parameters with a description.

Parameter NameTypeDescription
*appidnumberYour app id.
*secretstringYour app secret.
start_datenumberThe timestamp of start date and time in UTC timezone. By default the timestamp will be last 24 hours from current time.
end_datenumberThe timestamp of end date and time in UTC timezone. By default the timestamp will be current time.
pagenumberAs a default, the first page will be displayed, and each page will have 10 records.
limitnumberThe number of records per request is 10 by default limit, but can be increased to a maximum limit of 20.
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.

{
"count": 425,
"cdr": [
{
"cmiuid": "bdd91865-34a4-4b9b-b7c0-eb4b0da7c83e",
"duration": 34,
"agent": "208_1111112",
"notes": [
{
"msg": "Interested in Product B",
"date": 1654508655024,
"agent": "208_1111112"
}
],
"billedsec": 31,
"filename": "1654508655470066682125604_1111112.mp3",
"rate": 0.0231,
"record": "true",
"name": "unknown",
"from": "919100000000",
"to": 918100000000,
"time": 1654508655024
},
{
"cmiuid": "058a1f8d-c370-48df-bef8-92ffd814617c",
"duration": 5,
"agent": "202_1111112",
"notes": [
{
"msg": "Interested in Product A",
"date": 1654507445031,
"agent": "202_1111112"
}
],
"billedsec": 4,
"filename": "1654507445031_10000167205_202_1111112.mp3",
"rate": 0.023,
"record": "true",
"name": "unknown",
"from": "442000000000",
"to": 442000000001,
"time": 1654507445031
},
{
"cmiuid": "a6dcd717-e920-4ea5-9b53-98b586b462c1",
"duration": 4,
"agent": "202_1111112",
"billedsec": 3,
"filename": "1654506295679_10021751625_202_1111112.mp3",
"rate": 0.023,
"record": "true",
"name": "unknown",
"from": "442000000002",
"to": 442000000003,
"time": 1654506295679
},
{
"cmiuid": "dcbaf6ed-461c-4405-96c3-51126cd600fe",
"duration": 7,
"agent": "204_1111112",
"notes": [
{
"msg": "Not Interested",
"date": 1654338714902,
"agent": "204_1111112"
}
],
"billedsec": 6,
"filename": "1654338714902_10000907009_204_1111112.mp3",
"rate": 0.675,
"record": "true",
"name": "unknown",
"from": "919200000000",
"to": 19170000000,
"time": 1654338714902
},
{
"cmiuid": "5e6c3fb6-65ab-4c7f-8848-c9dca2a81dcc",
"duration": 56,
"agent": "204_1111112",
"billedsec": 43,
"filename": "1654338376713400206630069_1111112.mp3",
"rate": 7.485,
"record": "true",
"name": "unknown",
"from": "919300000000",
"to": 919400000000,
"time": 1654338376713
}
],
"code": 200
}

Properties

This is the list of properties and their descriptions.

PropertyTypeDescription
countnumberThe total count of call detail record(cdr).
cdrJSON arrayThe list of total cdr in detail.
cmiuidstringA unique identifier for this call.
durationnumberThe total duration of the call in seconds when it was initiated.
agentstringA unique ID of the user.
notesJSON arrayThe entire notes information of the caller or calle.
msgstringThe notes information of the caller or calle.
datenumberA timestamp indicates the time the notes were added in the UTC timezone.
agentstringThe user ID for the added notes.
billedsecnumberThe total duration of the call in seconds when it was answered.
filenamestringThe file name of the recorded conversation.
ratenumberThe calling cost of the phone call.
recordstringIf the record is enabled, it shows the status as true.
namestringThe name of the caller.
fromstringYour DID number.
tonumberThe call was made using this number.
timenumberA timestamp indicates the time the call was answered in the UTC timezone.

HTTP status codes

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

Status codeStatus codeDescription
200OKThere was a successful response to your request.
404ErrorAuthentication Failed.
400ErrorParameter missing.