Get voice call logs
Returns the agent's voice call logs, newest first, with pagination and filtering by call attributes (status, from/to number), request attributes (client reference, template, request id) and date range. Rate limited to 40 requests per minute.
Endpoint
Request URL
https://cpaas.zoho.com/v1.1/voice/logs Copied!
Request Parameters
- Request Headers
API key of an agent. Send the header as Authorization: Zoho-enczapikey {apiKey}. The agent and account are derived from the key.
- Query Parameters
Zero-based offset for pagination.
Maximum number of log entries to return.
Returns the call logs associated with the specific message id.
Returns the call logs based on the provided call status (case-insensitive).
Returns the call logs based on the provided from voice number (with country code).
Returns the call logs based on the provided recipient number (with country code).
Returns the call logs based on the provided client reference supplied during the call initiation.
Returns the call logs based on the provided voice template key.
Returns the call logs based on the provided voice template alias.
Returns the call logs based on the provided by the request id returned while calling the Place a call API.
Start of the date range - an ISO 8601 date-time with UTC offset.
End of the date range - an ISO 8601 date-time with UTC offset.
Sample Request
curl --request GET \
--url 'https://cpaas.zoho.com/v1.1/voice/logs?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&message_id=SOME_STRING_VALUE&status=SOME_STRING_VALUE&from=SOME_STRING_VALUE&to=SOME_STRING_VALUE&client_reference=SOME_STRING_VALUE&template_key=SOME_STRING_VALUE&template_alias=SOME_STRING_VALUE&request_id=SOME_STRING_VALUE&date_from=2026-09-22T00:00:00+05:30&date_to=2026-09-22T23:59:59+05:30' \
--header 'Authorization: REPLACE_KEY_VALUE'Response Parameters
- HTTP code 200
Response Body - application/json
Response containing a page of voice call logs.
Show Sub-Attributes
Show Sub-Attributes
A voice call log entry.
Unique identifier of the call.
Identifier of the send request.
Client reference supplied at send time, if any.
Key of the voice template used, for template calls.
Identifier of the voice agent.
Caller number, without the country code.
Country calling code of the caller number.
Recipient number, without the country code.
Country calling code of the recipient number.
Call status.
Processing state of the request.
IP address the send request was made from.
Text-to-speech language of the call.
Text-to-speech voice of the call.
Whether a recording of the call is available.
When the send request was received (ISO 8601).
When the call started (ISO 8601).
When the call was answered (ISO 8601). Present only for answered calls.
When the call ended (ISO 8601).
Duration in seconds.
- HTTP code 401
Response Body - application/json
Error response wrapper. The top-level code identifies the error class: TM_3301 bad syntax (400), TM_4001 access denied (401), TM_3601 request denied (403), TM_3501 unprocessable entity (422).
Show Sub-Attributes
Show Sub-Attributes
Show Sub-Attributes
A single validation or denial detail inside the error envelope.
Detail-level error code, e.g. VOI_102 (invalid phone number), VOI_104 (caller id required), VOI_105 (template or message content required), VOI_106 (required merge tags missing), MTR_107 (template not found), VOI_207 (from number not associated with the sending agent), SERR_110 (required parameter missing), SERR_157 (invalid API token).
The field the detail refers to, when applicable (e.g. from, to, merge_info).
The offending value, or for VOI_106 the comma-separated list of missing merge tag names.
Identifier of the failed request, when available.
Sample Response: HTTP 200
{
"metadata": {
"offset": 0,
"count": 1
},
"data": [
{
"message_id": "7ed0c6c0-b670-11f1-8810-3ed350183096",
"request_id": "7ed0c6c0-b670-11f1-8810-3ed350183096",
"client_reference": "order-confirm-1001",
"template_key": "794dc9c1-b268-11f1-bed6-b6d94062a427",
"agent_id": "3cca5d24c08773",
"from": "4155550142",
"from_country_code": "+1",
"to": "9876543210",
"to_country_code": "+91",
"status": "CALL_UNANSWERED",
"process_state": "processed",
"language": "en",
"voice_gender": "FEMALE",
"is_batch_request": false,
"is_call_recording_available": false,
"request_time": "2026-09-22T15:59:30+05:30",
"start_time": "2026-09-22T15:59:30+05:30",
"end_time": "2026-09-22T15:59:44+05:30",
"time_taken": 13
}
],
"status": "success"
}
Sample Response: HTTP 401
{
"error": {
"code": "TM_4001",
"details": [
{
"code": "SERR_157",
"message": "Invalid API Token found"
}
],
"message": "Access Denied"
}
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.