Webex · Schema

PersonPrimaryAvailableNumberObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
phoneNumber string A unique identifier for the phone number.
state object Phone number's state.
isMainNumber boolean If the phone number is used as a location CLID.
telephonyType string The telephony type for the number. * `PSTN_NUMBER` - The object is a PSTN number. * `MOBILE_NUMBER` - The object is a mobile number.
mobileNetwork string Mobile Network for the number if the number's `telephonyType` is `MOBILE_NUMBER`.
routingProfile string Routing Profile for the number if the number's `telephonyType` is `MOBILE_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-personprimaryavailablenumberobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PersonPrimaryAvailableNumberObject",
  "title": "PersonPrimaryAvailableNumberObject",
  "type": "object",
  "required": [
    "phoneNumber",
    "state",
    "isMainNumber",
    "telephonyType",
    "isServiceNumber"
  ],
  "properties": {
    "phoneNumber": {
      "type": "string",
      "example": "+12056350001",
      "description": "A unique identifier for the phone number."
    },
    "state": {
      "$ref": "#/components/schemas/STATE",
      "description": "Phone number's state."
    },
    "isMainNumber": {
      "type": "boolean",
      "example": true,
      "description": "If the phone number is used as a location CLID."
    },
    "telephonyType": {
      "type": "string",
      "enum": [
        "PSTN_NUMBER",
        "MOBILE_NUMBER"
      ],
      "description": "The telephony type for the number.\n * `PSTN_NUMBER` - The object is a PSTN number.\n * `MOBILE_NUMBER` - The object is a mobile number.\n"
    },
    "mobileNetwork": {
      "type": "string",
      "example": "mobileNetwork",
      "description": "Mobile Network for the number if the number's `telephonyType` is `MOBILE_NUMBER`."
    },
    "routingProfile": {
      "type": "string",
      "example": "AttRtPf",
      "description": "Routing Profile for the number if the number's `telephonyType` is `MOBILE_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."
    }
  }
}