Webex · Schema

ModifyCallQueueForcedForwardObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
forcedForwardEnabled boolean Enable or disable call forced forward service routing policy.
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 pre-configured Announcement Audio Files when `audioMessageSelection` is `CUSTOM`.
View JSON Schema on GitHub

JSON Schema

webex-modifycallqueueforcedforwardobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ModifyCallQueueForcedForwardObject",
  "title": "ModifyCallQueueForcedForwardObject",
  "type": "object",
  "required": [
    "forcedForwardEnabled",
    "playAnnouncementBeforeEnabled",
    "audioMessageSelection"
  ],
  "properties": {
    "forcedForwardEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable or disable call forced forward service routing policy."
    },
    "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/AudioAnnouncementFileFeatureObject"
      },
      "description": "List of pre-configured Announcement Audio Files when `audioMessageSelection` is `CUSTOM`."
    }
  }
}