创建房间

最近更新时间:2026-02-13 11:15:54

我的收藏

功能说明

本接口用于在服务端创建一个新的直播间或语聊房。在创建房间时,可以预设房间的玩法模式,包括观众上麦方式、房间 UI 布局以及音视频混流策略等。
适用场景
秀场直播:创建单人主播房间,配置公屏互动。
连麦直播:创建支持观众申请上麦的互动房间。
语音沙龙:创建纯音频互动的语聊房间。
研讨会:创建支持多个嘉宾,超大观众的研讨会房间。
注意
房间创建后若不再使用,必须调用 解散房间 接口进行销毁。若未主动销毁,房间将一直存在;
特殊场景下,Live 房间支持配置 房间自动解散机制

接口调用说明

请求 URL 示例

https://xxxxxx/v4/live_engine_http_srv/create_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/create_room
创建直播间接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID,可在即时通信 IM 控制台 的应用卡片中获取。
identifier
必须为应用管理员账号,更多详情请参见文档 应用管理员
usersig
应用管理员账号生成的签名,具体操作请参见 生成UserSig
random
请输入随机的 32 位无符号整数,取值范围 0 - 4294967295。
contenttype
请求格式,固定值为json

最高调用频率

200次/秒。

请求参数

请求包体为 JSON 格式,包含 RoomInfo 对象。

请求示例

{
"RoomInfo": {
"RoomId": "live-room",
"RoomType": "Live",
// 其他字段详见下面说明
}
}

字段详解

RoomInfo 字段详解

字段
类型
属性
说明
RoomId
String
必填
房间唯一标识。
最长48个字节。
推荐您使用前缀来区分不同的房间类型。
RoomType
String
必填
房间类型,固定值为 Live。
Owner_Account
String
选填
房主 ID(需是已导入的账号)。
如果您不填写,默认为接口调用者的用户 ID。
推荐您填写当前房间内主播的 userID。
TakeSeatMode
String
选填
上麦模式,取值范围如下,默认为 FreeToTake 模式。
FreeToTake,自由上麦,无需房主或者管理员同意可以直接上麦。
ApplyToTake,申请上麦,需房主或者管理员同意后才可以上麦。
SeatTemplate
String
必填
布局模板 ID ,具体效果参见 布局模板及 UI 效果
MaxSeatCount
Integer
选填
设置房间的麦位数量(取值范围受套餐包最大数量限制)。仅适用于语聊房场景,即 SeatTemplate 设置为 AudioSalon 或 Karaoke 时生效。
IsMessageDisabled
Bool
选填
是否开启全体禁言。
默认值为 false,即允许观众发送弹幕。
IsPublicVisible
Bool
选填
房间是否在 直播间列表 中可见,默认值是 true。
如果您想在正式开播前试播或者创建私密直播间,可设置为 false。
如果您想在 获取直播列表中能看到当前直播间,可设置为 true。
RoomName
String
选填
房间名称,可用于直播间列表中的展示。
如果您不填写,默认为房间 ID。
该字段最长 100 个字节。
CoverURL
String
选填
房间封面,可用于直播间列表中的展示。
最大 200 字节。
Category
Array

选填
房间分类标签,自定义字段。
单个房间最多支持 3 个标记。
您可以用来作为房间类型标识,例如游戏、音乐等。
ActivityStatus
Integer
选填
直播间内的活动状态,自定义字段。例如:0:游戏准备中; 1: 游戏中; 2: 游戏结束。
当您设置后,所有用户进房都会获取到。
当您有更新时,房间内的用户也会同步获取到最新的值。

布局模板与 UI 效果

视频竖屏开播


视频直播(动态宫格布局)
视频直播(浮动小窗布局)
视频直播(固定宫格布局)
视频直播(固定小窗布局)

模板取值

