.png?sv=2022-11-02&spr=https&st=2025-12-29T18%3A38%3A32Z&se=2025-12-29T18%3A48%3A32Z&sr=c&sp=r&sig=WYR2C%2B8pr1GIR9BT9wJghcRvoX5yaa4b%2FP7dBERY%2BDQ%3D){kind=logo}
Logout
- DarkLight
Logout
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This event is triggered when an Agent logs out from the Five9 softphone.
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 | Login state of the agent. | logout |
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. | logout |
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": "300000001745182",
"loginName": "Five9@acqueon.com",
"state": "logout",
"stateChangeTime": "2024-03-21T07:18:11.778Z",
"agentType": "not_routable"
},
"event": "logout",
"source": "event"
}
}Was this article helpful?