.png?sv=2022-11-02&spr=https&st=2026-02-24T00%3A58%3A30Z&se=2026-02-24T01%3A08%3A30Z&sr=c&sp=r&sig=KD2QUajaVUd0fnkV6TzuIhi7xbuJ5o87XhdIq3gE0Z8%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 logs into the Finesse agent desktop with valid credentials.
Pre-requisite
The agent must register in the Finesse channel and be in the signed-out state on the Finesse agent desktop.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
No request parameter |
Response Parameters
Response Parameters | Value |
|---|---|
channel | Finesse |
topic | Agent |
subtopic | Login |
message | JSON Object |
Message Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
event | String | The log in state of the agent. | login |
source | String | The source of the response. | event |
data | JSON Object | Current agent data with default values. | Null |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
extension | String | Agent extension number received from Finesse. | 5024 |
loginName | String | Current agent username received from Finesse. | ehragent3 |
name | String | Agent's first and last name received from Finesse. | ehragent3 ehragent3 |
loginID | String | Unique identifier assigned to a user for authentication, received from Finesse. | 812508198 |
mediaType | String | Code representing the type of media content received from Finesse. Currently, "1" is received, representing "Voice". | 1 |
teamId | String | Unique identifier assigned to a specific Team received from Finesse. | 5014 |
teamName | String | Name assigned to a team received from Finesse. | EHRTesting |
state | String | Assigned value "login" when the agent is logged into the Finesse agent desktop. | Login |
stateChangeTime | String | Date and time value for agent login into the Finesse agent desktop. The format is YYYY-MM-DDThh:MM:SSSZ. | 2024-04-22T11:28:06.628Z |
agentType | String | The status and context of an agent. It will be "non_routable" for the login state. | non_routable |
Sample Request
No sample requestSample Response
{
"channel": "Finesse",
"topic": "Agent",
"subtopic": "SetAgentState",
"message": {
"data": {
"name": "ehragent3 ehragent3",
"extension": "5024",
"loginName": "ehragent3",
"loginId": "812508198",
"mediaType": "1",
"teamId": "5014",
"teamName": "EHRTesting",
"reasonCode": "login",
"state": "login",
"stateChangeTime": "2024-04-22T11:28:06.628Z",
"agentType": "not_routable"
},
"event": "login",
"source": "event"
}
}Was this article helpful?