.png?sv=2022-11-02&spr=https&st=2026-02-24T19%3A44%3A32Z&se=2026-02-24T19%3A54%3A32Z&sr=c&sp=r&sig=XOJyakBQKN3VbL96reRWe80HCHFO%2FEVS0teiB9xmxjA%3D){kind=logo}
Login
- DarkLight
Login
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This event is received when an Agent logs in to Genesys Cloud with valid credentials.
Pre-requisite
The agent must register with a Genesys channel and be in the Logout state.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
No request parameter |
Response Parameters | Value |
|---|---|
channel | Genesys |
topic | Agent |
subtopic | SetAgentState |
message | JSON Object |
Message Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
event | String | The agent state value. | Login,Logout,OnQueue, Available,Busy,Away,Break,Meal,Meeting,Training |
source | String | Static field. In Genesys, fixed events (values) are used for standard response fields. | event |
data | JSON Object | Current agent data with default values. |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
name | String | The agent name. | Test agent |
loginName | String | The Genesys agent log in value. | testagent.a@domain.com |
state | String | Genesys system Presence value that indicates the current agent state, such as 'login' or 'logout'. | Login,Logout,OnQueue, Available,Busy,Away,Break,Meal,Meeting,Training |
stateChangeTime | String | The current date and time value | a729f683-06d0-47e6-bf74-7130e9bd29ed |
agentType | String | Agent type value | alerting,connected,disconnected,ACW,terminated,held,dialing |
Sample Request
No sample requestSample Response 1
{
"channel": "Genesys",
"topic": "Agent",
"subtopic": "SetAgentState",
"message": {
"data": {
"name": "Test Agent",
"loginName": " testagent.a@testdomain.com",
"state": "login",
"stateChangeTime": "2024-03-14T12:36:39.702Z",
"agentType": "not_routable"
},
"event": "login",
"source": "event"
}Sample Response 2
{
"channel": "Genesys",
"topic": "Agent",
"subtopic": "SetAgentState",
"message": {
"data": {
"name": "Test Agent ",
"loginName": " testagent.a@testdomain.com",
"state": " On Queue",
"stateChangeTime": "2024-03-14T12:36:39.702Z",
"agentType": "routable"
},
"event": "login",
"source": "event"
}Sample Response 3
{
"channel": "Genesys",
"topic": "Agent",
"subtopic": "SetAgentState",
"message": {
"data": {
"name": "Test Agent",
"loginName": "testagent.a@testdomain.com",
"state": "Available",
"stateChangeTime": " 2024-03-21T09:55:10.080Z ",
"agentType": "not_routable"
},
"event": "Available",
"source": "event"
}
}Compatible Workspace Version
3.19.2403 onwards
Was this article helpful?