Webex · Schema

CallNotifyCriteriaListGet

User call notify criteria response object containing configurations of Criteria.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier for the call notify criteria.
scheduleName string Name of the schedule associated with the criteria.
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.
notificationEnabled boolean Determines whether call notify is applied for calls matching this criteria. If `true`, call notification is applied. If `false`, this criteria acts as a 'Don't Notify Me' rule, preventing call notific
View JSON Schema on GitHub

JSON Schema

webex-callnotifycriterialistget-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CallNotifyCriteriaListGet",
  "title": "CallNotifyCriteriaListGet",
  "type": "object",
  "description": "User call notify criteria response object containing configurations of Criteria.",
  "example": {
    "id": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
    "scheduleName": "CustomHoliday(Group)",
    "source": "ALL_NUMBERS",
    "notificationEnabled": false
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the call notify criteria.",
      "example": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY"
    },
    "scheduleName": {
      "type": "string",
      "description": "Name of the schedule associated with the criteria.",
      "example": "CustomHoliday(Group)"
    },
    "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"
    },
    "notificationEnabled": {
      "type": "boolean",
      "description": "Determines whether call notify is applied for calls matching this criteria. If `true`, call notification is applied. If `false`, this criteria acts as a 'Don't Notify Me' rule, preventing call notification. Criteria with `notificationEnabled` set to `false` (Don't Notify Me) take precedence over criteria with `notificationEnabled` set to `true` (Notify Me)."
    }
  }
}