GET - Get the status details of all agents in a queue's call log

 

Purpose

Use this API to fetch the status information of all agents in a queue's call log. This can be used to correlate the agents' availability against missed or answered queue calls.
 

Note

This api is only available for incoming queue call logs. Status correlation is unavailable for other call types, but can still be fetched using 'statusaudit/list' api if the list of agents, startTime & endTime of the call log are known.

 

Authorization

HeaderKeyDescription
Authorization*Zoho-oauthtoken<space><ACCESS_TOKEN>
Accept*Set to application/json.

Request URL

Method: GET

https://voice.zoho.com/rest/json/zv/metrics/statusaudit/list/log

Scope: ZohoVoice.agents.READ

Parameters:
 

Param Name

Data Type

Description

fromEpoch*

Long

Represents the start timestamp in epoch milliseconds.

toEpoch*

Long

Represents the end timestamp in epoch milliseconds.

logId*

UUID

Represents the UUID of the call log.

queueIds

String

Represents the comma-separated list of queue IDs involved in the call log.

tz*

String

Represents the timezone used to display the results.

Sample Request

Copiedcurl "https://voice.zoho.com/rest/json/zv/metrics/statusaudit/list/log?fromEpoch=1764547200000&toEpoch=1764633600&tz=GMT&logId=8765-afhdg8-87wdsgv" \

Sample Response - Success

Copied{
   "code": "200",
   "log": {
       "response": [
           {
               "ringingOrder": [
                   {
                       "agentId": "3029000003904005",
                       "rings": [
                           {
                               "start_time": 1729251588000,
                               "queueName": "All in One",
                               "agent_name": "aravindan.e5",
                               "agent_number": 3029000003904005,
                               "ringing_time": 0,
                               "is_answered": false,
                               "strategy": "ring-all",
                               "hangup_cause": {
                                   "hangup_cause_description": "The user you are trying to reach is not available.",
                                   "hangupcause": "UNALLOCATED_NUMBER",
                                   "hangup_cause_displayname": "User unreachable"
                               }
                           }
                       ]
                   },
                   {
                       "agentId": "3029000004016005",
                       "rings": [..]
                   },
                   {
                       "agentId": "3029000000002015",
                       "rings": [..]
                   }
               ],
               "answeredAgent": {},
               "queueDetails": {
                   "_queueId": 3029000004016033,
                   "ringtime_in_queue": 60,
                   "queueName": "All in One",
                   "customer_entry_time": 1729251587000,
                   "strategy": "ring-all",
                   "customer_exit_time": 1729251647000
               },
               "agentStatus": [
                   {
                       "hits": [..],
                       "agent_id": "3029000003904005",
                       "agentName": "aravindan.e5"
                   },
                   {
                       "hits": [..],
                       "agent_id": "3029000004016005",
                       "agentName": "aravindan.e3"
                   },
                   {
                       "hits": [..],
                       "agent_id": "3029000000002015",
                       "agentName": "AravindaN1"
                   },
                   {
                       "hits": [..],
                       "agent_id": "3029000000003003",
                       "agentName": "aravindan2"
                   },
                   {
                       "hits": [..],
                       "agent_id": "3029000000005013",
                       "agentName": "aravindan.e4"
                   }
               ]
           }
       ]
   },
   "status": "SUCCESS"
}

Sample Response - Error

Copied{
 "status": "ERROR",
 "code":"ZVTSA002",
 "response":{
     "errorCode": "ZVTSA003",
     "errorDisplay": "This data cannot be displayed. (You do not have permission to view this queue, or it might no longer exist)",
     "errorMessage": "Unable to display data."
  }
}