Webex · Schema

PriorityAlertGetCriteriaObject

Individual Priority Alert Criterion configuration.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier for the priority alert criterion.
scheduleName string Name of the schedule associated with the criteria.
notificationEnabled boolean Determines whether priority alerting is applied for calls matching this criteria. If `true`, priority alerting is applied. If `false`, this criteria acts as a 'Don't Alert' rule, preventing priority a
source string Type of the source. * `ALL_NUMBERS` - User wants to be notified for calls from Any Phone Number. * `SPECIFIC_NUMBERS` - User wants to be notified for calls from Select Phone Numbers.
View JSON Schema on GitHub

JSON Schema

webex-priorityalertgetcriteriaobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PriorityAlertGetCriteriaObject",
  "title": "PriorityAlertGetCriteriaObject",
  "type": "object",
  "description": "Individual Priority Alert Criterion configuration.",
  "example": {
    "id": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
    "scheduleName": "CustomHoliday(Group)",
    "source": "ALL_NUMBERS",
    "notificationEnabled": false
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the priority alert criterion.",
      "example": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY"
    },
    "scheduleName": {
      "type": "string",
      "description": "Name of the schedule associated with the criteria.",
      "example": "CustomHoliday(Group)"
    },
    "notificationEnabled": {
      "type": "boolean",
      "description": "Determines whether priority alerting is applied for calls matching this criteria. If `true`, priority alerting is applied. If `false`, this criteria acts as a 'Don't Alert' rule, preventing priority alerting. Criteria with `notificationEnabled` set to `false` (Don't Alert) take precedence over criteria with `notificationEnabled` set to `true` (Alert).",
      "example": false
    },
    "source": {
      "type": "string",
      "enum": [
        "ALL_NUMBERS",
        "SPECIFIC_NUMBERS"
      ],
      "description": "Type of the source.\n * `ALL_NUMBERS` - User wants to be notified for calls from Any Phone Number.\n * `SPECIFIC_NUMBERS` - User wants to be notified for calls from Select Phone Numbers.\n"
    }
  }
}