Webex · Schema

PlacePriorityAlertCriteriaGet

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.
scheduleType object The Schedule type whether `businessHours` or `holidays`.
scheduleLevel object The Schedule level i.e. Group.
callsFrom object Indicates whether to apply priority alert for calls from Any Phone Number or Select Phone Numbers.
anonymousCallersEnabled boolean When `true`, enables calls from anonymous callers.
unavailableCallersEnabled boolean When `true`, enables calls even if callers are unavailable.
phoneNumbers array the list of phone numbers that will checked against incoming calls for a match.
notificationEnabled boolean When set to `true` priority alerting criteria 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-placepriorityalertcriteriaget-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PlacePriorityAlertCriteriaGet",
  "title": "PlacePriorityAlertCriteriaGet",
  "type": "object",
  "required": [
    "id",
    "callsFrom"
  ],
  "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."
    },
    "scheduleType": {
      "$ref": "#/components/schemas/ScheduleTypeSelection",
      "description": "The Schedule type whether `businessHours` or `holidays`."
    },
    "scheduleLevel": {
      "$ref": "#/components/schemas/PlaceScheduleLevel",
      "description": "The Schedule level i.e. Group."
    },
    "callsFrom": {
      "$ref": "#/components/schemas/CallsFromType",
      "description": "Indicates whether to apply priority alert for calls from Any Phone Number or Select Phone Numbers."
    },
    "anonymousCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, enables calls from anonymous callers."
    },
    "unavailableCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, enables calls even if callers are unavailable."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "+19075552859,+19186663950"
      },
      "description": "the list of phone numbers that will checked against incoming calls for a match."
    },
    "notificationEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When set to `true` priority alerting criteria is enabled for calls that meet the current criteria. Criteria with `notificationEnabled` set to `false` take priority."
    }
  }
}