.png?sv=2022-11-02&spr=https&st=2025-12-29T18%3A37%3A07Z&se=2025-12-29T18%3A47%3A07Z&sr=c&sp=r&sig=0QaDMTpKh7IJXu3lh1obVDkwxdzpojSZLgmAfYsvsCQ%3D){kind=logo}
Ready State
- DarkLight
Ready State
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This event is received when the Agent changes state to Ready.
Pre-requisite
The agent must be registered to a Five9 channel and must be in the login state.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
No request parameter |
Message Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
No message parameters |
Response Parameters | Value |
|---|---|
channel | Five9 |
topic | Agent |
subtopic | SetAgentState |
message | JSON Object |
Message Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
event | String | The state code associated with the agent. | 0 |
source | String | This is a static field. | event |
data | JSON Object | The current agent data with default values. | NULL |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
extension | String | The user ID for the logged-in agent. | 300000001765949 |
loginName | String | Login user email address. | Five9@acqueon.com |
state | String | The Five9 agent state code value. | 0 |
stateChangeTime | String | The date and time when the state change occurred. | 2024-03-14T12:36:39.702Z |
agentType | String | Specifies the agent type, marked as 'routable' in the case of state code '0'. Else, marked as 'non-routable'. | routable |
Sample Request
Not applicableSample Response
{
"channel": "Five9",
"topic": "Agent",
"subtopic": "SetAgentState",
"message": {
"data": {
"extension": "300000001745182",
"loginName": "Five9@acqueon.com",
"state": "0",
"stateChangeTime": "2024-03-21T07:19:55.558Z",
"agentType": "routable"
},
"event": "0",
"source": "event"
}
}Agent type is routable because state value is equal to 0, which means Ready.
For other agent states response structure is the same. Only the agent Type value is not_routable and event code is as selected. See the below table.
Code | Description |
|---|---|
0 | Ready |
XXXX | break, away, busy, training, etc.
|
Was this article helpful?