踢除在线用户
功能介绍
调用此接口强制用户离开房间。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
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 |
请求失败，服务器端错误 |
错误码
请参见错误码。
