voice

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.

get/voice/logs

Request

  • Base URL
    https://cpaas.zoho.com/v1.1
  • Auth
    API key in header Authorization

Query parameters

offsetinteger

Zero-based offset for pagination.

limitinteger

Maximum number of log entries to return.

message_idstring uuid

Returns the call logs associated with the specific message id.

status'INITIATED' | 'ANSWERED' | 'CALL_REJECTED' | 'CALL_UNANSWERED' | 'CALL_FAILED' | 'PROCESS_FAILED' | 'UNKNOWN'

Returns the call logs based on the provided call status (case-insensitive).

fromstring

Returns the call logs based on the provided from voice number (with country code).

tostring

Returns the call logs based on the provided recipient number (with country code).

client_referencestring

Returns the call logs based on the provided client reference supplied during the call initiation.

template_keystring

Returns the call logs based on the provided voice template key.

template_aliasstring

Returns the call logs based on the provided voice template alias.

request_idstring

Returns the call logs based on the provided request id returned while calling the Place a call API.

date_fromstring date-time
Example:2026-09-22T00:00:00+05:30

Start of the date range - an ISO 8601 date-time with UTC offset.

date_tostring date-time
Example:2026-09-22T23:59:59+05:30

End of the date range - an ISO 8601 date-time with UTC offset.

Response

Voice call logs retrieved successfully.

statusstring

Example response

{
  "metadata": {
    "count": 10
  },
  "data": [
    {
      "from_country_code": "+1",
      "to_country_code": "+91",
      "process_state": "processed",
      "remote_ip": "10.61.232.23",
      "language": "en",
      "voice_gender": "FEMALE"
    }
  ],
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.