Agent Outgoing Missed API
Each agent API request in TeleCMI platform includes agent login token. After getting the agent login token, make a POST request to the below base URL to retrieve the agent outgoing missed call details.
Base URL
Send your POST method request with valid parameters, to the following base URL.
https://piopiy.telecmi.com/v1/agentOutMissed
Required Parameters
These are the required POST method parameters with description
Parameter Name | Type | Description |
---|---|---|
*token | string | Your agent token |
*from | number | The from date and time in timestamp. |
*to | number | The to date and time in timestamp. |
*page | number | The Number of page per 10 record. |
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
{
"token": "xxxx-xxxx-xxxx-xxxx",
"from": 1569911400000,
"to": 1570167249853,
"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
{
"count": 8,
"cdr": [
{
"_id": "5d96c6e920837a1998da13ea",
"to": 9100000000,
"time": 1570162545485,
"from": "103_1111113",
"billedsec": 0,
"rate": "0.0000",
"name": "unknown"
},
{
"_id": "5d96c1b63e23420b5f1fa978",
"to": 9200000000,
"time": 1570161078287,
"from": "103_1111113",
"billedsec": 0,
"rate": "0.0000",
"name": "unknown"
},
{
"_id": "5d96c0113e23420b5f1fa958",
"to": 9300000000,
"time": 1570160648428,
"from": "103_1111113",
"billedsec": 0,
"rate": "0.0000",
"name": "unknown"
},
{
"_id": "5d960e7a20837a1998da0b7f",
"to": 9400000000,
"time": 1570115334213,
"from": "103_1111113",
"billedsec": 0,
"rate": "0.0000",
"name": "unknown"
},
{
"_id": "5d960ecc3e23420b5f1fa2cd",
"to": 9500000000,
"time": 1570115274135,
"from": "103_1111113",
"billedsec": 0,
"rate": "0.0000",
"name": "Adams",
}
],
"code": 200
}
Properties
These are the list of properties and its description
Property | Type | Description |
---|---|---|
count | 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 this call |
to | number | The number of the user(agent) |
time | number | Timestamp of the call |
from | string | A unique Id of the user(agent) |
billedsec | number | The duration of call in seconds |
rate | string | The call cost of the call |
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 agent token, authentication failed |