Webex · Schema

HuntGroupPrimaryAvailableNumberObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
phoneNumber string A unique identifier for the PSTN phone number.
state object Phone number's state.
isMainNumber boolean If `true`, the phone number is used as a location CLID.
tollFreeNumber boolean If `true`, the phone number is a toll-free number.
telephonyType object The telephony type for the number.
isServiceNumber boolean If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free.
View JSON Schema on GitHub

JSON Schema

webex-huntgroupprimaryavailablenumberobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HuntGroupPrimaryAvailableNumberObject",
  "title": "HuntGroupPrimaryAvailableNumberObject",
  "type": "object",
  "required": [
    "phoneNumber",
    "state",
    "isMainNumber",
    "tollFreeNumber",
    "telephonyType",
    "isServiceNumber"
  ],
  "properties": {
    "phoneNumber": {
      "type": "string",
      "example": "+12056350001",
      "description": "A unique identifier for the PSTN phone number."
    },
    "state": {
      "$ref": "#/components/schemas/STATE",
      "description": "Phone number's state."
    },
    "isMainNumber": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, the phone number is used as a location CLID."
    },
    "tollFreeNumber": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, the phone number is a toll-free number."
    },
    "telephonyType": {
      "$ref": "#/components/schemas/TelephonyType",
      "description": "The telephony type for the number."
    },
    "isServiceNumber": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free."
    }
  }
}