文档中心
即时通讯
服务端 API
房间相关
移除房间成员

移除房间成员

更新时间：2024-03-08 18:54

描述

移除房间内的指定用户。多用于内容审核场景下，开发者后台发现某个用户违规时，可通过本接口将该用户移出房间。

调用频率限制：20 次/秒

客户端将通过 ZIM SDK 的以下回调接口，接收用户被移除、房间内用户变更等通知。

iOS	Android	macOS	Windows	Web
roomStateChanged	onRoomStateChanged	roomStateChanged	onRoomStateChanged	roomStateChanged
小程序	Flutter	Unity3D	uni-app	React Native
roomStateChanged	onRoomStateChanged	OnRoomStateChanged	roomStateChanged	roomStateChanged

接口原型

请求方法：GET
请求地址：https://zim-api.zego.im/?Action=KickoutRoomUser
传输协议：HTTPS

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
RoomId	String	是	房间 ID。
UserId[]	Array of String	是	需要移除的用户 ID 列表，最大支持 50 个用户 ID。示例：UserId[]=a&UserId[]=b
CustomReason	String	否	移除用户的原因，建议最大不超过 32 字节。

RoomId、UserId 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'。

请求示例

https://zim-api.zego.im/?Action=KickoutRoomUser
&RoomId=123
&UserId[]=a&UserId[]=b
&CustomReason=%E8%B8%A2%E5%87%BA%E7%94%A8%E6%88%B7-%E5%8E%9F%E5%9B%A0
&<公共请求参数>

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。

响应示例

{
    "Code":0,
    "Message":"success",
    "RequestId":"343649807833778782"
}

返回码

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明
660000011	用户个数超过限制。
660300001	房间不存在。
660300002	用户不在此房间内。