Webex · Schema

ListCallQueueAgentObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique call queue agent identifier.
firstName	string	First name for the call queue agent.
lastName	string	Last name for the call queue agent.
phoneNumber	string	Primary phone number of the call queue agent.
extension	string	Primary phone extension of the call queue agent.
routingPrefix	string	Routing prefix of the call queue agent.
esn	string	Routing prefix + extension of a agent.
queueCount	number	Denotes the queue count for call queue agent.
locationCount	number	Denotes the location count for call queue agent.
joinCount	number	Denotes the join count for call queue agent.
unjoinCount	number	Denotes unjoin count for call queue agent.
location	object	The location information.
type	string	The type of the call queue agent.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListCallQueueAgentObject",
  "title": "ListCallQueueAgentObject",
  "type": "object",
  "required": [
    "id",
    "firstName",
    "lastName",
    "queueCount",
    "locationCount",
    "joinCount",
    "unjoinCount",
    "location",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zYjY4Yjg2YS1hMTZiLTRmNzItOTlmZi01ZDlhZjgyZWNmNTE",
      "description": "Unique call queue agent identifier."
    },
    "firstName": {
      "type": "string",
      "example": "test_301_person_phone_extnsion",
      "description": "First name for the call queue agent."
    },
    "lastName": {
      "type": "string",
      "example": "last_nam",
      "description": "Last name for the call queue agent."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+15558675309",
      "description": "Primary phone number of the call queue agent."
    },
    "extension": {
      "type": "string",
      "example": "23234",
      "description": "Primary phone extension of the call queue agent."
    },
    "routingPrefix": {
      "type": "string",
      "example": "8002",
      "description": "Routing prefix of the call queue agent."
    },
    "esn": {
      "type": "string",
      "example": "23234",
      "description": "Routing prefix + extension of a agent."
    },
    "queueCount": {
      "type": "number",
      "example": 1,
      "description": "Denotes the queue count for call queue agent."
    },
    "locationCount": {
      "type": "number",
      "example": 1,
      "description": "Denotes the location count for call queue agent."
    },
    "joinCount": {
      "type": "number",
      "example": 1,
      "description": "Denotes the join count for call queue agent."
    },
    "unjoinCount": {
      "type": "number",
      "description": "Denotes unjoin count for call queue agent."
    },
    "location": {
      "type": "object",
      "required": [
        "name",
        "id"
      ],
      "properties": {
        "name": {
          "type": "string",
          "example": "Location2",
          "description": "The location name where the call queue agent resides."
        },
        "id": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVmMDI3OGZlLWU4OGMtNDMzNy04MGViLWRjY2NiM2VlMDU1MA",
          "description": "ID of location for call queue agent."
        }
      },
      "description": "The location information."
    },
    "type": {
      "type": "string",
      "example": "PEOPLE",
      "description": "The type of the call queue agent."
    }
  }
}