KickoutUser
GET
https://rtc-api.zego.im/
调用本接口踢出房间内的指定用户，该用户当前的推流和拉流会全部停止。多用于内容审核场景下，开发者后台发现某个用户的直播内容违规时，可通过本接口将该用户踢出房间。
客户端被踢的用户会收到 ZEGO SDK 回调接口：
| ZegoExpress SDK | LiveRoom SDK | |
|---|---|---|
| iOS/macOS | onRoomStateChanged | onKickOut |
| Android | onRoomStateChanged | onKickOut |
| Windows | onRoomStateChanged | OnKickOut |
| Web/小程序 | roomStateChanged | onKickOut |
客户端接收房间内用户变更的通知使用 ZEGO Express SDK 回调接口：
| ZegoExpress SDK | LiveRoom SDK | |
|---|---|---|
| iOS/macOS | onRoomUserUpdate | onUserUpdate |
| Android | onRoomUserUpdate | onUserUpdate |
| Windows | onRoomUserUpdate | OnUserUpdate |
| Web/小程序 | roomUserUpdate | onUserStateUpdate |
调用频率限制
同一个 AppID 下所有房间：50 次/秒
Request
Query Parameters
Action string必填
可选值: [KickoutUser]
接口原型参数
https://rtc-api.zego.im?Action=KickoutUser
AppId uint32必填
💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考 签名示例，最多允许 10 分钟的误差。
Signature string必填
💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
RoomId string必填
房间 ID。
UserId string[]必填
可选值: >= 1, <= 5
踢出房间的用户 ID 列表，最大支持 5 个用户 ID。
CustomReason string
可选值: <= 256 characters
踢人原因，最大长度为 256 字节。使用时，需对其内容执行 URL 编码（UrlEncode）处理。
Responses
- 200
操作成功
- application/json