Webex · Schema

GetCallQueueHolidayObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
holidayServiceEnabled boolean Whether or not the call queue holiday service routing policy is enabled.
action string The call processing action type. * `BUSY` - The caller hears a fast-busy tone. * `TRANSFER` - Transfers the call to number specified in `transferPhoneNumber`.
holidayScheduleLevel string The schedule mentioned in `holidayScheduleName` is org or location specific. (Must be from `holidaySchedules` list) * `LOCATION` - Schedule is configured across a location. * `ORGANIZATION` - Schedule
holidayScheduleName string Name of the schedule configured for a holiday service as one of from `holidaySchedules` list.
transferPhoneNumber string Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension.
playAnnouncementBeforeEnabled boolean Indicates whether an announcement plays to callers before the action is applied.
audioMessageSelection string The type of announcement to be played. * `DEFAULT` - Default Audio Message Selection. * `CUSTOM` - Custom Audio Message Selection.
audioFiles array List of Announcement Audio Files when `audioMessageSelection` is `CUSTOM`.
holidaySchedules array Lists the pre-configured holiday schedules.
View JSON Schema on GitHub

JSON Schema

webex-getcallqueueholidayobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetCallQueueHolidayObject",
  "title": "GetCallQueueHolidayObject",
  "type": "object",
  "required": [
    "holidayServiceEnabled",
    "action",
    "holidayScheduleLevel",
    "playAnnouncementBeforeEnabled",
    "audioMessageSelection"
  ],
  "properties": {
    "holidayServiceEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the call queue holiday service routing policy is enabled."
    },
    "action": {
      "type": "string",
      "enum": [
        "BUSY",
        "TRANSFER"
      ],
      "description": "The call processing action type.\n * `BUSY` - The caller hears a fast-busy tone.\n * `TRANSFER` - Transfers the call to number specified in `transferPhoneNumber`.\n"
    },
    "holidayScheduleLevel": {
      "type": "string",
      "enum": [
        "LOCATION",
        "ORGANIZATION"
      ],
      "description": "The schedule mentioned in `holidayScheduleName` is org or location specific. (Must be from `holidaySchedules` list)\n * `LOCATION` - Schedule is configured across a location.\n * `ORGANIZATION` - Schedule is configured across an organization.\n"
    },
    "holidayScheduleName": {
      "type": "string",
      "example": "2022 Holidays Period",
      "description": "Name of the schedule configured for a holiday service as one of from `holidaySchedules` list."
    },
    "transferPhoneNumber": {
      "type": "string",
      "example": "1235557890",
      "description": "Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension."
    },
    "playAnnouncementBeforeEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates whether an announcement plays to callers before the action is applied."
    },
    "audioMessageSelection": {
      "type": "string",
      "enum": [
        "DEFAULT",
        "CUSTOM"
      ],
      "description": "The type of announcement to be played.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n"
    },
    "audioFiles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AudioAnnouncementFileFeatureGetObject"
      },
      "description": "List of Announcement Audio Files when `audioMessageSelection` is `CUSTOM`."
    },
    "holidaySchedules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CallQueueHolidaySchedulesObject"
      },
      "description": "Lists the pre-configured holiday schedules."
    }
  }
}