Outgoing 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 outgoing answered call details.
Base URL
Send your POST method request with valid parameters, to the following base URL.
https://piopiy.telecmi.com/v1/outanswered
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 . |
page | number | The Number of page per 10 record. By default the page is 1. |
limit | number | The 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": 1570559400000,
"end_date": 1570642200000,
"page": 1,
"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": 3,
"cdr": [
{
"_id": "5d9df5b97a2b952710b030dd",
"to": 9100000000,
"time": 1570633217848,
"from": "209_1111113",
"billedsec": 17,
"rate": "0.6",
"record": "true",
"filename": "157063321784855021379679261_1111113.mp3",
"name": "unknown"
},
{
"_id": "5d9df5097a2b952710b030d8",
"to": 9200000000,
"time": 1570633054497,
"from": "208_1111113",
"billedsec": 3,
"rate": "0.6",
"record": "true",
"filename": "157063305449713703081057884_1111113.mp3",
"name": "unknown"
},
{
"_id": "5d9df556362b8f1430593411",
"to": 9300000000,
"time": 1570632951992,
"from": "206_1111113",
"billedsec": 30,
"rate": "0.6",
"record": "true",
"filename": "157063295199223390097444834_1111113.mp3",
"name": "unknown"
}
],
"code": 200
}
Properties
These are the list of properties and its description
Property | Type | Description |
---|---|---|
total | number | The total count of call detail record(cdr) available |
cdr | JSON array | The list of total cdr in detail |
_id | string | A unique identifier of the call |
to | number | The number the call was made to |
time | number | Timestamp of the call |
from | number | The number of the call came from |
agent | string | A unique Id of the user(agent) |
billedsec | number | The duration of call in seconds |
rate | string | The call cost of the call |
record | string | Call recording is enabled |
filename | string | The file name of the recorded conversation |
name | string | The name of the caller |
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 |