.png?sv=2022-11-02&spr=https&st=2025-12-29T17%3A15%3A53Z&se=2025-12-29T17%3A25%3A53Z&sr=c&sp=r&sig=QJptAt5sazudESvq5CiKCujrZu0Yxokukrt9H9kSnK4%3D){kind=logo}
Login
- DarkLight
Login
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This event is triggered when an Agent successfully logs in to the Five9 platform using valid credentials.
Pre-requisite
The agent must be registered to a Five9 channel and must be in the logout 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 | Login state of the agent. | login |
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 | Current agent data with default values. | Five9@acqueon.com |
state | String | The fixed value 'Login' indicating that the agent has logged in. | login |
stateChangeTime | String | The date and time when the state change occurred. | 2024-03-14T12:36:39.702Z |
agentType | String | The agent type. | not_routable |
Sample Request
Not applicableSample Response
{
"channel": "Five9",
"topic": "Agent",
"subtopic": "SetAgentState",
"message": {
"data": {
"extension": "300000001765949",
"loginName": "Five9@acqueon.com",
"state": "login",
"stateChangeTime": "2024-03-14T12:36:39.702Z",
"agentType": "not_routable"
},
"event": "login",
"source": "event"
}Was this article helpful?