Callback
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 callback list.
Base URL
Send your POST method request with valid parameters, to the following base URL.
https://rest.telecmi.com/v2/callback
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": 1636615799000,
"to": 1636702199000,
"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
{
"code": 200,
"count": 1,
"cdr": [
{
"_id": "618e17aab5abcd0d0f4b0746",
"from": 9200000000,
"time": 1636702119000
}
]
}
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 |
from | number | The number the call came from |
time | number | Timestamp of the call in UTC timezone. |
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 |