Webex · Schema

ActionToBePerformedObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
action string Action to perform after the retry attempt is reached. * `PLAY_MESSAGE_AND_DISCONNECT` - Plays a recorded message and then disconnects the call. * `TRANSFER_WITHOUT_PROMPT` - Transfers the call to the
greeting string Greeting type is defined when `action` is set to `PLAY_MESSAGE_AND_DISCONNECT`. * `DEFAULT` - Play default greeting. * `CUSTOM` - Play custom greeting.
audioAnnouncementFile object Pre-configured announcement audio files when `action` is set to `PLAY_MESSAGE_AND_DISCONNECT` and `greeting` is set to `CUSTOM`.
transferCallTo string Transfer call to the specified number when `action` is set to `TRANSFER_WITH_PROMPT`, `TRANSFER_WITHOUT_PROMPT` and `TRANSFER_TO_OPERATOR` and `TRANSFER_TO_MAILBOX`.
View JSON Schema on GitHub

JSON Schema

webex-actiontobeperformedobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ActionToBePerformedObject",
  "title": "ActionToBePerformedObject",
  "type": "object",
  "required": [
    "action",
    "greeting"
  ],
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "PLAY_MESSAGE_AND_DISCONNECT",
        "TRANSFER_WITHOUT_PROMPT",
        "TRANSFER_WITH_PROMPT",
        "TRANSFER_TO_OPERATOR",
        "TRANSFER_TO_MAILBOX",
        "DISCONNECT"
      ],
      "description": "Action to perform after the retry attempt is reached.\n * `PLAY_MESSAGE_AND_DISCONNECT` - Plays a recorded message and then disconnects the call.\n * `TRANSFER_WITHOUT_PROMPT` - Transfers the call to the specified number, without playing a transfer prompt.\n * `TRANSFER_WITH_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` - Transfers the call to the configured mailbox, without playing a transfer prompt.\n * `DISCONNECT` - Disconnect the call.\n"
    },
    "greeting": {
      "type": "string",
      "enum": [
        "DEFAULT",
        "CUSTOM"
      ],
      "description": "Greeting type is defined when `action` is set to `PLAY_MESSAGE_AND_DISCONNECT`.\n * `DEFAULT` - Play default greeting.\n * `CUSTOM` - Play custom greeting.\n"
    },
    "audioAnnouncementFile": {
      "$ref": "#/components/schemas/AudioAnnouncementFileGetObject",
      "description": "Pre-configured announcement audio files when `action` is set to `PLAY_MESSAGE_AND_DISCONNECT` and `greeting` is set to `CUSTOM`."
    },
    "transferCallTo": {
      "type": "string",
      "example": "9878945608",
      "description": "Transfer call to the specified number when `action` is set to `TRANSFER_WITH_PROMPT`, `TRANSFER_WITHOUT_PROMPT` and `TRANSFER_TO_OPERATOR` and `TRANSFER_TO_MAILBOX`."
    }
  }
}