解散房间(字符串房间号)

最近更新时间:2024-03-12 10:45:15

我的收藏

1. 接口描述

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

接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DismissRoomByStrRoomId。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-mumbai 。
SdkAppId Integer TRTC的SDKAppId。
示例值:1400000000
RoomId String 字符串类型房间号。
本接口仅支持解散字符串类型房间号,如需解散数字类型房间号,请使用:DismissRoom
示例值:abcd

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 解散房间

解散房间abcd。

输入示例

https://trtc.tencentcloudapi.com/?Action=DismissRoomByStrRoomId
&SdkAppId=1400000001
&RoomId=abcd
&<公共请求参数>

输出示例

{
    "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 查询房间失败。
InvalidParameter.RoomId RoomId参数错误。
InvalidParameter.SdkAppId SdkAppId参数错误。
InvalidParameterValue.RoomId RoomId值错误。
MissingParameter.RoomId 缺少RoomId参数。
MissingParameter.SdkAppId 缺少SdkAppId参数。
UnauthorizedOperation.SdkAppId 没有操作SdkAppId的权限。