Webex · Schema

VirtualExtension

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier for the virtual extension.
firstName	string	First name of the virtual extension.
lastName	string	Last name of the virtual extension.
displayName	string	Full name of the virtual extension.
extension	string	Extension that the virtual extension is associated with.
phoneNumber	string	Phone number that the virtual extension is associated with.
locationName	string	Location name if the virtual extension is at the location level, empty if it is at the customer level.
locationId	string	Location ID if the virtual extension is at the location level, empty if it is at the customer level.
trunkName	string	Name of the trunk.
trunkId	string	Unique identifier of the trunk.
routeGroupName	string	Name of the route group.
routeGroupId	string	Unique identifier of the route group.
trunkLocationName	string	Location of the trunk; required if `trunkName` is returned.
trunkLocationId	string	Location ID of the trunk; required if `trunkName` is returned.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VirtualExtension",
  "title": "VirtualExtension",
  "type": "object",
  "required": [
    "id",
    "displayName",
    "extension",
    "phoneNumber"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OL2U4NTU0MGJjLWFiNDMtNGZjOS05ZThlLTkxZjRkN2E3ZjU5Ng",
      "description": "Unique identifier for the virtual extension."
    },
    "firstName": {
      "type": "string",
      "example": "firstName1",
      "description": "First name of the virtual extension."
    },
    "lastName": {
      "type": "string",
      "example": "lastName1",
      "description": "Last name of the virtual extension."
    },
    "displayName": {
      "type": "string",
      "example": "displayName1",
      "description": "Full name of the virtual extension."
    },
    "extension": {
      "type": "string",
      "example": "0007",
      "description": "Extension that the virtual extension is associated with."
    },
    "phoneNumber": {
      "type": "string",
      "example": "8701278963",
      "description": "Phone number that the virtual extension is associated with."
    },
    "locationName": {
      "type": "string",
      "example": "locationName1",
      "description": "Location name if the virtual extension is at the location level, empty if it is at the customer level."
    },
    "locationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
      "description": "Location ID if the virtual extension is at the location level, empty if it is at the customer level."
    },
    "trunkName": {
      "type": "string",
      "example": "trunkName1",
      "description": "Name of the trunk."
    },
    "trunkId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
      "description": "Unique identifier of the trunk."
    },
    "routeGroupName": {
      "type": "string",
      "example": "routeGroupName1",
      "description": "Name of the route group."
    },
    "routeGroupId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
      "description": "Unique identifier of the route group."
    },
    "trunkLocationName": {
      "type": "string",
      "example": "trunkLocationName1",
      "description": "Location of the trunk; required if `trunkName` is returned."
    },
    "trunkLocationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
      "description": "Location ID of the trunk; required if `trunkName` is returned."
    }
  }
}