GET - Get a single queue audio profile

 

Purpose

Use this API to get a single queue audio profile.

 

Authorization

HeaderKeyDescription
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/queueaudioprofile/2069000002486021

Scope: zohovoice.queues.READ

Sample Request

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

Sample Response - Success

Copied{
  "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": ""
      },
      "callBackExit": {
        "mode": "text",
        "audioVoice": "2",
        "audioId": "",
        "audioLanguage": "en-US",
        "message": "press * to request a callback"
      },
      "announcementInterval": "70",
      "specialAnnouncement": {
        "mode": "text",
        "audioVoice": "2",
        "audioId": "",
        "audioLanguage": "en-US",
        "message": ""
      }
    },
    "updatedBy": "sales@zylker.com",
    "name": "US Support - Main ",
    "id": "2069000002486021"
  },
  "status": "SUCCESS"
}

Sample Response - Error

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