Get Agent Details
- DarkLight
Get Agent Details
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
The GetAgentDetails API provides Agent-related information such as name, login state, Routing profile, and more.
Pre-requisite
The agent must be in the Logged in state.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Amazon |
topic | Agent |
subtopic | GetAgentDetails |
source | <<app-name-broadcasting-this-message>> |
Response Parameters | Value |
|---|---|
channel | Amazon |
topic | Agent |
subtopic | GetAgentDetails |
message | JSON Object |
Message Parameters
Parameters | Data Type | Description | Example Data |
|---|---|---|---|
loginState | Enum | Login state of agent. Possible values: Refer AgentLoginState in Appendix. | LoggedIn |
agentInfo | JSON Object | User details of agent. Refer AgentInfo in Appendix. | NA |
agentState | JSON Object | Current state of agent. Refer AgentState in Appendix. | Null |
rules | JSON Object | It contains list of buttons and their states. Refer Rules in Appendix. | Null |
Sample Request
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "GetAgentDetails",
"source": "myapp"
}Sample Response
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "GetAgentDetails",
"message": {
"loginState": "LoggedIn",
"agentInfo": {
"muted": false,
"name": "testagent",
"extension": "",
"loginName": "[email protected]",
"softphoneEnabled": true,
"routingProfile": {
"name": "sample-Tethered",
"routingProfileARN": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/routing-profile/34e54d17-db23-4bea-83a4-651236d429cf",
"defaultOutboundQueue": {
"queueARN": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/queue/be616462-57d0-443b-b1af-bd084bc567ff",
"name": "sample-Tethered",
"queueId": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/queue/be616462-57d0-443b-b1af-bd084bc567ff"
},
"channelConcurrencyMap": {
"VOICE": 1
},
"queues": [
{
"queueARN": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/queue/be616462-57d0-443b-b1af-bd084bc567ff",
"name": "sample-Tethered",
"queueId": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/queue/be616462-57d0-443b-b1af-bd084bc567ff"
},
{
"queueARN": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/queue/e5f5f6fe-546d-4864-9988-0bcabafb75f8",
"name": "BasicQueue",
"queueId": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/queue/e5f5f6fe-546d-4864-9988-0bcabafb75f8"
},
{
"queueARN": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/queue/agent/9f6d65a9-5e5d-40b6-8270-955ee79189e4",
"name": null,
"queueId": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/queue/agent/9f6d65a9-5e5d-40b6-8270-955ee79189e4"
}
],
"routingProfileId": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/routing-profile/34e54d17-db23-4bea-83a4-651236d429cf"
}
},
"agentState": {
"agentStateARN": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/agent-state/682c94ac-db07-4ae7-820f-0e97274d376d",
"type": "not_routable",
"name": "Rest",
"startTimestamp": "2024-02-14T11:38:27.253Z",
"availabilityState": "Rest"
},
"rules": {
"ButtonStates": {
"items": {
"NotReady": "Enable",
"Ready": "Enable",
"make_call": "Enable",
"mute": "Enable",
"unmute": "Hide"
},
"count": 5
},
"ResponseActual": {
"agentStateARN": "arn:aws:connect:us-east-1:873558693027:instance/dcd51b41-5d7c-4f0e-9905-2985cde7c02b/agent-state/682c94ac-db07-4ae7-820f-0e97274d376d",
"type": "not_routable",
"name": "Rest",
"startTimestamp": "2024-02-14T11:38:27.253Z",
"availabilityState": "Rest"
}
}
}
}Was this article helpful?