Webex · Schema

SimultaneousRingGet

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
enabled boolean Simultaneous Ring is enabled or not.
doNotRingIfOnCallEnabled boolean When set to `true`, the configured phone numbers won't ring when on a call.
phoneNumbers array Enter up to 10 phone numbers to ring simultaneously when a workspace phone receives an incoming call.
criteria array A list of criteria specifying conditions when simultaneous ring is in effect.
criteriasEnabled boolean When `true`, enables the selected schedule for simultaneous ring.
View JSON Schema on GitHub

JSON Schema

webex-simultaneousringget-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SimultaneousRingGet",
  "title": "SimultaneousRingGet",
  "type": "object",
  "required": [
    "enabled",
    "doNotRingIfOnCallEnabled",
    "criteriasEnabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Simultaneous Ring is enabled or not."
    },
    "doNotRingIfOnCallEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When set to `true`, the configured phone numbers won't ring when on a call."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimultaneousRingNumberGet"
      },
      "description": "Enter up to 10 phone numbers to ring simultaneously when a workspace phone receives an incoming call."
    },
    "criteria": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimultaneousRingCriteria"
      },
      "description": "A list of criteria specifying conditions when simultaneous ring is in effect."
    },
    "criteriasEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, enables the selected schedule for simultaneous ring."
    }
  }
}