Skip to main content

VoiceMail API

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 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 NameTypeDescription
*appidnumberYour app ID
*secretstringYour app secret
start_datenumberThe timestamp of start date and time in UTC timezone. By default the timestamp will be last 24 hours from current time.
end_datenumberThe timestamp of end date and time in UTC timezone. By default the timestamp will be current time.
pagenumberThe Number of page per 10 record. By default the page is 1.
limitnumberThe Number of record for request, By default the limit is 10. Maximum limit is 20.
The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

"appid": 1111113,
"secret": "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

"count": 3,
"voicemail": [
"time": 1570157223000,
"from": 9100000000,
"voicename": "157013743669294846865923_919100000000.mp3"
"time": 1570114837000,
"from": 9200000000,
"voicename": "157009505096485983954758_919200000000.mp3"
"time": 1570114312000,
"from": 9300000000,
"voicename": "157009452516312171051293_919300000000.mp3"
"code": 200


These are the list of properties and its description

countnumberThe total count of call detail record(cdr) available
voicemailJSON arrayThe list of total voicemail in detail
timenumberTimestamp of the voicemail in UTC timezone
fromnumberThe phone number of the caller
voicenamestringThe 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 typeDescription
200OKWe received the request
401ErrorInvalid user token, authentication failed
400ErrorParameter missing