.png?sv=2022-11-02&spr=https&st=2025-12-26T03%3A00%3A14Z&se=2025-12-26T03%3A10%3A14Z&sr=c&sp=r&sig=NmPdbaJOjmtyMoC%2BZYKKlnTqfMaGpcFIOWg7KjSy%2F7U%3D){kind=logo}
Get Queue Details
- DarkLight
Get Queue Details
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API fetches a list of all queues associated with a logged-in user.
Pre-requisite
The Agent must be logged in to the softphone.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Cisco |
topic | Queue |
subtopic | GetQueueInfo |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Request Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
username | String | The loggd-in agent ID. | 1347688 |
Response Parameters
Response Parameters | Value |
|---|---|
channel | Cisco |
topic | Queue |
subtopic | SetQueueInfo |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Response Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
packet | String | Name of the packet. | QueueInfo |
data | JSON Object | The data object. | NA |
Data Parameters | |||
name | String | The queue name. | CollectionSK1 |
statistics | JSON Object | A list of statistics for the queue. | NA |
Statistics Parameters | |||
agentsBusyOther | String | Number of agents currently Busy with calls. | 2 |
agentsLoggedOn | String | Number of agents logged in to the application. | 3 |
agentsNotReady | String | Number of agents assigned to the queue, in the Not Ready state. | 2 |
agentsReady | String | Number of agents, assigned to the queue, in the Ready state. | 1 |
agentsTalkingInbound | String | Number of agents, assigned to the queue, in Talking state on inbound calls. | 2 |
agentsTalkingInternal | String | Number of agents, assigned to the queue, who are in Talking state on internal calls. Internal calls are consult calls. When an agent on a routed call initiates an internal consult call, this statistic is incremented for the queue associated with the original call. | 1 |
agentsTalkingOutbound | String | Number of agents, assigned to the queue, in Talking state on outbound calls. | 2 |
agentsWrapUpNotReady | String | Number of agents, assigned to the queue, in the Work Not Ready state. | 2 |
agentsWrapUpReady | String | Number of agents, assigned to the queue, in the Work Not Ready state. | 1 |
callsInQueue | String | Number of calls currently assigned to this queue. | 7 |
uri | String | The URI to get a new copy of the Queue object. | /finesse/api/User/1234 |
Sample Request
{
"channel": "Cisco",
"topic": "Queue",
"subtopic": "GetQueueInfo",
"data":
{
"username": "16786021"
}
}Sample Response
{
"channel": "Cisco",
"topic": "General",
"subtopic": "SetQueuesInfo",
"message": {
"packet": "QueuesInfo",
"data": [
{
"name": "arulsk2",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "0",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/4003"
},
{
"name": "arulsk1",
"statistics": {
"agentsNotReady": "1",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "1",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/6534"
},
{
"name": "arulsk4",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "0",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/3420"
},
{
"name": "Arul_IB",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "0",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/32567"
},
{
"name": "arulsk3",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "0",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/4520"
},
{
"name": "sfpred",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "0",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/3344"
},
{
"name": "kore_SK",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "1",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "1",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/4231"
}
],
"rules": {
"SequentialActions": {
"items": {},
"count": 1
},
"ResponseType": 0,
"ResponseText": "Success",
"ResponseActual": [
{
"name": "arulsk2",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "0",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/4003"
},
{
"name": "arulsk1",
"statistics": {
"agentsNotReady": "1",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "1",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/6534"
},
{
"name": "arulsk4",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "0",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/3420"
},
{
"name": "Arul_IB",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "0",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/32567"
},
{
"name": "arulsk3",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "0",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/4520"
},
{
"name": "sfpred",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "0",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "0",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/3344"
},
{
"name": "kore_SK",
"statistics": {
"agentsNotReady": "0",
"agentsReady": "1",
"agentsTalkingInbound": "0",
"agentsTalkingInternal": "0",
"agentsTalkingOutbound": "0",
"agentsWrapUpNotReady": "0",
"agentsWrapUpReady": "0",
"callsInQueue": "0",
"agentsLoggedOn": "1",
"agentsBusyOther": "0"
},
"uri": "/finesse/api/Queue/4231"
}
]
}
}
}Was this article helpful?