PUT - Update a queue audio profile

Purpose

Use this API to update a queue audio profile.

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: PUT

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

Scope: zohovoice.queues.UPDATE

Parameters:

Param Name

Data Type

Description

data*

JSONObject

Represents the queue data in JSON format. The name key is mandatory.

Example:
{
"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"
},
"callBackExit": {
"mode": "text",
"audioVoice": "2",
"audioId": "",
"audioLanguage": "en-US",
"message": "press * to request a callback"
}
}
}

Sample Request

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

Sample Response - Success

Copied{
  "code": "200",
  "qapId": 4061000001205001,
  "status": "SUCCESS"
}

Sample Response - Error

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