Webex · Schema

GetVirtualExtensionObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	ID of the virtual extension.
extension	string	Extension of the virtual extension.
routingPrefix	string	Routing prefix of the virtual extension's location.
esn	string	ESN of the virtual extension.
phoneNumber	string	Directory number of the virtual extension.
firstName	string	First name of the person at the virtual extension.
lastName	string	Last name of the person at the virtual extension.
level	string	Level of the virtual extension. It can be either `ORGANIZATION` or `LOCATION`. * `ORGANIZATION` - Organization level. * `LOCATION` - Location level.
locationId	string	ID of the location to which the virtual extension is assigned. The location ID is a unique identifier for the location in Webex Calling.
locationName	string	Name of the location to which the virtual extension is assigned.
displayName	string	Display name of the person at the virtual extension.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetVirtualExtensionObject",
  "title": "GetVirtualExtensionObject",
  "type": "object",
  "required": [
    "id",
    "extension",
    "esn",
    "phoneNumber",
    "level",
    "displayName"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OLzZkNmYwNmVlLTdkNDEtNDQ4Yy05MjgwLWZkM2ZiMDhmOGUyMA",
      "description": "ID of the virtual extension."
    },
    "extension": {
      "type": "string",
      "example": "5001",
      "description": "Extension of the virtual extension."
    },
    "routingPrefix": {
      "type": "string",
      "example": "4321",
      "description": "Routing prefix of the virtual extension's location."
    },
    "esn": {
      "type": "string",
      "example": "43215001",
      "description": "ESN of the virtual extension."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+6692515287",
      "description": "Directory number of the virtual extension."
    },
    "firstName": {
      "type": "string",
      "example": "John",
      "description": "First name of the person at the virtual extension."
    },
    "lastName": {
      "type": "string",
      "example": "John",
      "description": "Last name of the person at the virtual extension."
    },
    "level": {
      "type": "string",
      "enum": [
        "ORGANIZATION",
        "LOCATION"
      ],
      "description": "Level of the virtual extension. It can be either `ORGANIZATION` or `LOCATION`.\n * `ORGANIZATION` - Organization level.\n * `LOCATION` - Location level.\n"
    },
    "locationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2QzYjA4MGMwLWU1MjctNDQ1Zi04NTk5LTU5OWJmNzQ2MjViNg",
      "description": "ID of the location to which the virtual extension is assigned. The location ID is a unique identifier for the location in Webex Calling."
    },
    "locationName": {
      "type": "string",
      "example": "Test1",
      "description": "Name of the location to which the virtual extension is assigned."
    },
    "displayName": {
      "type": "string",
      "example": "John Smith",
      "description": "Display name of the person at the virtual extension."
    }
  }
}