.png?sv=2022-11-02&spr=https&st=2025-12-22T14%3A44%3A59Z&se=2025-12-22T14%3A54%3A59Z&sr=c&sp=r&sig=%2Bcju0HJC6Kx43nUmWYdnViERPULIhnzaCkYRNO4q8Y0%3D){kind=logo}
Agent State Synchronization
- DarkLight
Agent State Synchronization
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
This API is used to provide the latest Agent state.
Pre-requisites
The application registration must be completed.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Amazon |
topic | Agent |
subtopic | StateSync |
source | <<app-name-broadcasting-this-message>> |
Response Parameters | Value |
|---|---|
channel | Amazon |
topic | Agent |
subtopic | StateSync |
message | JSON Object |
Message Parameter
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 the agent. Refer AgentInfo in Appendix. | NA |
agentState | JSON Object | Current state of the agent. Refer AgentState in Appendix. | NA |
rules | JSON Object | Button state rules. Refer Rules in Appendix. | NA |
Sample Request
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "StateSync",
"source": "myapp"
}Sample Response
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "StateSync",
"message": {
"loginState": "LoggedOut",
"agentInfo": null,
"agentState": null,
"rules": ""
}
}Was this article helpful?