GetCallQueueForcedForwardObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetCallQueueForcedForwardObject",
  "title": "GetCallQueueForcedForwardObject",
  "type": "object",
  "required": [
    "forcedForwardEnabled",
    "playAnnouncementBeforeEnabled",
    "audioMessageSelection"
  ],
  "properties": {
    "forcedForwardEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the call queue forced forward routing policy setting is enabled."
    },
    "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`."
    }
  }
}