Webex · Schema

SequentialRingGet

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
enabled boolean When set to `true` sequential ring is enabled.
ringBaseLocationFirstEnabled boolean When set to `true`, the webex calling primary line will ring first.
baseLocationNumberOfRings string The number of times the primary line will ring.
continueIfBaseLocationIsBusyEnabled boolean When set to `true` and the primary line is busy, the system redirects calls to the numbers configured for sequential ringing.
callsToVoicemailEnabled boolean When set to `true` calls are directed to voicemail.
phoneNumbers array A list of up to five phone numbers to which calls will be directed.
criteria array A list of criteria specifying conditions when sequential ringing is in effect.
View JSON Schema on GitHub

JSON Schema

webex-sequentialringget-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SequentialRingGet",
  "title": "SequentialRingGet",
  "type": "object",
  "required": [
    "enabled",
    "ringBaseLocationFirstEnabled",
    "baseLocationNumberOfRings",
    "continueIfBaseLocationIsBusyEnabled",
    "callsToVoicemailEnabled",
    "phoneNumbers",
    "criteria"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "When set to `true` sequential ring is enabled."
    },
    "ringBaseLocationFirstEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When set to `true`, the webex calling primary line will ring first."
    },
    "baseLocationNumberOfRings": {
      "type": "string",
      "example": "2",
      "description": "The number of times the primary line will ring."
    },
    "continueIfBaseLocationIsBusyEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When set to `true` and the primary line is busy, the system redirects calls to the numbers configured for sequential ringing."
    },
    "callsToVoicemailEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When set to `true` calls are directed to voicemail."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SequentialRingNumber"
      },
      "description": "A list of up to five phone numbers to which calls will be directed."
    },
    "criteria": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SequentialRingCriteria"
      },
      "description": "A list of criteria specifying conditions when sequential ringing is in effect."
    }
  }
}