Destroy Room

功能说明

App 管理员可以通过该接口解散房间。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/live_engine_http_srv/destroy_room?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参见 REST API 简介
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:console.tim.qq.com
新加坡:adminapisgp.im.qcloud.com
美国:adminapiusa.im.qcloud.com
v4/live_engine_http_srv/destroy_room
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

基础形式
{
"RoomId":"live-room"
}

请求包字段说明

字段
类型
属性
说明
RoomId
String
必填
房间 ID

应答包体示例

基础形式
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode
Integer
错误码,0表示成功,非0表示失败
ErrorInfo
String
错误信息
RequestId
String
唯一请求 ID,每次请求都会返回,定位问题时需要提供该次请求的 RequestId

房间自动解散机制

Live房间在以下三种情况会触发房间自动解散逻辑,支持 sdkappid 维度的配置,开启条件和时间的调整配置请联系商务或者提交工单进行变更。
1. 当有用户进入过房间之后,房间空无一人并且持续一段时间内(默认30分钟)没人进房,就会触发自动解散机制,配置机器人的房间不会自动解散。2025/05/20之前的 Live 客户维持原来的6小时解散机制,该时间支持调整,配置区间为[10分钟,24小时],不支持关闭
2. 房主调用接口离开房间并且持续一段时间内(默认10分钟)没有重新进房,就会触发自动解散机制,如果房主是机器人,则不会触发该机制,该机制默认关闭,该时间支持调整,配置区间为[2分钟,12小时]。
3. 房主超过心跳保活时间掉线后,并且持续一段时间内(默认10分钟)没有恢复心跳进房,就会触发自动解散机制,如果房主是机器人,则不会触发该机制,该机制默认关闭,该时间支持调整,配置区间为[2分钟,12小时]。

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码(60000到79999)参见 错误码 文档。 本 API 私有错误码如下:
错误码
含义说明
100001
服务器内部错误,请重试
100002
请参数非法,请根据错误描述检查请求是否正确
100004
房间不存在,原因可能是房间没被创建过,或者已经被解散了
100006
没有权限解散,例如操作者不是房主也不是 root 管理员或者解散的不是 live 房间等