Get Agent States
- DarkLight
Get Agent States
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
The GetAgentStates API allows a user to get all the states configured for the Agent in an Amazon Instance.
Pre-requisite
The agent must be in the Logged in state.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Amazon |
topic | Agent |
subtopic | GetStates |
source | <<app-name-broadcasting-this-message>> |
Response Parameters | Value |
|---|---|
channel | Amazon |
topic | Agent |
subtopic | GetStates |
message | JSON Object |
Message Parameters
Parameters | Data Type | Description | Example Data |
|---|---|---|---|
label |
| Label of agent state. | Not Ready, Available, Offline |
code | JSON Object | Given code of agent state. | Not Ready, Available, Offline |
type | JSON Object | Type of agent state. | Not_routable, Routable, Offline |
Sample Request
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "GetAgentState",
"source": "myapp"
}Sample Response
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "SetAgentState",
"message": {
"rules": {
"ButtonStates": {
"items": {
"NotReady": "Enable",
"Ready": "Hide",
"make_call": "Enable",
"mute": "Enable",
"unmute": "Hide"
},
"count": 5
},
"ResponseActual": {
"agentStateARN": null,
"type": "routable",
"name": "Ready",
"startTimestamp": "2020-04-09T13:35:22.838Z"
}
},
"data": {
"muted": false,
"name": "Agent 1",
"extension": "",
"loginName": "agent1",
"softphoneEnabled": true,
"state": "Ready",
"stateChangeTime": "2020-04-09T13:35:22.838Z",
"type": "routable"
},
"event": "Ready",
"source": "event"
}
}Was this article helpful?