移出用户

最近更新时间:2021-03-16 08:10:55

我的收藏

1. 接口描述

接口请求域名: trtc.tencentcloudapi.com 。

接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RemoveUser。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表
SdkAppId Integer TRTC的SDKAppId。
RoomId Integer 房间号。
UserIds.N Array of String 要移出的用户列表,最多10个。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 移出用户

将用户test1、test2从房间1234移出。

输入示例

https://trtc.tencentcloudapi.com/?Action=RemoveUser
&SdkAppId=1400000001
&RoomId=1234
&UserIds.0=test1
&UserIds.1=test2
&UserIds.3=test3
&UserIds.4=test4
&UserIds.5=test5
&UserIds.6=test6
&UserIds.7=test7
&UserIds.8=test8
&UserIds.9=test9
&UserIds.10=test10
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.RoomNotExist 房间不存在。
InternalError 内部错误。
InternalError.GetRoomCacheIpError 查询房间失败。
InternalError.GetRoomFromCacheError 获取房间信息失败。
InvalidParameter.RoomId RoomId参数错误。
InvalidParameter.SdkAppId SdkAppId参数错误。
InvalidParameter.UserIds UserIds参数错误。
InvalidParameterValue.RoomId RoomId值错误。
MissingParameter.RoomId 缺少RoomId参数。
MissingParameter.SdkAppId 缺少SdkAppId参数。
MissingParameter.UserIds 缺少UserIds参数。
UnauthorizedOperation.SdkAppId 没有操作SdkAppId的权限。
目录