KickoutRoomUser
https://zim-api.zego.im/
Remove specified users from the room. This is often used in content moderation scenarios. When the developer's backend detects that a user has violated the rules, this API can be used to remove the user from the room.
The client will receive notifications such as user removal and changes to users in the room through the following ZIM SDK callbacks:
| iOS | Android | macOS | Windows |
|---|---|---|---|
| roomStateChanged | onRoomStateChanged | roomStateChanged | onRoomStateChanged |
| Web | Mini Program | Flutter | React Native |
|---|---|---|---|
| roomStateChanged | roomStateChanged | onRoomStateChanged | groupMemberStateChanged |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnRoomStateChanged | groupMemberStateChanged | roomStateChanged |
'!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ' ', ',', '{', '}'.Request
Query Parameters
Possible values: [KickoutRoomUser]
API prototype parameter
https://zim-api.zego.im/?Action=KickoutRoomUser
💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.
💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.
💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.
Possible values: [2.0]
Default value: 2.0
💡Public parameter. Signature version number.
💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.
Possible values: <= 32 characters
Room ID.
Possible values: <= 50
List of user IDs to be removed (users who have logged in to the ZIM service by calling the login method on the client, or have completed registration by calling the server-side API). A maximum of 50 user IDs are supported.
Example: UserId[]=a&UserId[]=b
Possible values: <= 32 characters
Reason for removing the user. It is recommended not to exceed 32 bytes.
Responses
- 200
- application/json