- 最新动态
- 服务公告
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- API参考
- 客户端SDK参考
-
常见问题
- 产品咨询
- 计费购买
- Signature相关
- 录制相关
-
SDK使用
- 如何创建房间？
- 两台手机同时运行SparkRTC APP，为什么无法互通？
- 鉴权是如何生成的？在什么时候生成？
- onVideoStats、onAudioStatus、onSubStreamStats回调触发时为什么程序会崩溃？
- 为什么本端听筒能听到自己的声音？
- setExternalAudioCapture（音频自采集）、setExternalVideoCapture（视频自采集）、setExternalMediaFrameOutput（视频自渲染）能在进入房间后开启吗？
- SparkRTC是否支持设置镜像画面？
- SparkRTC音视频过程中的上下行码率、分辨率、丢包率、音频采样率等信息怎么获取？
- SparkRTC是否支持设置本地采集音量？是否支持设置每个远端用户的播放音量？
- enableLocalVideo和muteLocalVideo有什么区别？
- enableLocalAudioStream和muteLocalAudio有什么区别？
- SparkRTC是否支持对房间进行权限校验？
- 接入PC端是否支持屏幕分享功能？
- SparkRTC是否支持将本地视频文件分享到实时音视频中？
- SparkRTC是否支持单纯的实时音频？
- 一个房间里可以同时有多路屏幕分享吗？
- SparkRTC是否支持1080P？
- 是否支持视频画面截图功能？
- 播放背景音乐是否支持在线音乐？
- 同一个页面中，可以创建N个RTC对象，通过N个UserID，分别登录到N个房间吗？
- Web端用宽高设置的推流分辨率适用于所有浏览器吗？
- Web端SDK在使用过程中拔掉摄像头，摄像头列表里面的数据如何清除？
- Web端SDK可以获取当前音量大小吗？
- Web端支持监听远端离开房间吗？
- Web端通话过程中为什么会出现回声、杂音、噪声、声音小？
- Web端如何切换摄像头和麦克风？
- SparkRTC支持白板功能吗？
- 相同UserID支持同时进入多个房间吗？
- SparkRTC房间的生命周期是多久？
- SparkRTC多人视频通话支持蓝牙耳机吗？
- SparkRTC多人视频通话支持仅订阅2/3/4人音频吗？
- 指定窗口分享，当窗口大小变化时，视频流的分辨率会跟着变化吗？
- 视频通话支持悬浮窗、大小画面切换功能吗？
- 发送自定义消息接口能实现聊天室、弹幕等功能吗？
- 支持查询所有的UserID吗？
- Web SDK中的checkSystemRequirements接口为什么会调用异常？
- 问题排查
- 通用参考
链接复制成功！
踢除在线用户
功能介绍
调用此接口强制用户离开房间。
URI
POST /v2/apps/{app_id}/rooms/{room_id}/batch-remove-users
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
app_id |
是 |
String |
应用id |
|
room_id |
是 |
String |
房间id |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
内容类型。 |
|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选，携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选，请求的发生时间。 |
|
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选，携带项目ID信息。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
user_ids |
是 |
Array of strings |
用户ID列表 |
响应参数
状态码： 202
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-Id |
String |
此字段携带请求ID号，以便任务跟踪。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-Id |
String |
此字段携带请求ID号，以便任务跟踪。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-Id |
String |
此字段携带请求ID号，以便任务跟踪。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
踢除指定房间号内的user001和user002用户
POST https://{endpoint}/v2/apps/{app_id}/rooms/{room_id}/batch-remove-users
{
"user_ids" : [ "user001", "user002" ]
}响应示例
状态码： 400
语义有误，当前请求无法被服务器理解，或参数有误
{
"error_code" : "RTC.00001003",
"error_msg" : "InvalidParameterValue"
}状态码： 500
请求失败，服务器端错误
{
"error_code" : "RTC.00002xxx",
"error_msg" : "InternalError"
}状态码
|
状态码 |
描述 |
|---|---|
|
202 |
踢人请求已下发 |
|
400 |
语义有误，当前请求无法被服务器理解，或参数有误 |
|
500 |
请求失败，服务器端错误 |
错误码
请参见错误码。
