Webex · Schema

ExecutiveCallFilteringPatch

Executive call filtering settings request object for updating the filter configuration and criteria activation.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
enabled boolean Set to `true` to enable executive call filtering or `false` to disable it.
filterType string * `CUSTOM_CALL_FILTERS` - Choose this option to ensure that only specific calls are sent to the executive assistant. * `ALL_CALLS` - Choose this option to send both internal and external calls to the
criteriaActivation array The list of criteria activation settings to update for executive call filtering.
View JSON Schema on GitHub

JSON Schema

webex-executivecallfilteringpatch-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ExecutiveCallFilteringPatch",
  "title": "ExecutiveCallFilteringPatch",
  "type": "object",
  "description": "Executive call filtering settings request object for updating the filter configuration and criteria activation.",
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Set to `true` to enable executive call filtering or `false` to disable it."
    },
    "filterType": {
      "type": "string",
      "enum": [
        "CUSTOM_CALL_FILTERS",
        "ALL_CALLS",
        "ALL_INTERNAL_CALLS",
        "ALL_EXTERNAL_CALLS"
      ],
      "description": " * `CUSTOM_CALL_FILTERS` - Choose this option to ensure that only specific calls are sent to the executive assistant.\n * `ALL_CALLS` - Choose this option to send both internal and external calls to the executive assistant.\n * `ALL_INTERNAL_CALLS` - Choose this option to send all internal calls to the executive assistant.\n * `ALL_EXTERNAL_CALLS` - Choose this option to send all external calls to the executive assistant.\n"
    },
    "criteriaActivation": {
      "type": "array",
      "description": "The list of criteria activation settings to update for executive call filtering.",
      "items": {
        "type": "object",
        "required": [
          "id",
          "activationEnabled"
        ],
        "description": "The activation configuration for an individual filter criterion.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the filter criteria."
          },
          "activationEnabled": {
            "type": "boolean",
            "description": "Controls whether this filter criteria is active. When `true`, the criteria is evaluated for incoming calls. When `false`, the criteria is completely ignored and has no effect on call filtering."
          }
        }
      }
    }
  }
}