POST - Schedule to get batch call log's recording/voicemail

 

Purpose

Use this API to create a schedule and get the batch call log's recording and voicemail in the given email ID.

 

Note

  • The same API is used for getting voicemail and recording files. Set boolean value to the below mentioned respective keys to get respective files.
  • Threshold for this url - 30 calls per min and lock period is 10 min.
  • Maximum download size is 50GB. It will be downloaded in 10 parts, each containing a 5 GB batch will send to user mail if send Mail param sets 'true' and also in the ZohoVoice Notification centre.
  • Maximum file size limit is 10000 files.

 

Authorization

HeaderKey

Description

Authorization*

Zoho-oauthtoken<space><ACCESS_TOKEN>

Request URL

Method: POST

https://voice.zoho.com/rest/json/zv/logs/recording/batch/download

Scope: ZohoVoice.call.CREATE

Parameters: 

Param NameData TypeDescription

fromDate

String

Represents the start date-time filter in yyyymmdd HH:MM format.

 

Example: 2022-09-22 00:00

toDate

String

Represents the end date-time filter in yyyymmdd HH:MM format.

 

Example: 2022-09-25 10:00

agent

Only Numbers

Represents the agent ID used to filter call logs. 

Accepts a single value or comma-separated values.

 

Example: 612000000,612000001

callType

String

Represents the call type used to filter call logs.

 

Possible values:

  • Incoming

  • Outgoing

  • Missed

  • Bridged

  • Forward

 

Note: Default value is ALL call types.

numberIds

Only Numbers

Represents the number ID used to filter call logs. 

Accepts a single value or comma-separated values.

userNumber

Only Numbers

Represents the number used to filter by number and country. 

You can specify just the country code or include it with the full number. 

Set the isAllCountry key to false when providing a specific country code or number.

 

Example:
userNumber: 44
isAllCountry: false

isAllCountry

Boolean

Represents whether call logs are retrieved without applying a country filter. 

When set to true, country-based filtering is not applied.

isVoiceMail

Boolean

Represents whether call logs with voicemail are retrieved.

When set to true, only call logs with voicemail are returned.

isRecording

Boolean

Represents whether call logs with recordings are retrieved.

When set to true, only call logs with recordings are returned.

 

Note: If both isVoiceMail and isRecording are set to false, all call recordings are returned.

password

SafeString

Represents the password configuration. 

If a value is provided, the file is downloaded as a ZIP file.

departmentId

Only Numbers

Represents the department ID used to filter call logs. Accepts a single value or comma-separated values.

 

Example: 612000000, 612000000

groupIds

Only Numbers

Represents the queue ID used to filter call logs. Accepts a single value or comma-separated values.

 

Example:  61200000,612000000

sendMail

Boolean

Represents whether the ZIP download link is sent to the user’s email.

recordingFileNames

String

Represents single or multiple comma-separated recording file names to download.

 

Example: recordingFileNames=1469501_1664188275111194_1469501.wav,14695095_1664188184571227_14695012.wav

 

Sample Request

Copiedcurl -X POST "https://voice.zoho.com/rest/json/zv/logs/recording/batch/download" \
  -H "Authorization: Zoho-oauthtoken 1000.590c5a028e890914c9e3930dbc91cadf.1f2f5895bc322662d51366a61ae4da9a" \
  -d "fromDate=2025-12-04 00:00" \
  -d "toDate=2025-12-04 23:59" \
  -d "isRecording=true" \
  -d "sendMail=true"

Sample Response - Success

Copied{
  "code": "200",
  "isScheduled": false,
  "status": "SUCCESS"
}