Webex · Schema

ModesPatch

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
normalOperationEnabled boolean Normal operation is enabled or disabled.
id string The ID of the operating mode.
forwardTo object Forward to settings.
View JSON Schema on GitHub

JSON Schema

webex-modespatch-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ModesPatch",
  "title": "ModesPatch",
  "type": "object",
  "required": [
    "normalOperationEnabled",
    "id",
    "forwardTo"
  ],
  "properties": {
    "normalOperationEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Normal operation is enabled or disabled."
    },
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
      "description": "The ID of the operating mode."
    },
    "forwardTo": {
      "type": "object",
      "required": [
        "selection"
      ],
      "properties": {
        "selection": {
          "type": "string",
          "enum": [
            "FORWARD_TO_DEFAULT_NUMBER",
            "FORWARD_TO_SPECIFIED_NUMBER",
            "DO_NOT_FORWARD"
          ],
          "description": "The selection for forwarding.\n * `FORWARD_TO_DEFAULT_NUMBER` - When the rule matches, forward to the destination for the hunt group.\n * `FORWARD_TO_SPECIFIED_NUMBER` - When the rule matches, forward to the destination for this rule.\n * `DO_NOT_FORWARD` - When the rule matches, do not forward to another number.\n"
        },
        "destination": {
          "type": "string",
          "example": "+19705550006",
          "description": "The destination for forwarding. Required when the selection is set to `FORWARD_TO_SPECIFIED_NUMBER`."
        },
        "destinationVoicemailEnabled": {
          "type": "boolean",
          "description": "Sending incoming calls to voicemail is enabled/disabled when the destination is an internal phone number and that number has the voicemail service enabled."
        }
      },
      "description": "Forward to settings."
    }
  }
}