Webex · Schema

PlaceSimultaneousRingCriteriaPost

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
scheduleName string Name of the location's schedule which determines when the simultaneous ring is in effect.
scheduleType object The Schedule type whether `businessHours` or `holidays`.
scheduleLevel object The Schedule level i.e, Group.
callsFrom object Indicates whether to apply simultaneously ring for calls from Any Phone Number or Select Phone Numbers.
anonymousCallersEnabled boolean When `true`, enables calls from anonymous callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`.
unavailableCallersEnabled boolean When `true`, enables calls even if callers are unavailable. 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 criteria is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority.
View JSON Schema on GitHub

JSON Schema

webex-placesimultaneousringcriteriapost-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PlaceSimultaneousRingCriteriaPost",
  "title": "PlaceSimultaneousRingCriteriaPost",
  "type": "object",
  "required": [
    "scheduleName",
    "scheduleType",
    "scheduleLevel",
    "callsFrom",
    "ringEnabled"
  ],
  "properties": {
    "scheduleName": {
      "type": "string",
      "example": "Business Vacation",
      "description": "Name of the location's schedule which determines when the simultaneous ring is in effect."
    },
    "scheduleType": {
      "$ref": "#/components/schemas/ScheduleTypeSelection",
      "description": "The Schedule type whether `businessHours` or `holidays`."
    },
    "scheduleLevel": {
      "$ref": "#/components/schemas/PlaceScheduleLevel",
      "description": "The Schedule level i.e, Group."
    },
    "callsFrom": {
      "$ref": "#/components/schemas/CallsFromType",
      "description": "Indicates whether to apply simultaneously ring for calls from Any Phone Number or Select Phone Numbers."
    },
    "anonymousCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, enables calls from anonymous callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`."
    },
    "unavailableCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, enables calls even if callers are unavailable. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "+19064441748,+19186663950"
      },
      "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`."
    },
    "ringEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When set to `true` simultaneous ringing criteria is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority."
    }
  }
}