Webex · Schema

PostNumberForSingleReachNumber

Represents a request to add a phone number for Single Number Reach.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
phoneNumber	string	Phone number.
name	string	Name associated with the phone number.
enabled	boolean	If `true`, the phone number is enabled.
doNotForwardCallsEnabled	boolean	Note that this setting attempts to prevent the Single Number Reach (SNR) destination from forwarding the call. The SNR destination may or may not respect the indication provided hence, it may still be
answerConfirmationEnabled	boolean	If `true`, answer confirmation is enabled. The default value is `false`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PostNumberForSingleReachNumber",
  "title": "PostNumberForSingleReachNumber",
  "type": "object",
  "description": "Represents a request to add a phone number for Single Number Reach.",
  "example": {
    "phoneNumber": "+19075552859",
    "name": "John",
    "enabled": true,
    "doNotForwardCallsEnabled": true,
    "answerConfirmationEnabled": false
  },
  "required": [
    "phoneNumber",
    "name",
    "enabled"
  ],
  "properties": {
    "phoneNumber": {
      "type": "string",
      "example": "+19075552859",
      "description": "Phone number."
    },
    "name": {
      "type": "string",
      "example": "John",
      "description": "Name associated with the phone number."
    },
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, the phone number is enabled."
    },
    "doNotForwardCallsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Note that this setting attempts to prevent the Single Number Reach (SNR) destination from forwarding the call. The SNR destination may or may not respect the indication provided hence, it may still be forwarded, and this setting has no impact on the user's own forwarding services."
    },
    "answerConfirmationEnabled": {
      "type": "boolean",
      "description": "If `true`, answer confirmation is enabled. The default value is `false`."
    }
  }
}