Webex · Schema

SequentialRingCriteriaSummary

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier for criteria.
scheduleName string Name of the schedule which determines when sequential ring is in effect.
source string Type of the source. * `ALL_NUMBERS` - sequential ring applies to calls from any phone number. * `SPECIFIC_NUMBERS` - sequential ring applies to calls from specific phone numbers.
ringEnabled boolean Determines whether sequential ring is applied for calls matching this criteria. If `true`, sequential ring is applied. If `false`, this criteria acts as a 'Don't Ring' rule. Criteria with ringEnabled
View JSON Schema on GitHub

JSON Schema

webex-sequentialringcriteriasummary-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SequentialRingCriteriaSummary",
  "title": "SequentialRingCriteriaSummary",
  "type": "object",
  "required": [
    "id",
    "scheduleName",
    "source",
    "ringEnabled"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
      "description": "Unique identifier for criteria."
    },
    "scheduleName": {
      "type": "string",
      "example": "BusinessHours",
      "description": "Name of the schedule which determines when sequential ring is in effect."
    },
    "source": {
      "type": "string",
      "enum": [
        "ALL_NUMBERS",
        "SPECIFIC_NUMBERS"
      ],
      "example": "ALL_NUMBERS",
      "description": "Type of the source.\n * `ALL_NUMBERS` - sequential ring applies to calls from any phone number.\n * `SPECIFIC_NUMBERS` - sequential ring applies to calls from specific phone numbers.\n"
    },
    "ringEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Determines whether sequential ring is applied for calls matching this criteria. If `true`, sequential ring is applied. If `false`, this criteria acts as a 'Don't Ring' rule. Criteria with ringEnabled set to false have precedence over criteria with ringEnabled set to true."
    }
  }
}