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.

https://rest.telecmi.com/v2/voicemail

Required Parameters

These are the required POST method parameters with 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	The Number of page per 10 record. By default the page is 1.

Note

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
}

Properties

These are the list of properties and its description

Property	Type	Description
count	number	The total count of call detail record(cdr) available
voicemail	JSON array	The list of total voicemail in detail
time	number	Timestamp of the voicemail in UTC timezone
from	number	The phone number of the caller
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 type	Description
200	OK	We received the request
401	Error	Invalid user token, authentication failed
400	Error	Parameter missing