Webex · Schema

PlaceSelectiveForwardCallCriteriaPatch

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
forwardToPhoneNumber	string	Phone number to forward calls to during this schedule.
destinationVoicemailEnabled	boolean	Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions.
scheduleName	string	Name of the location's schedule which determines when the selective forward 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 forward criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones.
anonymousCallersEnabled	boolean	When `true`, enables selective forward to calls from anonymous callers.
unavailableCallersEnabled	boolean	When `true`, enables selective forward to calls if the callers are unavailable.
numbers	array	List of phone numbers checked against incoming calls for a match.
forwardEnabled	boolean	Indicates whether the calls, that fit within these parameters, will be forwarded (if forwardEnabled = `true`) or not (if forwardEnabled = `false`).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PlaceSelectiveForwardCallCriteriaPatch",
  "title": "PlaceSelectiveForwardCallCriteriaPatch",
  "type": "object",
  "required": [
    "callsFrom"
  ],
  "properties": {
    "forwardToPhoneNumber": {
      "type": "string",
      "example": "+1934898988",
      "description": "Phone number to forward calls to during this schedule."
    },
    "destinationVoicemailEnabled": {
      "type": "boolean",
      "description": "Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions."
    },
    "scheduleName": {
      "type": "string",
      "example": "Business Vacation",
      "description": "Name of the location's schedule which determines when the selective forward 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/CallsFromTypeForSelectiveForward",
      "description": "Indicates whether to apply the selective forward criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones."
    },
    "anonymousCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, enables selective forward to calls from anonymous callers."
    },
    "unavailableCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "When `true`, enables selective forward to calls if the callers are unavailable."
    },
    "numbers": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "+19075552859,+19186663950"
      },
      "description": "List of phone numbers checked against incoming calls for a match."
    },
    "forwardEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Indicates whether the calls, that fit within these parameters, will be forwarded (if forwardEnabled = `true`) or not (if forwardEnabled = `false`)."
    }
  }
}