Webex · Schema

GetSingleNumberReachObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
enabled boolean A flag to enable or disable single Number Reach.
alertAllNumbersForClickToDialCallsEnabled boolean Flag to enable alerting single number reach numbers for click to dial calls.
numbers array Array of single number reach number entries.
View JSON Schema on GitHub

JSON Schema

webex-getsinglenumberreachobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetSingleNumberReachObject",
  "title": "GetSingleNumberReachObject",
  "type": "object",
  "required": [
    "enabled",
    "numbers"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "A flag to enable or disable single Number Reach."
    },
    "alertAllNumbersForClickToDialCallsEnabled": {
      "type": "boolean",
      "description": "Flag to enable alerting single number reach numbers for click to dial calls."
    },
    "numbers": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "phoneNumber",
          "enabled",
          "name",
          "doNotForwardCallsEnabled",
          "answerConfirmationEnabled"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "Y2lzY29zcGFyazovL3VzL1NJTkdMRV9OVU1CRVJfUkVBQ0gvS3pFM01ERXhOVFU0TVRZNQ",
            "description": "ID of Single number reach. Note that this ID contains base64 encoded phoneNumber data and can change if the phone number is modified."
          },
          "phoneNumber": {
            "type": "string",
            "example": "+17011558169",
            "description": "The phone number that will ring when a call is received. The number should be in E.164 format."
          },
          "enabled": {
            "type": "boolean",
            "example": true,
            "description": "A flag to enable or disable this single Number Reach phone number."
          },
          "name": {
            "type": "string",
            "example": "myNumber",
            "description": "Name of the single number reach phone number entry."
          },
          "doNotForwardCallsEnabled": {
            "type": "boolean",
            "description": "If enabled, the call forwarding settings of provided phone Number will not be applied."
          },
          "answerConfirmationEnabled": {
            "type": "boolean",
            "description": "If enabled, the call recipient will be prompted to press a key before being connected."
          }
        }
      },
      "description": "Array of single number reach number entries."
    }
  }
}