Get Direct Connects
- DarkLight
Get Direct Connects
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
The Login API allows an Agent to log in to the CTI server of Acqueon Workspace . If the response is successful, the agent is signed into Softphone and is automatically placed in agent state set before logout.
Pre-requisite
The agent must be in the LoggedOut state.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Amazon |
topic | Agent |
subtopic | Login |
source | <<app-name-broadcasting-this-message>> |
Response Parameters | Value |
|---|---|
channel | Amazon |
topic | Agent |
subtopic | LoginSuccess |
message | JSON Object |
Message Parameters
Parameters | Data Type | Description | Example Data |
|---|---|---|---|
loginState | Enum | Login state of agent. Possible values: Refer AgentLoginState in Appendix. | LoggedIn |
agentInfo | JSON Object | User details of agent. Refer AgentInfo in Appendix. | NA |
agentState | JSON Object | Current state of agent. Refer AgentState in Appendix. | Null |
rules | JSON Object | Contains list of buttons and their states. Refer Rules in Appendix. | Null |
Sample Request
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "Login",
"source": "myapp"
}Sample Response
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "LoginSuccess",
"message": {
"loginState": "LoggedIn",
"agentInfo": {
"name": "Agent 1",
"extension": "",
"loginName": "agent1",
"muted": false,
"softphoneEnabled": false
},
"agentState": null,
"rules": null
}
}Was this article helpful?