Webex · Schema

UserNumber

Details of a phone number associated with the user.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
directNumber	string	Direct number of the user.
enterprise	string	Enterprise number of the user. This always combines the location routing prefix with the user's extension, and is only present when both are present. That is, the location has a routing prefix and the
extension	string	Extension of the user. This is always the user's extension, only present if the user has an extension.
routingPrefix	string	Routing prefix of the user.
esn	string	Enterprise Significant Number. This combines the location routing prefix and extension when both are set, and only the extension when the location routing prefix is not set. if the extension is not se
primary	boolean	Indicates if the number is primary or alternate number.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserNumber",
  "title": "UserNumber",
  "type": "object",
  "description": "Details of a phone number associated with the user.",
  "example": {
    "directNumber": "+441234222304",
    "enterprise": "832731599",
    "extension": "31599",
    "routingPrefix": "8327",
    "esn": "832731599",
    "primary": true
  },
  "required": [
    "directNumber",
    "enterprise",
    "extension",
    "routingPrefix",
    "esn",
    "primary"
  ],
  "properties": {
    "directNumber": {
      "type": "string",
      "example": "+441234222304",
      "description": "Direct number of the user."
    },
    "enterprise": {
      "type": "string",
      "example": "832731599",
      "description": "Enterprise number of the user. This always combines the location routing prefix with the user's extension, and is only present when both are present. That is, the location has a routing prefix and the user has an extension."
    },
    "extension": {
      "type": "string",
      "example": "31599",
      "description": "Extension of the user. This is always the user's extension, only present if the user has an extension."
    },
    "routingPrefix": {
      "type": "string",
      "example": "8327",
      "description": "Routing prefix of the user."
    },
    "esn": {
      "type": "string",
      "example": "832731599",
      "description": "Enterprise Significant Number. This combines the location routing prefix and extension when both are set, and only the extension when the location routing prefix is not set. if the extension is not set, the esn is not present."
    },
    "primary": {
      "type": "boolean",
      "example": true,
      "description": "Indicates if the number is primary or alternate number."
    }
  }
}