Webex · Schema

GetAvailableAgentsCallQueueObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique agent identifier.
lastName	string	Last name of the agent assigned to the particular location.
firstName	string	First name of the agent assigned to the particular location. Defaults to ".".
displayName	string	(string, optional) - Display name of the agent.
type	object	Type of the person, workspace or virtual line.
email	string	Email of the agent.
hasCxEssentials	boolean	Denotes whether the agent has Customer Assist license.
phoneNumbers	object	Phone number and extension of the agent.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetAvailableAgentsCallQueueObject",
  "title": "GetAvailableAgentsCallQueueObject",
  "type": "object",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzE3NzczMWRiLWE1YzEtNGI2MC05ZTMwLTNhM2MxMGFiM2IxMQ",
      "description": "Unique agent identifier."
    },
    "lastName": {
      "type": "string",
      "example": "Smith",
      "description": "Last name of the agent assigned to the particular location."
    },
    "firstName": {
      "type": "string",
      "example": "John",
      "description": "First name of the agent assigned to the particular location. Defaults to \".\"."
    },
    "displayName": {
      "type": "string",
      "example": "John Smith",
      "description": "(string, optional) - Display name of the agent."
    },
    "type": {
      "$ref": "#/components/schemas/UserType",
      "description": "Type of the person, workspace or virtual line."
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "Email of the agent."
    },
    "hasCxEssentials": {
      "type": "boolean",
      "example": true,
      "description": "Denotes whether the agent has Customer Assist license."
    },
    "phoneNumbers": {
      "type": "object",
      "properties": {
        "external": {
          "type": "string",
          "example": "+12143456103",
          "description": "External phoneNumber of the agent."
        },
        "extension": {
          "type": "string",
          "example": "23234",
          "description": "Extension of the agent."
        }
      },
      "description": "Phone number and extension of the agent."
    }
  }
}