Webex · Schema

SimultaneousRingCriteriaPut

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
scheduleName	string	Name of the schedule which determines when the simultaneous ring is in effect.
scheduleType	object
scheduleLevel	object
callsFrom	object
anonymousCallersEnabled	boolean	When `true`, the criteria applies to calls from anonymous callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`.
unavailableCallersEnabled	boolean	When `true`, the criteria applies to calls from unavailable callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`.
phoneNumbers	array	The list of phone numbers that will checked against incoming calls for a match. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`.
ringEnabled	boolean	When set to `true` simultaneous ringing is enabled for calls that meet this 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/SimultaneousRingCriteriaPut",
  "title": "SimultaneousRingCriteriaPut",
  "type": "object",
  "properties": {
    "scheduleName": {
      "type": "string",
      "example": "Business Vacation",
      "description": "Name of the schedule which determines when the simultaneous ring is in effect."
    },
    "scheduleType": {
      "$ref": "#/components/schemas/ScheduleType"
    },
    "scheduleLevel": {
      "$ref": "#/components/schemas/ScheduleLevel"
    },
    "callsFrom": {
      "$ref": "#/components/schemas/CallsFromType"
    },
    "anonymousCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, the criteria applies to calls from anonymous callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`."
    },
    "unavailableCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, the criteria applies to calls from unavailable callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "+19064441748"
      },
      "description": "The list of phone numbers that will checked against incoming calls for a match. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`.",
      "example": [
        "+19064441748"
      ]
    },
    "ringEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When set to `true` simultaneous ringing is enabled for calls that meet this criteria. Criteria with `ringEnabled` set to `false` take priority."
    }
  }
}