Webex · Schema

SelectiveForwardCallSettingsGet

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
enabled boolean `true` if the Selective Forward feature is enabled.
defaultPhoneNumberToForward string The phone number to which calls are forwarded by default when the criteria conditions are met.
ringReminderEnabled boolean If `true`, a brief tone will be played on the person's phone when a call has been forwarded.
destinationVoicemailEnabled boolean Indicates whether calls that meet the criteria are forwarded to the destination phone number's voicemail.
criteria array A list of criteria specifying conditions when selective accept is in effect.
View JSON Schema on GitHub

JSON Schema

webex-selectiveforwardcallsettingsget-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SelectiveForwardCallSettingsGet",
  "title": "SelectiveForwardCallSettingsGet",
  "type": "object",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "`true` if the Selective Forward feature is enabled."
    },
    "defaultPhoneNumberToForward": {
      "type": "string",
      "description": "The phone number to which calls are forwarded by default when the criteria conditions are met.",
      "example": "+16175550100"
    },
    "ringReminderEnabled": {
      "type": "boolean",
      "description": "If `true`, a brief tone will be played on the person's phone when a call has been forwarded.",
      "example": false
    },
    "destinationVoicemailEnabled": {
      "type": "boolean",
      "description": "Indicates whether calls that meet the criteria are forwarded to the destination phone number's voicemail.",
      "example": false
    },
    "criteria": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SelectiveForwardCallCriteria"
      },
      "description": "A list of criteria specifying conditions when selective accept is in effect."
    }
  },
  "example": {
    "enabled": true,
    "defaultPhoneNumberToForward": "+16175550100",
    "ringReminderEnabled": false,
    "destinationVoicemailEnabled": false,
    "criteria": [
      {
        "id": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
        "scheduleName": "CustomHoliday(Group)",
        "source": "ALL_NUMBERS",
        "forwardEnabled": true
      }
    ]
  }
}