Webex · Schema

SimultaneousRingCriteriaGet

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier for criteria.
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.
unavailableCallersEnabled boolean When `true`, the criteria applies to calls from unavailable callers.
phoneNumbers array The list of phone numbers that will checked against incoming calls for a match.
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

webex-simultaneousringcriteriaget-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SimultaneousRingCriteriaGet",
  "title": "SimultaneousRingCriteriaGet",
  "type": "object",
  "required": [
    "id",
    "callsFrom",
    "anonymousCallersEnabled",
    "unavailableCallersEnabled",
    "ringEnabled"
  ],
  "example": {
    "id": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
    "scheduleName": "Business Vacation",
    "scheduleType": "holidays",
    "scheduleLevel": "LOCATION",
    "callsFrom": "SELECT_PHONE_NUMBERS",
    "anonymousCallersEnabled": true,
    "unavailableCallersEnabled": true,
    "phoneNumbers": [
      "+19075552859",
      "+19186663950"
    ],
    "ringEnabled": true
  },
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
      "description": "Unique identifier for criteria."
    },
    "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."
    },
    "unavailableCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, the criteria applies to calls from unavailable callers."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "+19075552859"
      },
      "description": "The list of phone numbers that will checked against incoming calls for a match.",
      "example": [
        "+19075552859",
        "+19186663950"
      ]
    },
    "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."
    }
  }
}