Webex · Schema

ModifyCallForwardingObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
callForwarding object Settings related to `Always`, `Busy`, and `No Answer` call forwarding.
View JSON Schema on GitHub

JSON Schema

webex-modifycallforwardingobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ModifyCallForwardingObject",
  "title": "ModifyCallForwardingObject",
  "type": "object",
  "properties": {
    "callForwarding": {
      "type": "object",
      "properties": {
        "always": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean",
              "example": true,
              "description": "`Always` call forwarding is enabled or disabled."
            },
            "destination": {
              "type": "string",
              "example": "2225551212",
              "description": "Destination for `Always` call forwarding."
            },
            "ringReminderEnabled": {
              "type": "boolean",
              "description": "If `true`, a brief tone will be played on the person's phone when a call has been forwarded."
            },
            "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": "Settings for forwarding all incoming calls to the destination you choose."
        },
        "selective": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean",
              "example": true,
              "description": "`Busy` call forwarding is enabled or disabled."
            },
            "destination": {
              "type": "string",
              "example": "2225551212",
              "description": "Destination for `Busy` call forwarding."
            },
            "ringReminderEnabled": {
              "type": "boolean",
              "description": "If `true`, a brief tone will be played on the person's phone when a call has been forwarded."
            },
            "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": "Selectively forward calls to a designated number, depending on criteria rules. You'll need to have at least one rule for forwarding applied for call forwarding to be active."
        },
        "rules": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CallForwardRulesSet"
          },
          "description": "Rules for selectively forwarding calls."
        },
        "operatingModes": {
          "type": "object",
          "description": "Configuration for forwarding via Operating modes (Schedule Based Routing).",
          "required": [
            "enabled",
            "modes"
          ],
          "properties": {
            "enabled": {
              "type": "boolean",
              "description": "Indicates whether operating modes forwarding is enabled."
            },
            "modes": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ModesPatch"
              },
              "description": "List of operating mode configurations."
            }
          }
        }
      },
      "description": "Settings related to `Always`, `Busy`, and `No Answer` call forwarding."
    }
  }
}