实时音视频

实时语音

超低延迟直播

即时通讯

互动核心产品

音视频通话 UIKit

互动直播 UIKit

语聊房 UIKit

IMKit

UIKits

超级白板

云端播放器

AI 美颜

云端录制

小游戏平台

本地服务端录制

星图

互动扩展服务

数字人 PaSS 服务

AIGC

数美内容审核

大饼 AI 变声

实时传译

云市场

产品

语聊房

秀场直播

在线 KTV

在线健身

互动播客

社交娱乐

小班课

大班课

在线音乐教学

在线美术教学

在线编程教学

在线教育

远程医疗

医疗健康

语音通话

视频通话

视频会议

协同办公

解决方案

控制台

安全合规

术语表

ZEGO 平台

通用文档

API 概览

调用方式

查询用户在线状态

查询用户信息

批量注册用户

修改用户资料

批量添加好友

批量发送好友申请

批量删除好友

删除所有好友

查询好友列表

检查好友关系

更新好友备注

更新好友属性

批量拉黑用户

批量移除黑名单

查询黑名单

检查黑名单关系

用户

销毁房间

获取房间内成员信息

移除房间成员

查询用户是否在房间内

房间

创建群组

修改群组规格限制

查询 App 下的群组列表

查询群成员列表

移除群成员

转让群主

添加群成员

设置群成员昵称

设置群成员角色

设置群禁言

设置群成员禁言

解散群组

群组

发送单聊消息

发送群组消息

发送房间消息

全员推送

撤回单聊消息

撤回群聊消息

撤回房间消息

导入单聊消息

导入群聊消息

MessageBody 说明

消息

发起呼叫邀请

接受呼叫邀请

拒绝呼叫邀请

呼叫邀请

设置会话消息免打扰

置顶会话

查询会话列表

查询单聊会话消息列表

查询群聊会话消息列表

设置会话标记

会话

获取鉴权信息

ZIM Audio

回调配置说明

登录登出

呼叫创建

呼叫取消

呼叫接受

呼叫被拒绝

呼叫超时

消息发送前

消息发送后

回调校验说明

回调说明

全局返回码

服务端 API 调测指南

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

# 移除房间成员

- - -

## 描述

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

调用频率限制：20 次/秒

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

<table>
<tbody><tr>
<th>iOS</th>
<th>Android</th>
<th>macOS</th>
<th>Windows</th>
<th>Web</th>
</tr>
<tr>
<td><a href="https://doc-zh.zego.im/article/api?doc=zim_API~objective-c_ios~protocol~ZIMEventHandler#zim-room-state-changed-event-extended-data" rel="noreferrer noopenner">roomStateChanged</a></td>
<td><a href="https://doc-zh.zego.im/article/api?doc=zim_API~java_android~class~ZIMEventHandler#on-room-state-changed" rel="noreferrer noopenner">onRoomStateChanged</a></td>
<td><a href="https://doc-zh.zego.im/article/api?doc=zim_API~objective-c_macos~protocol~ZIMEventHandler#zim-room-state-changed-event-extended-data" rel="noreferrer noopenner">roomStateChanged</a></td>
<td><a href="https://doc-zh.zego.im/article/api?doc=zim_API~cpp_windows~class~ZIMEventHandler#on-room-state-changed" rel="noreferrer noopenner">onRoomStateChanged</a></td>
<td><a href="https://doc-zh.zego.im/article/api?doc=zim_API~javascript_web~interface~ZIMEventHandler#room-state-changed" rel="noreferrer noopenner">roomStateChanged</a></td>
</tr>
<tr>
<th>小程序</th>
<th>Flutter</th>
<th>Unity3D</th>
<th>uni-app</th>
<th>React Native</th>
</tr>
<tr>
<td><a href="https://doc-zh.zego.im/article/api?doc=zim_API~javascript_wxxcx~interface~ZIMEventHandler#room-state-changed" rel="noreferrer noopenner">roomStateChanged</a></td>
<td><a href="https://pub.dev/documentation/zego_zim/latest/zego_zim/ZIMEventHandler/onRoomStateChanged.html" rel="noreferrer noopenner">onRoomStateChanged</a></td>
<td><a href="https://doc-zh.zego.im/article/api?doc=zim_API~cs_unity3d~class~ZIMEventHandler#on-room-state-changed" rel="noreferrer noopenner">OnRoomStateChanged</a></td>
<td><a href="https://doc-zh.zego.im/article/api?doc=zim_API~javascript_uni-app~interface~ZIMEventHandler#room-state-changed" rel="noreferrer noopenner">roomStateChanged</a></td>
<td><a href="https://doc-zh.zego.im/article/api?doc=zim_API~javascript_react-native~interface~ZIMEventHandler#room-state-changed" rel="noreferrer noopenner">roomStateChanged</a></td>
</tr>
</tbody></table>



## 接口原型

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


## 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考 [调用方式 - 公共请求参数](../Accessing%20Server%20APIs.mdx#2-公共参数)。

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

<Note title="说明">

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

## 请求示例

```json
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
&<公共请求参数>
```

## 响应参数

<table>
  <tbody><tr>
    <th>参数</th>
    <th>类型</th>
    <th>描述</th>
  </tr>
  <tr>
    <td>Code</td>
    <td>Number</td>
    <td>返回码。</td>
  </tr>
  <tr>
    <td>Message</td>
    <td>String</td>
    <td>请求结果的说明信息。</td>
  </tr>
  <tr>
    <td>RequestId</td>
    <td>String</td>
    <td>请求 ID。</td>
  </tr>
</tbody></table>


## 响应示例

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


## 返回码

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考 [全局返回码](../Return%20codes.mdx)。

<table>
  
  <tbody><tr>
    <th>返回码</th>
    <th>说明</th>
  </tr>
  <tr>
    <td>660000011</td>
    <td>用户个数超过限制。</td>
  </tr>
  <tr>
    <td>660300001</td>
    <td>房间不存在。</td>
  </tr>
  <tr>
    <td>660300002</td>
    <td>用户不在此房间内。</td>
  </tr>
</tbody></table>


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

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

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