Webex · Schema

SequentialRingCriteriaPut

Request body for updating sequential ring criteria settings.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
scheduleName	string	Name of the schedule to be associated with the criteria.
scheduleType	string	Type of the schedule. * `businessHours` - Business hours schedule type. * `holidays` - Holidays schedule type.
scheduleLevel	string	* `PEOPLE` - The schedule is at the user level. * `LOCATION` - The schedule is at the location level.
callsFrom	string	Specifies the type of calling numbers the criteria applies to. * `ANY_PHONE_NUMBER` - The criteria applies to any phone number. * `SELECT_PHONE_NUMBERS` - The criteria applies to selected phone number
anonymousCallersEnabled	boolean	When `true`, means this criteria applies for anonymous callers. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`.
unavailableCallersEnabled	boolean	When `true`, means this criteria applies for unavailable callers. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`.
phoneNumbers	array	List of phone numbers to update for this criteria. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`.
ringEnabled	boolean	Determines whether sequential ring is applied for calls matching this criteria. If `true`, sequential ring is applied. Criteria with ringEnabled set to false have precedence over criteria with ringEna

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SequentialRingCriteriaPut",
  "title": "SequentialRingCriteriaPut",
  "type": "object",
  "description": "Request body for updating sequential ring criteria settings.",
  "properties": {
    "scheduleName": {
      "type": "string",
      "description": "Name of the schedule to be associated with the criteria.",
      "example": "Holidays"
    },
    "scheduleType": {
      "type": "string",
      "enum": [
        "businessHours",
        "holidays"
      ],
      "description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n",
      "example": "holidays"
    },
    "scheduleLevel": {
      "type": "string",
      "enum": [
        "PEOPLE",
        "LOCATION"
      ],
      "description": " * `PEOPLE` - The schedule is at the user level.\n * `LOCATION` - The schedule is at the location level.\n",
      "example": "LOCATION"
    },
    "callsFrom": {
      "type": "string",
      "enum": [
        "ANY_PHONE_NUMBER",
        "SELECT_PHONE_NUMBERS"
      ],
      "description": "Specifies the type of calling numbers the criteria applies to.\n * `ANY_PHONE_NUMBER` - The criteria applies to any phone number.\n * `SELECT_PHONE_NUMBERS` - The criteria applies to selected phone numbers.\n",
      "example": "ANY_PHONE_NUMBER"
    },
    "anonymousCallersEnabled": {
      "type": "boolean",
      "description": "When `true`, means this criteria applies for anonymous callers. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`.",
      "example": true
    },
    "unavailableCallersEnabled": {
      "type": "boolean",
      "description": "When `true`, means this criteria applies for unavailable callers. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`.",
      "example": true
    },
    "phoneNumbers": {
      "type": "array",
      "description": "List of phone numbers to update for this criteria. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`.",
      "items": {
        "type": "string",
        "description": "Phone number that the criteria applies to. If SELECT_PHONE_NUMBERS has been selected"
      }
    },
    "ringEnabled": {
      "type": "boolean",
      "description": "Determines whether sequential ring is applied for calls matching this criteria. If `true`, sequential ring is applied. Criteria with ringEnabled set to false have precedence over criteria with ringEnabled set to true.",
      "example": false
    }
  }
}