---
title: "Get voice call logs"
method: GET
path: "/voice/logs"
tags: ["voice"]
---

# Get voice call logs

`GET /voice/logs`

## Request

- Base URL: `https://cpaas.zoho.com/v1.1`
- URL: `https://cpaas.zoho.com/v1.1/voice/logs`
- Auth: API key in header `Authorization`

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.

## Query parameters

- `offset` integer
- `limit` integer
- `message_id` string, uuid
- `status` 'INITIATED' | 'ANSWERED' | 'CALL_REJECTED' | 'CALL_UNANSWERED' | 'CALL_FAILED' | 'PROCESS_FAILED' | 'UNKNOWN'
- `from` string
- `to` string
- `client_reference` string
- `template_key` string
- `template_alias` string
- `request_id` string
- `date_from` string, date-time
- `date_to` string, date-time

## Response `200`

Voice call logs retrieved successfully.

- VoiceLogsResponse: Response containing a page of voice call logs.
  - `metadata` object
    - `offset` integer
    - `count` integer: Number of entries in this page.
  - `data` VoiceLogEntry[]
    - `message_id` string, uuid: Unique identifier of the call.
    - `request_id` string: Identifier of the send request.
    - `client_reference` string: Client reference supplied at send time, if any.
    - `template_key` string, uuid: Key of the voice template used, for template calls.
    - `agent_id` string: Identifier of the voice agent.
    - `from` string: Caller number, without the country code.
    - `from_country_code` string: Country calling code of the caller number.
    - `to` string: Recipient number, without the country code.
    - `to_country_code` string: Country calling code of the recipient number.
    - `status` 'INITIATED' | 'ANSWERED' | 'CALL_REJECTED' | 'CALL_UNANSWERED' | 'CALL_FAILED' | 'PROCESS_FAILED' | 'UNKNOWN': Call status.
    - `process_state` string: Processing state of the request.
    - `remote_ip` string: IP address the send request was made from.
    - `language` string: Text-to-speech language of the call.
    - `voice_gender` string: Text-to-speech voice of the call.
    - `is_batch_request` boolean
    - `is_call_recording_available` boolean: Whether a recording of the call is available.
    - `request_time` string: When the send request was received (ISO 8601).
    - `start_time` string: When the call started (ISO 8601).
    - `answered_time` string: When the call was answered (ISO 8601). Present only for answered calls.
    - `end_time` string: When the call ended (ISO 8601).
    - `time_taken` integer: Duration in seconds.
  - `status` string

## Other responses

- `401`: Access Denied (`TM_4001`) - missing or invalid API token.

---

[API](https://skmtc.dev/zoho/apis/zoho-cpaas.md) - [All operations](https://skmtc.dev/zoho/apis/zoho-cpaas/llms.txt) - [OpenAPI document](https://skmtc.dev/zoho/apis/zoho-cpaas/revisions/f0858a38e8b0?raw)