Outgoing Missed
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 missed call details.
Base URL
Send your POST method request with valid parameters, to the following base URL.
https://rest.telecmi.com/v2/out_missed
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": 10
}
Required Parameters
These are the required POST method parameters with a description.
Parameter Name | Type | Description |
---|---|---|
*appid | number | Your app id. |
*secret | string | Your app secret. |
start_date | number | The timestamp of start date and time in UTC timezone. By default the timestamp will be last 24 hours from current time. |
end_date | number | The timestamp of end date and time in UTC timezone. By default the timestamp will be current time. |
page | number | As a default, the first page will be displayed, and each page will have 10 records. |
limit | number | The 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": 275,
"cdr": [
{
"cmiuid": "40bed6c9-14f1-435b-b4a3-224bd22e5241",
"duration": 0,
"agent": "208_1111112",
"billedsec": 0,
"rate": 0,
"name": "unknown",
"from": "919200000001",
"to": 919200000000,
"time": 1654508747170
},
{
"cmiuid": "906cd491-680a-4ee1-a75a-43f07878b61d",
"duration": 0,
"agent": "208_1111112",
"notes": [
{
"msg": "RNR",
"date": 1654338714902,
"agent": "204_1111112"
}
],
"billedsec": 0,
"rate": 0,
"name": "unknown",
"from": "919200000002",
"to": 919200000003,
"time": 1654508701320
},
{
"cmiuid": "bcc0e3b8-9dfc-45d7-a1c8-6a8245519a27",
"duration": 0,
"agent": "208_1111112",
"billedsec": 0,
"rate": 0,
"name": "unknown",
"from": "919200000004",
"to": 919200000005,
"time": 1654508633765
},
{
"cmiuid": "496ce362-4b97-46f7-9a9b-b8b0e52ea6cc",
"duration": 0,
"agent": "208_1111112",
"billedsec": 0,
"rate": 0,
"name": "unknown",
"from": "919200000006",
"to": 919200000007,
"time": 1654508609271
},
{
"cmiuid": "b7c9afdd-43a1-4ace-8e61-51b1376ebf94",
"duration": 0,
"agent": "204_1111112",
"billedsec": 0,
"rate": 0,
"name": "unknown",
"from": "919200000008",
"to": 919200000009,
"time": 1654338339387
}
],
"code": 200
}
Properties
This is the list of properties and their descriptions.
Property | Type | Description |
---|---|---|
count | number | The total count of call detail record(cdr). |
cdr | JSON array | The list of total cdr in detail. |
cmiuid | string | A unique identifier for this call. |
duration | number | The total duration of the call in seconds when it was initiated. |
notes | JSON array | The entire notes information of the caller or calle. |
agent | string | A unique ID of the user. |
msg | string | The notes information of the caller or calle. |
date | number | A timestamp indicates the time the notes were added in the UTC timezone. |
agent | string | The user ID for the added notes. |
billedsec | number | The total duration of the call in seconds when it was missed. |
rate | number | The calling cost of the phone call. |
name | string | The name of the caller. |
from | string | Your DID number. |
to | number | The call was made using this number. |
time | number | A timestamp indicates the time the call was missed in the UTC timezone. |
HTTP status codes
The TeleCMI API platform represents the following status code to identify the errors.
Status code | Status code | Description |
---|---|---|
200 | OK | There was a successful response to your request. |
404 | Error | Authentication Failed. |
400 | Error | Parameter missing. |