GET - Get ringing order of a call log
 

Purpose

Use this API to get the ringing order for a call log. The response includes the agents who were rung along with their corresponding ring details.

 

Authorization

HeaderKey

Description

Authorization*

Zoho-oauthtoken<space><ACCESS_TOKEN>

Accept*

Set to application/json.

Request URL

Method: GET

https://voice.zoho.com/rest/json/zv/api/agents/onlineStatus

Scope: ZohoVoice.call.READ

Parameters:

Param Name

Data Type

Description

logid*

String

Represents the unique log ID

Sample Request

Copiedcurl --location "https://voice.zoho.com/rest/json/zv/logs/queue/ringingOrder?logid=71f2cf05-310b-4f0b-9d99-c416e8e8c4d2" \
  --header "Authorization: Zoho-oauthtoken 1000.5ce12da4879c08dbcea0c575d4770973.3e6a55695666e19d7ad6685121a7f2fb"

Sample Response - Success

Copied{
  "code": "200",
  "ringingOrder": [
    {
      "_queueId": 58399000000014000,
      "queueName": "Q1",
      "agentHistory": [],
      "error_code": 0,
      "strategy": "ring-all",
      "message": "Please wait while we load the data."
    }
  ],
  "status": "SUCCESS"
}

Sample Response - Error

Copied{
  "code": "200",
  "ringingOrder": [
    {
      "_queueId": -1,
      "agentHistory": [],
      "error_code": 0,
      "message": "Please wait while we load the data."
    }
  ],
  "status": "SUCCESS"
}