Webex · Schema

PlaceSelectiveRejectCallCriteriaPost

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
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 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`.
rejectEnabled boolean Choose to reject (if `rejectEnabled` = `true`) or not to reject (if `rejectEnabled` = `false`) the calls that fit within these parameters.
View JSON Schema on GitHub

JSON Schema

webex-placeselectiverejectcallcriteriapost-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PlaceSelectiveRejectCallCriteriaPost",
  "title": "PlaceSelectiveRejectCallCriteriaPost",
  "type": "object",
  "required": [
    "scheduleName",
    "scheduleType",
    "scheduleLevel",
    "callsFrom",
    "rejectEnabled"
  ],
  "properties": {
    "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 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`."
    },
    "rejectEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Choose to reject (if `rejectEnabled` = `true`) or not to reject (if `rejectEnabled` = `false`) the calls that fit within these parameters."
    }
  }
}