移除房间成员
GET
https://zim-api.zego.im/
移除房间内的指定用户。多用于内容审核场景下,开发者后台发现某个用户违规时,可通过本接口将该用户移出房间。
客户端将通过 ZIM SDK 的以下回调接口,接收用户被移除、房间内用户变更等通知。
| iOS | Android | macOS | Windows |
|---|---|---|---|
| roomStateChanged | onRoomStateChanged | roomStateChanged | onRoomStateChanged |
| Web | 小程序 | Flutter | React Native |
|---|---|---|---|
| roomStateChanged | roomStateChanged | onRoomStateChanged | groupMemberStateChanged |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnRoomStateChanged | groupMemberStateChanged | roomStateChanged |
说明
参数 RoomId、UserId[] 仅支持数字,英文字符和
'!','#','$','%','&','(',')','+','-',':',';','<','=','.','>','?','@','[',']','^','_',' ',',','{','}'。说明
调用频率限制:20 次/秒
Request
Query Parameters
Action string必填
可选值: [KickoutRoomUser]
接口原型参数
https://zim-api.zego.im/?Action=KickoutRoomUser
AppId uint32必填
💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
Signature string必填
💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。
RoomId string必填
可选值: <= 32 characters
房间 ID。
UserId string[]必填
可选值: <= 50
需要移除的用户 ID 列表(已在客户端调用 login 方法登录 ZIM 服务,或已调用 服务端 API 完成注册)),最大支持 50 个用户 ID。
示例:UserId[]=a&UserId[]=b
CustomReason string
可选值: <= 32 characters
移除用户的原因,建议最大不超过 32 字节。
Responses
- 200
OK
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
ZEGO 签名生成器
RESPONSE清除

