Webex · Schema

PlaceSelectiveRejectCallCriteriaGet

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier for criteria.
scheduleName	string	Name of the location's schedule which determines when the selective reject 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 the selective reject criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones.
anonymousCallersEnabled	boolean	When `true`, enables selective reject to calls from anonymous callers.
unavailableCallersEnabled	boolean	When `true`, enables selective reject to calls if the callers are unavailable.
phoneNumbers	array	the list of phone numbers that will checked against incoming calls for a match.
rejectEnabled	boolean	Indicates whether the calls, that fit within these parameters, will be rejected (if rejectEnabled = `true`) or not (if rejectEnabled = `false`).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PlaceSelectiveRejectCallCriteriaGet",
  "title": "PlaceSelectiveRejectCallCriteriaGet",
  "type": "object",
  "required": [
    "id",
    "callsFrom"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
      "description": "Unique identifier for criteria."
    },
    "scheduleName": {
      "type": "string",
      "example": "Business Vacation",
      "description": "Name of the location's schedule which determines when the selective reject 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/SelectiveRejectCallCallsFromType",
      "description": "Indicates whether to apply the selective reject criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones."
    },
    "anonymousCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, enables selective reject to calls from anonymous callers."
    },
    "unavailableCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, enables selective reject to calls if the callers are unavailable."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "+19075552859,+19186663950"
      },
      "description": "the list of phone numbers that will checked against incoming calls for a match."
    },
    "rejectEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates whether the calls, that fit within these parameters, will be rejected (if rejectEnabled = `true`) or not (if rejectEnabled = `false`)."
    }
  }
}