Webex · Schema

PatchCallQueueNightServiceObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
nightServiceEnabled	boolean	Enable or disable call queue night service routing policy.
action	string	The call processing action type. * `BUSY` - The caller hears a fast busy tone. * `TRANSFER` - Transfers the call to number specified in `transferPhoneNumber`.
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.
announcementMode	string	The type of announcements to played. * `NORMAL` - Plays announcement as per `audioMessageSelection`. * `MANUAL` - Plays announcement as per `manualAudioMessageSelection`.
audioMessageSelection	string	The type of announcements to be played when announcementMode is set to `NORMAL`. * `DEFAULT` - Default Audio Message Selection. * `CUSTOM` - Custom Audio Message Selection.
audioFiles	array	List of pre-configured Announcement Audio Files when `audioMessageSelection` is `CUSTOM`.
businessHoursName	string	Name of the schedule configured for a night service as one of from `businessHourSchedules` list.
businessHoursLevel	string	The above mentioned schedule is org or location specific. (Must be from `businessHourSchedules` list) * `ORGANIZATION` - Schedule is configured across an organization. * `LOCATION` - Schedule is confi
forceNightServiceEnabled	boolean	Force night service regardless of business hour schedule.
manualAudioMessageSelection	string	The type of announcements to be played when announcementMode is set to `MANUAL`. * `DEFAULT` - Default Audio Message Selection. * `CUSTOM` - Custom Audio Message Selection.
manualAudioFiles	array	List Of pre-configured Audio Files.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PatchCallQueueNightServiceObject",
  "title": "PatchCallQueueNightServiceObject",
  "type": "object",
  "required": [
    "nightServiceEnabled",
    "playAnnouncementBeforeEnabled",
    "announcementMode",
    "audioMessageSelection",
    "forceNightServiceEnabled",
    "manualAudioMessageSelection"
  ],
  "properties": {
    "nightServiceEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable or disable call queue night service routing policy."
    },
    "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"
    },
    "transferPhoneNumber": {
      "type": "string",
      "example": "1234",
      "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."
    },
    "announcementMode": {
      "type": "string",
      "enum": [
        "NORMAL",
        "MANUAL"
      ],
      "description": "The type of announcements to played.\n * `NORMAL` - Plays announcement as per `audioMessageSelection`.\n * `MANUAL` - Plays announcement as per `manualAudioMessageSelection`.\n"
    },
    "audioMessageSelection": {
      "type": "string",
      "enum": [
        "DEFAULT",
        "CUSTOM"
      ],
      "description": "The type of announcements to be played when announcementMode is set to `NORMAL`.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n"
    },
    "audioFiles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AudioAnnouncementFileFeatureObject"
      },
      "description": "List of pre-configured Announcement Audio Files when `audioMessageSelection` is `CUSTOM`."
    },
    "businessHoursName": {
      "type": "string",
      "example": "Working Hour",
      "description": "Name of the schedule configured for a night service as one of from `businessHourSchedules` list."
    },
    "businessHoursLevel": {
      "type": "string",
      "enum": [
        "ORGANIZATION",
        "LOCATION"
      ],
      "description": "The above mentioned schedule is org or location specific. (Must be from `businessHourSchedules` list)\n * `ORGANIZATION` - Schedule is configured across an organization.\n * `LOCATION` - Schedule is configured across a location.\n"
    },
    "forceNightServiceEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Force night service regardless of business hour schedule."
    },
    "manualAudioMessageSelection": {
      "type": "string",
      "enum": [
        "DEFAULT",
        "CUSTOM"
      ],
      "description": "The type of announcements to be played when announcementMode is set to `MANUAL`.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n"
    },
    "manualAudioFiles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AudioAnnouncementFileFeatureObject"
      },
      "description": "List Of pre-configured Audio Files."
    }
  }
}