Webex · Schema

AvailableAgentListObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	A unique identifier for the agent.
firstName	string	First name of the agent.
lastName	string	Last name of the agent.
displayName	string	(string, optional) - Display name of the agent.
phoneNumber	string	Primary phone number of the agent.
extension	string	Primary phone extension of the agent.
routingPrefix	string	Routing prefix of location.
esn	string	Routing prefix + extension of a person.
type	object	Type of the person, workspace or virtual line.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AvailableAgentListObject",
  "title": "AvailableAgentListObject",
  "type": "object",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YzVlODRhMS0wZmEwLTQzNDAtODVkZC1mMzM1ZGQ4MTkxMmI",
      "description": "A unique identifier for the agent."
    },
    "firstName": {
      "type": "string",
      "example": "Adam",
      "description": "First name of the agent."
    },
    "lastName": {
      "type": "string",
      "example": "Sandler",
      "description": "Last name of the agent."
    },
    "displayName": {
      "type": "string",
      "example": "Adam Sandler",
      "description": "(string, optional) - Display name of the agent."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+19845550200",
      "description": "Primary phone number of the agent."
    },
    "extension": {
      "type": "string",
      "example": "0020",
      "description": "Primary phone extension of the agent."
    },
    "routingPrefix": {
      "type": "string",
      "example": "34543",
      "description": "Routing prefix of location."
    },
    "esn": {
      "type": "string",
      "example": "345430020",
      "description": "Routing prefix + extension of a person."
    },
    "type": {
      "$ref": "#/components/schemas/UserType",
      "description": "Type of the person, workspace or virtual line."
    }
  }
}