.png?sv=2022-11-02&spr=https&st=2025-12-21T10%3A35%3A14Z&se=2025-12-21T10%3A45%3A14Z&sr=c&sp=r&sig=dbp7J71N%2FpRY8e355NxZo5sdQ4HaJKg3EUihCZOy5aY%3D){kind=logo}
Update State
- DarkLight
Update State
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
This API allows a developer to update the Agent state change.
Pre-requisite
The agent must be in the LoggedIn state.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Amazon |
topic | Agent |
subtopic | Update |
source | «app-name-broadcasting-this-message» |
data | JSON Object |
Data Parameters
Parameters | Data Type | Description | Example Data |
|---|---|---|---|
label | String | Label of agent state. | Not Ready, Available, Offline |
code | String | Given code of agent state. | Not Ready, Available, Offline |
type | String | Type of agent state. | Not Routable, Routable, Offline |
Response Parameters | Value |
|---|---|
channel | Not Applicable |
topic | Not Applicable |
subtopic | Not Applicable |
message | Not Applicable |
Possible Error Cases
Error Type | Error Message |
|---|---|
UPDATE_AGENT_STATE_FAILED | Agent state change failed. |
AGENT_STATE_NOT_FOUND | Specified Agent State not found. |
Sample Request
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "UpdateState",
"data": {
"label": "Available",
"code": "Available",
"type": "routable"
}
}Sample Response
Below are the set of events:
SetAgentState
CcpAgentState
SetAgentDetails
SetNailupDetails
Was this article helpful?