Webex · Schema

ExecutiveScreeningGet

Executive screening settings response object containing configuration for call screening and alert preferences.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
enabled boolean Indicates if executive screening is enabled.
alertType string * `SILENT` - No audible alert is provided for executive screening. * `RING_SPLASH` - A short ring (splash) is used as an alert for executive screening.
alertAnywhereLocationEnabled boolean Indicates if alerts are enabled for Single Number Reach locations.
alertMobilityLocationEnabled boolean Indicates if alerts are enabled for Webex Go locations.
alertSharedCallAppearanceLocationEnabled boolean Indicates if alerts are enabled for Shared Call Appearance locations.
View JSON Schema on GitHub

JSON Schema

webex-executivescreeningget-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ExecutiveScreeningGet",
  "title": "ExecutiveScreeningGet",
  "type": "object",
  "description": "Executive screening settings response object containing configuration for call screening and alert preferences.",
  "required": [
    "enabled",
    "alertType",
    "alertAnywhereLocationEnabled",
    "alertMobilityLocationEnabled",
    "alertSharedCallAppearanceLocationEnabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Indicates if executive screening is enabled."
    },
    "alertType": {
      "type": "string",
      "enum": [
        "SILENT",
        "RING_SPLASH"
      ],
      "description": " * `SILENT` - No audible alert is provided for executive screening.\n * `RING_SPLASH` - A short ring (splash) is used as an alert for executive screening.\n"
    },
    "alertAnywhereLocationEnabled": {
      "type": "boolean",
      "description": "Indicates if alerts are enabled for Single Number Reach locations."
    },
    "alertMobilityLocationEnabled": {
      "type": "boolean",
      "description": "Indicates if alerts are enabled for Webex Go locations."
    },
    "alertSharedCallAppearanceLocationEnabled": {
      "type": "boolean",
      "description": "Indicates if alerts are enabled for Shared Call Appearance locations."
    }
  },
  "example": {
    "enabled": true,
    "alertType": "SILENT",
    "alertAnywhereLocationEnabled": false,
    "alertMobilityLocationEnabled": false,
    "alertSharedCallAppearanceLocationEnabled": false
  }
}