VoiceMail API
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 voicemail details.
Base URL
Send your POST method request with valid parameters, to the following base URL.
https://piopiy.telecmi.com/v1/voicemail
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-xxxx","start_date": 1569911400000,"end_date": 1570167249853,"page": 1}
Sample Response
If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below
{"total": 3,"voicemail": [{"_id": "5d96b2b03e23420b5f1fa7ab","time": 1570157223000,"from": 9100000000,"voicename": "157013743669294846865923_919100000000.mp3"},{"_id": "5d960d1a3e23420b5f1fa2b7","time": 1570114837000,"from": 9200000000,"voicename": "157009505096485983954758_919200000000.mp3"},{"_id": "5d960b103e23420b5f1fa29a","time": 1570114312000,"from": 9300000000,"voicename": "157009452516312171051293_919300000000.mp3"}],"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 |
voicemail | JSON array | The list of total voicemail in detail |
_id | string | A unique identifier of this call |
time | number | Timestamp of the call |
from | number | The number of the call came from |
voicename | string | The file name of the voicemail or recorded conversation |
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 |