tencent cloud

直播 SDK

文档直播 SDK服务端 APIREST API房间相关查询转发子房间列表

查询转发子房间列表

下载
聚焦模式
字号
最后更新时间： 2026-09-02 16:39:06

功能说明

本接口用于查询指定房间的转发关系信息，包括该房间的转发角色（普通房间 / 主房间 / 子房间）、绑定的主房间 ID（子房间时）或子房间列表（主房间时）。
适用场景
状态查询：查看某个房间当前是否参与了转发关系。
运维监控：检查主房间当前绑定了哪些子房间。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/live_engine_http_srv/get_relay_room_list?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
雅加达：adminapiidn.im.qcloud.com
v4/live_engine_http_srv/get_relay_room_list
查询转发关系接口。
sdkappid
您可以在 Tencent RTC 控制台 的应用卡片中获取 SdkAppId。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式固定值为 json。

最高调用频率

200次/秒。

请求参数

请求包体为 JSON 格式。

请求示例

{
    "RoomId": "main-room-001"
}

字段详解

字段
类型
属性
说明
RoomId
String
必填
待查询的房间 ID。可以是主房间、子房间或普通房间。

返回参数

接口返回 HTTP 200 状态码时，需根据包体中的 ErrorCode 判断业务逻辑是否成功。

查询主房间的响应示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "RequestId": "Id-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "Response": {
        "RelayRole": 1,
        "RelayRoomList": [
            {
                "RoomId": "child-room-001",
                "RelayTime": 1713868800
            },
            {
                "RoomId": "child-room-002",
                "RelayTime": 1713868860
            }
        ]
    }
}

查询子房间的响应示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "RequestId": "Id-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "Response": {
        "RelayRole": 2,
        "MainRoomId": "main-room-001"
    }
}

查询普通房间的响应示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "RequestId": "Id-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "Response": {
        "RelayRole": 0
    }
}

字段详解

字段
类型
说明
ActionStatus
String
请求处理的结果：
OK 表示处理成功；
FAIL 表示失败。
ErrorCode
Integer
错误码：
0：表示成功；
非0：表示失败。
ErrorInfo
String
错误信息。
RequestId
String
唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId。
Response.RelayRole
Integer
房间的转发角色：
0：普通房间（未参与转发）；
1：主房间（内容源）；
2：子房间（内容接收方）。
Response.MainRoomId
String
当 RelayRole = 2（子房间）时返回，表示该子房间所绑定的主房间 ID。
Response.RelayRoomList
Array
当 RelayRole = 1（主房间）时返回，表示该主房间绑定的所有子房间列表。
Response.RelayRoomList[i].RoomId
String
子房间 ID。
Response.RelayRoomList[i].RelayTime
Integer
该子房间被添加为转发子房间的时间戳（Unix 秒）。

RelayRole 枚举值说明

值
名称
说明
0
None
普通房间，未参与任何转发关系。
1
Main
主房间，作为内容源，其混流画面被转发到子房间。
2
Sub
子房间，接收主房间的混流转发。不能连线、不能上麦、不能 PK。

常见错误码

公共错误码（60000 到 79999）参见 错误码 文档，本 API 私有错误码如下：
错误码
含义说明
100001
服务器内部错误，请重试。
100002
请求参数非法。常见原因：RoomId 为空。
100004
房间不存在。
100006
权限不足。常见原因：非 REST API 调用（端上 SDK 不允许调用此接口）。

参考

创建房间：创建主房间和子房间。
添加转发子房间：将房间设为转发子房间。
移除转发子房间：从主房间中移除子房间。
解散房间：解散房间时会自动清理转发关系。
上一篇: 移除转发子房间下一篇: 成员禁言

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈

搜索
    请输入关键词搜索文档