Webex · Schema

PriorityAlertCriteria

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier for criteria.
scheduleName string Name of the location's schedule which determines when the priority alert is in effect.
source string If criteria are applicable for calls from any phone number or specific phone number. * `ALL_NUMBERS` - Indicates that priority alert criteria apply for all incoming numbers. * `SPECIFIC_NUMBERS` - Ind
notificationEnabled boolean When set to `true` notification is enabled for calls that meet the current criteria. Criteria with `notificationEnabled` set to `false` take priority.
View JSON Schema on GitHub

JSON Schema

webex-priorityalertcriteria-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PriorityAlertCriteria",
  "title": "PriorityAlertCriteria",
  "type": "object",
  "required": [
    "id",
    "source",
    "notificationEnabled"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
      "description": "Unique identifier for criteria."
    },
    "scheduleName": {
      "type": "string",
      "example": "Business Vacation",
      "description": "Name of the location's schedule which determines when the priority alert is in effect."
    },
    "source": {
      "type": "string",
      "enum": [
        "ALL_NUMBERS",
        "SPECIFIC_NUMBERS"
      ],
      "description": "If criteria are applicable for calls from any phone number or specific phone number.\n * `ALL_NUMBERS` - Indicates that priority alert criteria apply for all incoming numbers.\n * `SPECIFIC_NUMBERS` - Indicates priority alert criteria only apply to specific incoming numbers.\n"
    },
    "notificationEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When set to `true` notification is enabled for calls that meet the current criteria. Criteria with `notificationEnabled` set to `false` take priority."
    }
  }
}