.png?sv=2022-11-02&spr=https&st=2025-10-21T05%3A00%3A04Z&se=2025-10-21T05%3A10%3A04Z&sr=c&sp=r&sig=748VlffhtF%2B4rs%2BATMAhzTxEuOgLQk0LKtPt8Reafc8%3D){kind=logo}
Logout API
- DarkLight
Logout API
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
This API allows an Agent to log out from softphone.
Pre-requisite
The agent must be in the LoggedIn 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 | LogoutSuccess |
message | JSON Object |
Message Parameters
Parameters | Data Type | Description | Example Data |
|---|---|---|---|
loginState | Enum | Login state of agent. Possible values: Refer AgentLoginState in Appendix. | LoggedOut |
agentInfo | JSON Object | User details of agent. Refer AgentInfo in Appendix. | NA |
agentState | JSON Object | Current state of agent. Refer AgentState in Appendix. | NA |
rules | JSON Object | Button state rules. Refer Rules in Appendix. | NA |
Sample Request
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "Logout",
"source": "myapp"
}Sample Response
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "LogoutSuccess",
"message": {
"loginState": "LoggedOut",
"agentInfo": {
"muted": false,
"name": "Agent 1",
"extension": "",
"loginName": "agent1",
"softphoneEnabled": true
},
"agentState": {
"agentStateARN": null,
"type": "not_routable",
"name": "Not Ready Bre@k",
"startTimestamp": "2020-04-09T13:38:40.517Z"
},
"rules": {
"ButtonStates": {
"items": {
"NotReady": "Enable",
"Ready": "Enable",
"make_call": "Enable",
"mute": "Enable",
"unmute": "Hide"
},
"count": 5
},
"ResponseActual": {
"agentStateARN": null,
"type": "not_routable",
"name": "Not Ready Bre@k",
"startTimestamp": "2020-04-09T13:38:40.517Z"
}
}
}
}Was this article helpful?