Webex · Schema

SequentialRingCriteria

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.
source	object	If criterias are applicable for calls from any phone number or specific phone number.
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/SequentialRingCriteria",
  "title": "SequentialRingCriteria",
  "type": "object",
  "required": [
    "id",
    "scheduleName",
    "source",
    "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."
    },
    "source": {
      "$ref": "#/components/schemas/Source",
      "description": "If criterias are applicable for calls from any phone number or specific phone number."
    },
    "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."
    }
  }
}