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.


Required Parameters

These are the required POST method parameters with description

Parameter NameDescription
appidYour app ID
tokenYour app secret
start_dateThe from date and time in timestamp
end_dateThe to date and time in timestamp, default current time stamp
pageThe Number of page per record 10 and default value of page 1
limitThe Number of record for request, default 10

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


These are the list of properties and its description

totalThe total count of call detail record(cdr) available
voicemailThe list of total voicemail in detail
_idA unique identifier of this call
timeTimestamp of the call
fromThe number of the call came from
voicenameThe file name of the voicemail or recorded conversation

HTTP status codes

TeleCMI API platform represents the following status code to identity the errors.

Status codeStatus codeDescription
200OKWe received the request
404ErrorInvalid app id or secret, authentication failed