Webex · Schema

SelectiveForwardCallCriteriaPatch

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
forwardToPhoneNumber string Number to which calls needs to be forwarded.
sendToVoicemailEnabled boolean Boolean flag to enable/disable sending calls to voicemail.
scheduleName string Name of the schedule to which the criteria is created.
scheduleType object The type of schedule.
scheduleLevel object The schedule level of the criteria.
callsFrom object Reject calls selection.
anonymousCallersEnabled boolean Boolean flag indicating if calls from custom numbers, private numbers are enabled.
unavailableCallersEnabled boolean Boolean flag indicating if calls from custom numbers, unavailable numbers are enabled.
phoneNumbers array List of phone numbers. It does not include extensions. In some regions phone numbers are not returned in E.164 format. This will be supported in a future update.
forwardEnabled boolean Boolean flag to enable/disable selective call forwarding.
View JSON Schema on GitHub

JSON Schema

webex-selectiveforwardcallcriteriapatch-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SelectiveForwardCallCriteriaPatch",
  "title": "SelectiveForwardCallCriteriaPatch",
  "type": "object",
  "required": [
    "forwardToPhoneNumber",
    "sendToVoicemailEnabled",
    "callsFrom"
  ],
  "properties": {
    "forwardToPhoneNumber": {
      "type": "string",
      "example": "+18898988831",
      "description": "Number to which calls needs to be forwarded."
    },
    "sendToVoicemailEnabled": {
      "type": "boolean",
      "description": "Boolean flag to enable/disable sending calls to voicemail."
    },
    "scheduleName": {
      "type": "string",
      "example": "CFS-Criteria-F-2",
      "description": "Name of the schedule to which the criteria is created."
    },
    "scheduleType": {
      "$ref": "#/components/schemas/ScheduleType",
      "description": "The type of schedule."
    },
    "scheduleLevel": {
      "$ref": "#/components/schemas/ScheduleLevel",
      "description": "The schedule level of the criteria."
    },
    "callsFrom": {
      "$ref": "#/components/schemas/CallsFromSelectiveReject",
      "description": "Reject calls selection."
    },
    "anonymousCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Boolean flag indicating if calls from custom numbers, private numbers are enabled."
    },
    "unavailableCallersEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Boolean flag indicating if calls from custom numbers, unavailable numbers are enabled."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "[\"+1986751234\",\"+1986751234\"]"
      },
      "description": "List of phone numbers. It does not include extensions. In some regions phone numbers are not returned in E.164 format. This will be supported in a future update."
    },
    "forwardEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Boolean flag to enable/disable selective call forwarding."
    }
  }
}