VideoDynamicGrid9Seats
VideoDynamicFloat7Seats
VideoFixedGrid9Seats
VideoFixedFloat7Seats
SDK 版本
RTCRoomEngine 3.3.0
LiveStreamCore 3.3.0
RTCRoomEngine 3.3.0
LiveStreamCore 3.3.0
RTCRoomEngine 3.3.0
LiveStreamCore 3.3.0
RTCRoomEngine 3.3.0
LiveStreamCore 3.3.0
最大麦位数
9(受套餐包影响)
7(受套餐包影响)
9(受套餐包影响)
7(受套餐包影响)
描述
默认布局,可根据连麦人数动态调整宫格大小。
连麦嘉宾以浮动小窗形式显示。
连麦人数固定,每个嘉宾占据一个固定宫格。
连麦人数固定,嘉宾以固定小窗形式显示。

运行效果








视频横屏开播

模板 ID 为 VideoLandscape4Seat。
您可以使用 Live 推流助手来体验横屏推流模板。
横屏开播,支持 4 个麦位(1个主播视频位,3个连麦观众音频位,受套餐包影响)。




语聊房开播


聊天室布局
KTV布局

模板取值

AudioSalon
Karaoke
SDK 版本
RTCRoomEngine 3.3.0
LiveStreamCore 3.3.0
RTCRoomEngine 3.3.0
LiveStreamCore 3.3.0
最大麦位数
套餐包的最大麦位数
套餐包的最大麦位数

运行效果







返回参数

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

成功响应示例

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720",
"RoomId": "live-room"
}

字段详解

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

常见错误码

公共错误码(60000 到 79999)参见 错误码 文档,本 API 私有错误码如下:
错误码
含义说明
100001
服务器内部错误,请重试。
100002
请求参数非法,请根据错误描述检查请求是否正确。
100003
房间 ID 已存在,请选择其他房间 ID。
100007
无付费信息,需在控制台购买套餐包。
100010
房间 ID 已经存在,且房间 Owner_Account 相同,您可以直接使用。
100011
房间 ID 已被 IM 占用,可以换一个房间 ID 使用。
100012
创建房间超过频率限制,同一房间 ID 1 秒内只能创建一次。
100026
房间名称或者其他信息存在敏感内容。

调用示例

场景:高并发秀场直播

特点
支持海量观众,开启混流。
允许观众连麦,开启麦位。
公开直播,允许观众在直播间列表中看到。
布局:使用标准的动态九宫格布局,只有主播 1 人时全屏展示,有观众连麦时按动态宫格排布。
效果图

请求示例
{
"RoomInfo": {
"RoomId": "live_testA",
"RoomType": "Live",
"Owner_Account": "testA", // 设置房主(主播)
"TakeSeatMode": "ApplyToTake", // 观众连麦时,需要调用 takeSeat 接口申请
"SeatTemplate": "VideoDynamicGrid9Seats", // 设置布局为视频直播动态九宫格布局
"IsPublicVisible": true, // 设置当前直播在直播间列表中可见
"RoomName": "Happy new year", // 设置直播名称,用于在直播间列表中展示
"CoverURL": "cover url" // 设置直播封面 URL,用于在直播间列表中展示
}
}

场景:语聊房

特点
纯音频,大家自由发言。
不强制使用混流(适合小范围)。
公开直播,允许观众在直播间列表中看到。
允许观众自由上麦发言。
支持自定义麦位数量(如 8 人、10 人)。
效果图



请求示例
{
"RoomInfo": {
"RoomId": "voice_testA",
"RoomType": "Live",
"Owner_Account": "testA", // 设置房主(主播)
"TakeSeatMode": "FreeToTake", // 观众连麦时,可自由上麦
"MaxSeatCount": 10, // 设置麦位数 10 个,这里最大值需要按您的套餐包来
"SeatTemplate": "AudioSalon", // 设置开播模板为语聊房
"IsPublicVisible": true, // 设置当前直播在直播间列表中可见
"RoomName": "Happy new year", // 设置直播名称,用于在直播间列表中展示
"CoverURL": "cover url" // 设置直播封面 URL,用于在直播间列表中展示
}
}

可能触发的回调

参考

主播准备页 (布局效果)
主播开播页 (布局样式)

接口调试工具

您可以通过 REST API 在线调试工具 调试本接口。