Queues API

Queues CRUD APIs

Authorization

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

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

OAuth Doc

Create Queue

Use this API to create a queue.

POST https://voice.zoho.com/rest/json/zv/api/groups

Scope: zohovoice.queues.CREATE

Parameters:

Param Name

DataType

Description

data *

JSONObject

queue data as json.

name and members, isBulk, config keys are mandatory.

JSON Schema:

{

"members"*: [

"[AGENT_ID]"

"extension":9999,

"emailNotificationConfig": "3",

"name"*: "Customer Support",

"emailId": "QUEUE EMAILID to send notification to queue emails",

"queueWaitMusic": {

"audioId": "",

"enableDefaultAnnouncements": true

"qapId": "QUEUE AUDIO PROFILE ID",
"isBulk"*:false,

"config"*: {

"mwtformat": "seconds",

"mwtwnaformat": "seconds",

"max-wait-time-with-no-agent": 60,

"max-wait-time": 60,

"strategy": "top-down" //top-down,ring-progressively,round-robin,ring-all

}

Data JSON:

Key	Datatype	Description
members *	JSON Array of Long	eg.[AGENT_ID1,AGENT_ID2]
extension	Integer	max four digits allowed
emailNotificationConfig	Integer	Do not notify -0, All Missed calls -1, Missedcalls with voicemail -2, All Calls - 3
name *	String	name of the queue
emailId	String	email ID for queue call missed notification
queueWaitMusic	JSONObject	{ "audioId": "", "enableDefaultAnnouncements": true }
qapId	Long	Queue audio profile ID
isBulk *	boolean	false
config *	JSONObject	Queue configuration eg:{ "mwtformat": "seconds", "mwtwnaformat": "seconds", "max-wait-time-with-no-agent": 60, "max-wait-time": 60, "strategy": "top-down" } strategy possible values are top-down, ring-progressively, round-robin, and ring-all

Response

SUCCESS

{

"code":"200",

"groupId":4061000001205001,

"status": "SUCCESS"

}

FAILURE

{

"code": "<App Error Code>",

"message": "<Error Message>",

"status": "ERROR"

}

Update Queue

Use this API to update a queue.

PUT https://voice.zoho.com/rest/json/zv/api/groups

Scope: zohovoice.queues.UPDATE

Parameters:

Param Name

DataType

Description

data *

JSONObject

queue data as json.

name and members, isBulk, config, groupid keys are mandatory.

JSON example:

{

"name":"Sales Queue",

"emailId":"queue1@zoho.com",

"qapId":"2069000002486021",

"members":[

"2069000000005011",

"2069000000044027"

"emailNotificationConfig":"1",

"queueWaitMusic":{

"mode":"audio",

"audioId":"",

"enableDefaultAnnouncements":false

"isBulk":false,

"extension":"9999",

"config":{

"max-wait-time":60,

"max-wait-time-with-no-agent":60,

"strategy":"top-down",

"mwtformat":"seconds",

"mwtwnaformat":"seconds"

"groupid":"2069000000250017"

}

agentChanged

Boolean

Set True, if members value order changed

Data JSON:

Key	Datatype	Description
members *	JSONArray of Long	eg. [AGENT_ID1,AGENT_ID2]
extension	Integer	max four digits allowed
emailNotificationConfig	Integer	Do not notify -0, All Missed calls -1, Missedcalls with voicemail -2, All Calls - 3
name *	String	name of the queue
emailId	String	email ID for queue call missed notification
queueWaitMusic	JSONObject	{ "audioId": "", "enableDefaultAnnouncements": true }
qapId	Long	Queue audio profile ID
isBulk *	boolean	false
config *	JSONObject	Queue configuration eg:{ "mwtformat": "seconds", "mwtwnaformat": "seconds", "max-wait-time-with-no-agent": 60, "max-wait-time": 60, "strategy": "top-down" } strategy possible values are top-down,ring-progressively,round-robin,ring-all
groupid	Long	unique ID of the queue

Response

SUCCESS

{

"code":"200",

"groupId":4061000001205001,

"status": "SUCCESS"

}

FAILURE

{

"code": "<App Error Code>",

"message": "<Error Message>",

"status": "ERROR"

}

Delete Queue

Use this API to delete queues.

DELETE https://voice.zoho.com/rest/json/zv/api/groups

Scope: zohovoice.queues.DELETE

Parameters:

Param Name	DataType	Description
groupIds *	String	Comma-separated unique ID

Response

SUCCESS

{

"code":"200",

"message":"success",

"status": "SUCCESS"

}

FAILURE

{

"code": "<App Error Code>",

"message": "<Error Message>",

"status": "ERROR"

}

Get All Queues

Use this API to get contact statuses.

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

Scope: zohovoice.queues.READ

Parameters:

Param Name	DataType	Description
from *	int	Start index
offset *	int	no of records
queueid	Long	To get a single queue detail
searchText	String	Search with queue name or queue email ID

Response

SUCCESS

{

"code": "200",

"queues": [

{

"name": "TestQ",

"queueWaitMusic": {

"mode": "audio",

"audioId": "",

"enableDefaultAnnouncements": true

"emailId": "divya.e+queue@zohotest.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"

}

FAILURE

{

"code": "<App Error Code>",

"message": "<Error Message>",

"status": "ERROR"

}

Create Queue Audio Profile

Use this API to create a queue audio profile.

POST https://voice.zoho.com/rest/json/zv/api/queueaudioprofile

Scope: zohovoice.queues.CREATE

Parameters:

Param Name

DataType

Description

data *

JSONObject

queue data as json.

name keys is mandatory.

JSON Schema:

{

"name": "US Support - Main ",

"queueAudioConfig": {

"announcementInterval": "70",

"welcomeAnnouncement": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "Welcome greeting"

"positionAnnouncement": {

"offline": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "Agents are offline now."

"busy": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "Agents are busy now"

"waiting": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "We are connecting to agent. please hold on."

}

"specialAnnouncement": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "Custom announcement"

"queueExit": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "Queue Breakout"

}

Response

SUCCESS

{

"code":"200",

"qapId":"2069000002486011",

"status":"SUCCESS"

}

FAILURE

{

"code": "<App Error Code>",

"message": "<Error Message>",

"status": "ERROR"

}

Update Queue Audio profile

Use this API to update a queue.

PUT https://voice.zoho.com/rest/json/zv/api/groups

Scope: zohovoice.queues.UPDATE

Parameters

Param Name

DataType

Description

data *

JSONObject

queue data as json.

name keys is mandatory.

JSON Schema:

{

"name": "US Support - Main ",

"qapId":"2069000002486011",

"queueAudioConfig": {

"announcementInterval": "70",

"welcomeAnnouncement": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "Welcome greeting"

"positionAnnouncement": {

"offline": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "Agents are offline now."

"busy": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "Agents are busy now"

"waiting": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "We are connecting to agent. please hold on."

}

"specialAnnouncement": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "Custom announcement"

"queueExit": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": "Queue Breakout"

}

Response

SUCCESS

{

"code":"200",

"qapId":4061000001205001,

"status": "SUCCESS"

}

FAILURE

{

"code": "<App Error Code>",

"message": "<Error Message>",

"status": "ERROR"

}

Delete Queue Audio profile

Use this API to delete queues.

DELETE https://voice.zoho.com/rest/json/zv/api/queueaudioprofile

Scope: zohovoice.queues.DELETE

Parameters:

Param Name	DataType	Description
qapIds *	String	Comma-separated unique ID

Response

SUCCESS

{

"queueAudioProfiles": [

{

"name": "US Support",

"id": "2069000002486011",

"status": "SUCCESS"

}

"code": "200",

"status": "SUCCESS"

}

FAILURE

{

"code": "<App Error Code>",

"message": "<Error Message>",

"status": "ERROR"

}

Get All QueueAudioProfile

Use this API to get contact statuses.

GET https://voice.zoho.com/rest/json/zv/api/queueaudioprofile?searchText=&from=0&offset=50

Scope: zohovoice.queues.READ

Response

SUCCESS

{

"queueAudioProfiles": [

{

"updatedTime": 1737957929919,

"updatedBy": "sales@zoho.com",

"name": "US Support - Main ",

"id": "2069000002486021"

}

"code": "200",

"status": "SUCCESS"

}

FAILURE

{

"code": "<App Error Code>",

"message": "<Error Message>",

"status": "ERROR"

}

Get Single QueueAudioProfile

Use this API to get contact statuses.

GET https://voice.zoho.com/rest/json/zv/api/queueaudioprofile/2069000002486021

Scope: zohovoice.queues.READ

Response

SUCCESS

{

"code": "200",

"queueAudioProfile": {

"updatedTime": 1737957929919,

"queueAudioConfig": {

"welcomeAnnouncement": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": ""

"positionAnnouncement":{

"offline": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": ""

"waiting": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": ""

"busy": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": ""

}

"queueExit": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": ""

"announcementInterval": "70",

"specialAnnouncement": {

"mode": "text",

"audioVoice": "2",

"audioId": "",

"audioLanguage": "en-US",

"message": ""

}

"updatedBy": "sales@zoho.com",

"name": "US Support - Main ",

"id": "2069000002486021"

"status": "SUCCESS"

}

FAILURE

{

"code": "<App Error Code>",

"message": "<Error Message>",

"status": "ERROR"

}

Create. Review. Publish.

Write, edit, collaborate on, and publish documents to different content management platforms.

Get Started Now

Access your files securely from anywhere

Zoho CRM Training Programs

Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

Redefine the way you work

with Zoho Workplace

Start your free trial

Zoho DataPrep Personalized Demo

If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

Create, share, and deliver

beautiful slides from anywhere.

Get Started Now

Zoho Sign now offers specialized one-on-one training for both administrators and developers.

BOOK A SESSION

Zoho Workerly Home
Forums
Connect With Us:

Zoho Recruit Home
Forums
Connect With Us:

Start tracking your website metrics today

Use PageSense to understand what your visitors are looking for, how they are behaving, and where they are facing problems on your website.

Ready to improve your website's performance?

Install the PageSense code snippet on your site in a matter of minutes and start collecting in-depth data about the website visitors to grow your business.

Track and measure every business goal

Set up goals in PageSense to measure every single action performed by visitors on your website like button or link clicks, form submissions, and page engagements.

Understand the customer journey on your website

Create funnels in PageSense to quickly see which pages visitors use to enter your website, where they navigate to next, and which pages they decide to leave without converting.

Visualize your visitor's behavior with color codes

Set up heatmaps in PageSense to see where users have clicked more, how far they've scrolled, and on which parts of a page they've spent the most time using color-coded patterns in reports.

Measure customer engagement with your web forms

Use form analytics in PageSense to see how people interact with different fields in your form, whether they complete the form successfully or not, and where exactly they drop out on your form.

Record real visitor interactions on your website

Use session recordings in PageSense to watch a video of all the visitor actions performed on your website including the pages they navigate, the buttons they click, the UX issues they face, and more.

Test and optimize webpages for better conversions

Run A/B or Split URL tests in PageSense to figure out which version of your web page works best for your business and results in the best conversion rate.

Give each customer a unique website experience

Use personalization in PageSense to deliver customized versions of your website for every individual customer based on their demographics, local weather, browsing history, and more.

Grow your business through customer feedback

Run polls on your website using PageSense to understand what your customers think about your products/services and what needs improvement on your site.

Send timely updates that customers love

Use web push notifications in PageSense to schedule and notify your customers about an upcoming flash sale, product releases, promotional coupons, and a lot more that can spark conversions on your website.

Advertise your business to website visitors

Use pop-ups in PageSense to instantly grab the attention of visitors by showing attractive signup offers, coupon code discounts, or email newsletters that can eventually convert them into subscribers.

Access more advanced settings in PageSense

Use PageSense's advanced features like creating mutually exclusive groups, enabling cross-domain tracking, configuring customized project JS, and more to get deeper insights about your website.

Try easy-to-use extensions

Download the PageSense extension app available for your web browser with a few clicks and start collecting all of your required website metrics in real time.

Discover your favorite integrations with PageSense

Get a deeper look at your website's data by seamlessly integrating PageSense with a host of popular third-party apps like Google Analytics, Mixpanel, Intercom, and more.

Quick Links	Workflow Automation	Data Collection
Web Forms	Enterprise	Online Data Collection Tool
Embeddable Forms	Banking	Begin Data Collection
Interactive Forms	Workplace	Data Collection App
CRM Forms	Customer Service	Accessible Forms
Digital Forms	Marketing	Forms for Small Business
HTML Forms	Education	Forms for Enterprise
Contact Forms	E-commerce	Forms for any business
Lead Generation Forms	Healthcare	Forms for Startups
Wordpress Forms	Customer onboarding	Forms for Small Business
No Code Forms	Construction	RSVP tool for holidays
Free Forms	Travel	Features for Order Forms
Prefill Forms	Non-Profit
Intake Forms	Legal	Mobile App
Form Designer	HR	Mobile Forms
Card Forms	Food	Offline Forms
Assign Forms	Photography	Mobile Forms Features
Translate Forms	Real Estate	Kiosk in Mobile Forms
Electronic Forms
Drag & drop form builder
Notification Emails for Forms	Alternatives	Security & Compliance
Holiday Forms	Google Forms alternative	GDPR
Form to PDF	Jotform alternative	HIPAA Forms
Email Forms	Formstack alternative	Encrypted Forms
	Wufoo alternative	Secure Forms
		WCAG

Quick Links

New to Zoho Writer?

Signup Now

Zoho Writer

What's new

Help Guide

Blogs

Forums

Webinars

API

Developers

Build Extensions

Create. Review. Publish.

Write, edit, collaborate on, and publish documents to different content management platforms.

Get Started Now

Zoho Campaigns Resources

Campaigns Community Learning Series

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

Zoho Pagesense Resources

You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho Social?

Manage your brands on social media

Access Zoho Social

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day
Ask the Experts

Zoho Sheet Resources

New to Zoho Forms?

Latest Feature Updates

Explore our Pricing & Plans

Zoho Forms Resources

Secure your business

communication with Zoho Mail

Get started

Mail on the move with

Zoho Mail mobile application

Go Mobile

Stay on top of your schedule

at all times

Get started

Carry your calendar with you

Anytime, anywhere

Get started

Latest Announcements

New to Zoho Sign?

Zoho Sign Resources

Sign, Paperless!

Sign and send business documents on the go!

Get Started Now

Zoho SalesIQ Resources

New to Zoho TeamInbox?

Zoho TeamInbox Resources

Connect with us

New to Zoho ZeptoMail?

LEARN MORE

Latest Feature Updates

Zoho DataPrep Resources

New to Zoho DataPrep?

Access Zoho DataPrep

Zoho DataPrep Demo

Get a personalized demo or POC

Design. Discuss. Deliver.

Create visually engaging stories with Zoho Show.

Get Started Now

New to Zoho Workerly?

Access Zoho Workerly

New to Zoho Recruit?

Access Zoho Recruit

New to Zoho CRM?

Signup Now

Access Zoho CRM

Latest Feature Updates

New to Zoho Projects?

Access Zoho Projects

New to Zoho Sprints?

Access Zoho Sprints

New to Zoho Assist?

Access Zoho Assist

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Related Articles
Agent Status Metrics API
ZohoVoice REST API Authorization HeaderKey Description Authorization * Zoho-oauthtoken<space><ACCESS_TOKEN> Accept * Set to application/json. OAuth Doc GET AGENT'S ONLINE STATUS AUDIT This API fetches the status details of an agent during a given ...
User Guide for using Voice REST API via Google Sheet API Connector
This document provides a step-by-step guide on how to use the Voice REST API through the Google Sheet API Connector to populate voice data into a Google Sheet. Follow the instructions carefully to ensure successful integration. Prerequisites Access ...
Zoho Voice SMS REST API
Authorization HeaderKey Description Authorization * Zoho-oauthtoken<space><ACCESS_TOKEN> Accept * Set to application/json. OAuth Doc Send SMS Use this API to send SMS POST https://voice.zoho.com/rest/json/v1/sms/send Scope : ZohoVoice.sms.CREATE ...
Users API
Users CRUD APIs Authorization HeaderKey Description Authorization * Zoho-oauthtoken<space><ACCESS_TOKEN> Accept * Set to application/json. *All APIs are accessible under zohovoice.agents.ALL scope. OAuth Doc Use this API to get all the users. READ ...
Contacts API
Contact CRUD APIs Authorization HeaderKey Description Authorization * Zoho-oauthtoken<space><ACCESS_TOKEN> Accept * Set to application/json. *All APIs are accessible under zohovoice.contacts.ALL scope. OAuth Doc Create Contact Use this API to create ...