Webex · Schema

SequentialRingCriteriaGet

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier for criteria.
scheduleName	string	Name of the location's schedule which determines when the sequential ring is in effect.
scheduleType	string	The type of schedule. * `holidays` - The Schedule is of type `holidays`. * `businessHours` - The Schedule is of type `businessHours`.
scheduleLevel	string	This indicates the level of the schedule specified by `scheduleName`. * `GROUP` - The Schedule specified is of `GROUP` level.
callsFrom	string	This indicates if criteria are applicable for calls from any phone number or selected phone numbers. * `SELECT_PHONE_NUMBERS` - Sequential ring criteria only apply for selected incoming numbers. * `AN
anonymousCallersEnabled	boolean	When `true` incoming calls from private numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`.
unavailableCallersEnabled	boolean	When `true` incoming calls from unavailable numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`.
phoneNumbers	array	When callsFrom is set to `SELECT_PHONE_NUMBERS`, indicates a list of incoming phone numbers for which the criteria apply.
ringEnabled	boolean	When set to `true` sequential ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SequentialRingCriteriaGet",
  "title": "SequentialRingCriteriaGet",
  "type": "object",
  "required": [
    "id",
    "scheduleName",
    "scheduleType",
    "scheduleLevel",
    "callsFrom",
    "ringEnabled"
  ],
  "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 sequential ring is in effect."
    },
    "scheduleType": {
      "type": "string",
      "enum": [
        "holidays",
        "businessHours"
      ],
      "description": "The type of schedule.\n * `holidays` - The Schedule is of type `holidays`.\n * `businessHours` - The Schedule is of type `businessHours`.\n"
    },
    "scheduleLevel": {
      "type": "string",
      "enum": [
        "GROUP"
      ],
      "description": "This indicates the level of the schedule specified by `scheduleName`.\n * `GROUP` - The Schedule specified is of `GROUP` level.\n"
    },
    "callsFrom": {
      "type": "string",
      "enum": [
        "SELECT_PHONE_NUMBERS",
        "ANY_PHONE_NUMBER"
      ],
      "description": "This indicates if criteria are applicable for calls from any phone number or selected phone numbers.\n * `SELECT_PHONE_NUMBERS` - Sequential ring criteria only apply for selected incoming numbers.\n * `ANY_PHONE_NUMBER` - Sequential ring criteria apply for any incoming number.\n"
    },
    "anonymousCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true` incoming calls from private numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`."
    },
    "unavailableCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true` incoming calls from unavailable numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "+19075552859,+19186663950"
      },
      "description": "When callsFrom is set to `SELECT_PHONE_NUMBERS`, indicates a list of incoming phone numbers for which the criteria apply."
    },
    "ringEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When set to `true` sequential ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority."
    }
  }
}