Webex · Schema
GetCallQueueAgentObject
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| agent | object | |
| queues | array |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GetCallQueueAgentObject",
"title": "GetCallQueueAgentObject",
"type": "object",
"required": [
"agent",
"queues"
],
"properties": {
"agent": {
"type": "object",
"required": [
"id",
"firstName",
"lastName",
"location",
"type"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xZmNiMjczZS0wYzdmLTQ1ZGUtYmNlOC0yMWE3YzFlYjVjYmY",
"description": "A unique identifier for the call queue agent."
},
"firstName": {
"type": "string",
"example": "Arthur",
"description": "First name for the call queue agent."
},
"lastName": {
"type": "string",
"example": "Murray",
"description": "last name for the call queue agent."
},
"phoneNumber": {
"type": "string",
"example": "19728881234",
"description": "Primary phone number of the call queue agent."
},
"extension": {
"type": "string",
"example": "34543",
"description": "Primary phone extension of the call queue agent."
},
"esn": {
"type": "string",
"example": "34543180",
"description": "Routing prefix + extension of a agent."
},
"location": {
"type": "object",
"required": [
"name",
"id"
],
"properties": {
"name": {
"type": "string",
"example": "RCDN",
"description": "The location name where the call queue agent resides."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw",
"description": "ID of location for call queue agent."
}
},
"description": "The location information."
},
"type": {
"type": "string",
"example": "PEOPLE",
"description": "TIMEhe type of the call queue agent."
}
}
},
"queues": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"routingPrefix",
"locationId",
"locationName",
"joinEnabled"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvZjM4NDIxZGYtN2MxOC00NGI1LThlNmQtNDFmZTEyMTFlZDFk",
"description": "Unique identifier of the call queue."
},
"name": {
"type": "string",
"example": "YU7",
"description": "Unique name for the call queue."
},
"phoneNumber": {
"type": "string",
"example": "12144184002",
"description": "Primary phone number of the call queue."
},
"routingPrefix": {
"type": "string",
"example": "34543",
"description": "The routing prefix for the call queue."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw",
"description": "The location identifier of the call queue."
},
"locationName": {
"type": "string",
"example": "RCDN",
"description": "The location name where the call queue resides."
},
"joinEnabled": {
"type": "boolean",
"example": true,
"description": "Whether or not the call queue is enabled."
}
}
}
}
}
}