DisconnectUser (Publish)
Disconnects another viewer from the Chat room. Use this in conjunction with the CreateChatToken flow to implement time-based or permanent user bans. For example, to permanently ban a user (viewer), precede this operation with a call to your application service, to prevent the application service from creating another token to the same room. To lift the ban (time- or logic-based), simply resume calling CreateChatToken.
Required Capability
DISCONNECT_USER
Format
{ "Action": "DISCONNECT_USER", "RequestId": "string", "Reason": "string", "UserId": "string" }
Fields
| Field | Required | Description |
|---|---|---|
|
Yes |
|
|
No |
An identifier optionally specified by your application for tracking purposes. If specified, this appears in corresponding subscribe operations. |
|
No |
Reason for disconnecting the user. |
|
Yes |
User ID of the user(s) to disconnect from the room. If multiple connections share this ID, all are disconnected. |
