GET - Get all queues

Purpose

Use this API to get all queues of your organization.

Authorization

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

Scope

*All APIs are accessible under zohovoice.queues.ALL scope.

OAuth Doc

Request URL

Method: GET

https://voice.zoho.com/rest/json/zv/api/queues

Scope: zohovoice.queues.READ

Parameters:

Param Name	Data Type	Description
from*	Integer	Represents the starting index for retrieving records.
offset*	Integer	Represents the number of records to be returned.
queueid	Long	Represents the queue ID to get single queue detail.
searchText	String	Represents the keyword used to search queue profile. The value is matched against the queue name or queue email ID.

Sample Request

Copiedcurl "https://voice.zoho.com/rest/json/zv/api/groups" \
-X GET \
-H "Authorization:Zoho-oauthtoken *****"

Sample Response - Success

Copied{
 "code": "200",
 "queues": [
   {
     "name": "TestQ",
     "queueWaitMusic": {
       "mode": "audio",
       "audioId": "",
       "enableDefaultAnnouncements": true
     },
     "emailId": "john@zylker.com",
     "enableDefaultAnnouncements": true,
     "id": "2069000000407011",
     "queueStrategy": "ring-progressively"
   },
   {
     "name": "Bulk Add",
     "queueWaitMusic": {
       "mode": "audio",
       "audioId": "",
       "enableDefaultAnnouncements": true
     },
     "enableDefaultAnnouncements": true,
     "id": "2069000001269159",
     "queueStrategy": "top-down"
   },
   {
     "name": "queueTestNew",
     "queueWaitMusic": {
       "mode": "audio",
       "audioId": "",
       "enableDefaultAnnouncements": true
     },
     "enableDefaultAnnouncements": true,
     "id": "2069000000117023",
     "queueStrategy": "ring-progressively"
   }
 ],
 "status": "SUCCESS"

Sample Response - Error

Copied{
   "code": "<App Error Code>",
   "message": "<Error Message>",
   "status": "ERROR"
}