User Incoming Missed API
Each user API request in TeleCMI platform includes user login token. After getting the user login token, make a POST request to the below base URL to retrieve the user incoming missed call details.
Base URL
Send your POST method request with valid parameters, to the following base URL.
https://rest.telecmi.com/v2/user/missed
Required Parameters
These are the required POST method parameters with description
Parameter Name | Type | Description |
---|---|---|
*token | string | Your user token |
*from | number | The timestamp of from date and time in UTC timezone. |
*to | number | The timestamp of to date and time in UTC timezone. |
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. Maximum 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": 6,
"cdr": [
{
"cmiuid": "5d96b4a920837a1998da109d",
"duration": 0,
"notes": [
{
"msg": "Enquired about products",
"date": 1655389002028,
"agent": "101_2222223"
}
],
"time": 1570157877427,
"from": 9200000000,
"billedsec": 0,
"rate": 0,
"name": "unknown"
},
{
"cmiuid": "5d96b4253e23420b5f1fa7d0",
"duration": 0,
"time": 1570157600553,
"from": 9300000000,
"billedsec": 0,
"rate": 0,
"name": "unknown"
},
{
"cmiuid": "5d96b40c3e23420b5f1fa7cd",
"duration": 0,
"time": 1570157396359,
"from": 9300000000,
"billedsec": 0,
"rate": 0,
"name": "unknown"
},
{
"cmiuid": "5d960a893e23420b5f1fa28f",
"duration": 0,
"time": 1570114025942,
"from": 9400000000,
"billedsec": 0,
"rate": 0,
"name": "unknown"
},
{
"cmiuid": "5d9606a020837a1998da0b02",
"duration": 0,
"time": 1570113324624,
"from": 9500000000,
"billedsec": 0,
"rate": 0,
"name": "unknown"
}
],
"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 |
cmiuid | string | A unique identifier of this call |
duration | number | The duration of this call |
notes | JSON array | The entire notes information of the caller or calle |
msg | string | The notes information of the caller or calle |
date | number | Timestamp of the added notes in UTC timezone |
agent | string | The user ID for the added note |
time | number | Timestamp of the call in UTC timezone |
from | number | The number the call came from |
billedsec | number | The duration of call in seconds |
rate | number | 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 type | Description |
---|---|---|
200 | OK | We received the request |
404 | Error | Invalid user token, Failed to authenticate token |
400 | Error | Parameter missing, Parameter limit lesser then equals 10 |