Webex · Schema

KeyConfigurationsObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
key string Key assigned to specific menu configuration.
action string Action assigned to specific menu key configuration. * `PLAY_ANNOUNCEMENT` - Plays a recorded message and then returns to the current Auto Attendant menu. * `TRANSFER_WITH_PROMPT` - Transfers the call
description string The description of each menu key.
value string Value based on actions.
audioAnnouncementFile object Pre-configured announcement audio files when PLAY_ANNOUNCEMENT is set.
View JSON Schema on GitHub

JSON Schema

webex-keyconfigurationsobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/KeyConfigurationsObject",
  "title": "KeyConfigurationsObject",
  "type": "object",
  "required": [
    "key",
    "action"
  ],
  "properties": {
    "key": {
      "type": "string",
      "enum": [
        "0",
        "1",
        "2",
        "3",
        "4",
        "5",
        "6",
        "7",
        "8",
        "9",
        "*",
        "#"
      ],
      "description": "Key assigned to specific menu configuration."
    },
    "action": {
      "type": "string",
      "enum": [
        "PLAY_ANNOUNCEMENT",
        "TRANSFER_WITH_PROMPT",
        "TRANSFER_WITHOUT_PROMPT",
        "TRANSFER_TO_OPERATOR",
        "TRANSFER_TO_MAILBOX",
        "NAME_DIALING",
        "EXTENSION_DIALING",
        "REPEAT_MENU",
        "EXIT"
      ],
      "description": "Action assigned to specific menu key configuration.\n * `PLAY_ANNOUNCEMENT` - Plays a recorded message and then returns to the current Auto Attendant menu.\n * `TRANSFER_WITH_PROMPT` - Transfers the call to the specified number, without playing a transfer prompt.\n * `TRANSFER_WITHOUT_PROMPT` - Plays the message and then transfers the call to the specified number.\n * `TRANSFER_TO_OPERATOR` - Plays the message and then transfers the call to the specified operator number.\n * `TRANSFER_TO_MAILBOX` - Prompts the user for an extension, and transfers the user to voice mailbox of the dialed extension.\n * `NAME_DIALING` - Brings the user into the automated name directory.\n * `EXTENSION_DIALING` - Prompts the user for an extension, and transfers the user.\n * `REPEAT_MENU` - Replays the Auto Attendant greeting.\n * `EXIT` - Terminates the call.\n"
    },
    "description": {
      "type": "string",
      "example": "Exit the menu",
      "description": "The description of each menu key."
    },
    "value": {
      "type": "string",
      "example": "+19705550006",
      "description": "Value based on actions."
    },
    "audioAnnouncementFile": {
      "$ref": "#/components/schemas/AudioAnnouncementFileObject",
      "description": "Pre-configured announcement audio files when PLAY_ANNOUNCEMENT is set."
    }
  }
}