.png?sv=2022-11-02&spr=https&st=2025-07-05T06%3A54%3A42Z&se=2025-07-05T07%3A04%3A42Z&sr=c&sp=r&sig=D6UtciEe979fl%2BF1vBlwhhELHylpwsPElowkrMGGxSA%3D){kind=logo}
Get Consult Agent List
- DarkLight
Get Consult Agent List
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API allows an Agent to fetch the list of available agents to consult.
Pre-requisite
The agent must be on an active customer call.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Amazon |
topic | OutboundCall |
subtopic | GetAgentList |
source | «app-name-broadcasting-this-message» |
data | External number to be consulted. |
Response Parameters | Value |
|---|---|
channel | Amazon |
topic | OutboundCall |
subtopic | SetAgentList |
source | JSON Array Agent List |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
id | String | Serial ID. | |
agentName | String | The agent name. | |
availableSince | String | The time from when an agent in the Available State. | |
agentStatus | String | The Agent Status. | |
waitingTimeSec | String | The waiting time, in seconds, to reach the agent. | |
Queue | String | NA | |
routingProfile | String | The routing profile mapped for the agent. | |
cpassUUID | String | The agent connection UUID. |
Possible Error Cases
Error Type | Code | Message |
|---|---|---|
AGENTLIST_FETCH_FAILED | Acqueon Campaigns Failure Error Message. | Agent list fetch failed. |
CONSULTLIST_FETCH_FAILED | Acqueon Campaigns Failure Error Message. | Consult list fetch failed. |
Sample Request
{
"channel": "Amazon",
"topic": "OutboundCall",
"subtopic": "GetAgentList",
"source": "myapp"
}Sample Response
{
"channel": "Amazon",
"topic": "OutboundCall",
"subtopic": "SetAgentList",
"message": [
{
"id": 2,
"agentName": "devuser1",
"availableSince": "2020-06-15T08:25:24.98",
"agentStatus": "Available",
"waitingTimeSec": "9",
"queue": "",
"routingProfile": "DevRoutingProfile",
"cpassUUID": "e956c056-bd47-4c69-bf26-9f01e3800b01"
}
}Was this article helpful?