.png?sv=2022-11-02&spr=https&st=2025-12-16T12%3A56%3A30Z&se=2025-12-16T13%3A06%3A30Z&sr=c&sp=r&sig=TCdwz8DEkKsXU6QeS5iP53E0cbx5zu1OeHCYNAoXU%2Bk%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 Webex CC with valid credentials.
Pre-requisite
The agent must register to a Webex CC channel and be in a sign-out state.
Sequence Diagram
Message Structure
Request Parameter | Value |
|---|---|
No Request Parameter |
Response Parameter | Value |
|---|---|
channel | Webex CC |
topic | Agent |
subtopic | SetAgentState |
message | JSON Object. Refer Message Parameters. |
Message Parameters
Parameter | Data Type | Description | Example Data |
|---|---|---|---|
event | string | Login state of the agent. | login |
source | string | Source of response. | event |
data | JSON Object | Current agent data with default values. Refer to the Data Parameters table. | Null |
Data Parameters
Parameter | Data Type | Description | Example Data |
|---|---|---|---|
Team | string | Team Name | Acqueon_Site1_Team1 |
loginName | string | Current agent username of Webex CC | wxcc-test-qa-acqueon_org-agent4@wbxlab.us |
name | string | Username of the Webex CC agent | wxcc-test-qa-acqueon_org agent4 |
loginid | string | A unique identifier assigned to a user for user authentication from Webex CC. | 75289db7-fd21-4206-bb56-150b1864b6c8 |
state | string | value “login” when agent is logged in to Webex CC | LoggedIn |
stateChangeTime | string | State change date time value | 2024-06-19T05:51:46.535Z |
Sample Response
{
"channel": "Webexcc",
"topic": "Agent",
"subtopic": "SetAgentState",
"message": {
"data": {
"event": "AgentState",
"name": "wxcc-test-qa-acqueon_org agent4",
"loginId": "75289db7-fd21-4206-bb56-150b1864b6c8",
"state": "LoggedIn",
"stateChangeTime": "2024-06-19T05:21:56.554Z"
},
"event": "AgentState",
"source": "event"
}
}
Compatible Workspace Version
3.21.2410 onwards
Was this article helpful?