KickoutGroupUser
https://zim-api.zego.im/
Remove users from a group by specifying user IDs.
- User IDs in the group can be obtained through Query group member list.
- If the removed user is the group owner, the first user in the group list will automatically become the new group owner.
After successfully removing users, all group members (including the group owner and the removed members) will receive group member status change notifications through the ZIM SDK callback interface:
| iOS | Android | macOS | Windows |
|---|---|---|---|
| groupMemberStateChanged | onGroupMemberStateChanged | groupMemberStateChanged | onGroupMemberStateChanged |
| Web | Mini Program | Flutter | React Native |
|---|---|---|---|
| groupMemberStateChanged | groupMemberStateChanged | onGroupMemberStateChanged | groupMemberStateChanged |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnGroupMemberStateChanged | groupMemberStateChanged | groupMemberStateChanged |
FromUserId and UserId 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.'!','#','$','%','&','(',')','+','\'',':',';','<','=','.','>','?', '@','[',']','^','_','{','}','|','~'.Request
Query Parameters
Possible values: [KickoutGroupUser]
API prototype parameter
https://zim-api.zego.im/?Action=KickoutGroupUser
💡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.
- application/json
Responses
- 200
- application/json