实时音视频创建房间

功能说明
应用管理员可以通过该接口创建一个直播间。
说明：
应用管理员账号可以参考文档 应用管理员 进行配置。
接口调用说明
请求 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次/秒。
请求包示例
基础形式
{
  "RoomInfo":{
              "RoomId":"live-room", 
              "RoomType":"Live", 
              "RoomName":"live name", 
              "Owner_Account":"administrator", 
              "MaxMemberCount":400, 
              "CoverURL":"cover url", 
              "IsMessageDisabled":true, 
              "Category":[1, 2, 3], 
              "IsPublicVisible": true, 
              "IsSeatEnabled": true, 
              "TakeSeatMode":"ApplyToTake", 
              "MaxSeatCount":8, 
              "ActivityStatus":1,
              "IsUnlimitedRoomEnabled":true
              }
}
请求包字段说明
字段
类型
属性
说明
RoomId
String
必填
房间 ID，最长48个字节。
RoomName
String
选填
房间名称，默认为房间 ID，最长100个字节。
RoomType
String
必填
房间类型：Live（直播房间）。
Owner_Account
String
选填
房主 ID（需是 已导入 的账号），默认为接口调用者的用户 ID。
MaxMemberCount
Integer
选填
最大房间成员数量，缺省时的默认值：付费套餐包上限，例如体验版是20, 如果升级套餐包，需按照修改房间资料修改这个字段，详见文档TUILiveKit 能力版本计费说明。
CoverURL
String
选填
房间封面，最大200字节。
IsMessageDisabled
Bool
选填
是否开启全体禁言。
true： 开启。
false：关闭，默认 false。
Category
Array<Integer>
选填
房间分类标签, 单个房间最多支持3个标记，可以用来作为房间类型标识，例如游戏、音乐等。
IsPublicVisible
Bool
选填
房间公开标识，影响在房间列表中的展示。
true：公开，可以在直播列表中拉取到该房间。
false：私密，无法在直播列表中拉取到该房间。
IsSeatEnabled
Bool
选填
是否支持麦位，只有在麦位上的用户才可以开启音视频。
true：支持。
false：不支持，默认不支持。
TakeSeatMode
String
选填
当使用麦位能力时候（isSeatEnabled为ture），需要填写麦位模式：
FreeToTake（自由上麦，无需房主同意可以直接上麦）。
ApplyToTake（申请上麦，上麦申请需房主同意后才可以上麦）。
MaxSeatCount
Integer
选填
最大麦位数，当使用麦位能力时候，默认为套餐包上限，详见文档TUILiveKit 能力版本计费说明。
ActivityStatus
Integer
选填
直播间活跃状态：用户自定义直播间状态标记。
例如：0：游戏准备中； 1: 游戏中； 2: 游戏结束。
IsUnlimitedRoomEnabled
Bool
选填
是否开启房间混流，房间混流用于优化 视频直播 的高并发场景，
true：开启。
false： 关闭，默认为 false。
注意：
用户需要在直播结束以后，手动调用 解散房间 接口，结束本场会议。
Live 房间自动解散机制。
应答包体示例
基础形式
{
  "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。
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
含义说明
100001
服务器内部错误，请重试。
100002
请参数非法，请根据错误描述检查请求是否正确。
100003
房间 ID 已存在，请选择其他房间 ID。
100007
无付费信息，需在控制台购买套餐包。
100010
房间 ID 已被使用，并且操作者为房主，可以直接使用。
100011
房间 ID 已被 IM 占用，可以换一个房间 ID 使用，或者先通过 IM 接口解散该群。
100012
创建房间超过频率超限，同一房间 ID 1秒内只能创建一次。
可能触发的回调
﻿创建房间之后回调﻿
接口调试工具
您可以通过 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`。

字段	类型	属性	说明
RoomId	String	必填	房间 ID，最长48个字节。
RoomName	String	选填	房间名称，默认为房间 ID，最长100个字节。
RoomType	String	必填	房间类型：Live（直播房间）。
Owner_Account	String	选填	房主 ID（需是已导入的账号），默认为接口调用者的用户 ID。
MaxMemberCount	Integer	选填	最大房间成员数量，缺省时的默认值：付费套餐包上限，例如体验版是20, 如果升级套餐包，需按照修改房间资料修改这个字段，详见文档TUILiveKit 能力版本计费说明。
CoverURL	String	选填	房间封面，最大200字节。
IsMessageDisabled	Bool	选填	是否开启全体禁言。 true：开启。 false：关闭，默认 false。
Category	Array<Integer>	选填	房间分类标签, 单个房间最多支持3个标记，可以用来作为房间类型标识，例如游戏、音乐等。
IsPublicVisible	Bool	选填	房间公开标识，影响在房间列表中的展示。 true：公开，可以在直播列表中拉取到该房间。 false：私密，无法在直播列表中拉取到该房间。
IsSeatEnabled	Bool	选填	是否支持麦位，只有在麦位上的用户才可以开启音视频。 true：支持。 false：不支持，默认不支持。
TakeSeatMode	String	选填	当使用麦位能力时候（isSeatEnabled为ture），需要填写麦位模式： FreeToTake（自由上麦，无需房主同意可以直接上麦）。 ApplyToTake（申请上麦，上麦申请需房主同意后才可以上麦）。
MaxSeatCount	Integer	选填	最大麦位数，当使用麦位能力时候，默认为套餐包上限，详见文档TUILiveKit 能力版本计费说明。
ActivityStatus	Integer	选填	直播间活跃状态：用户自定义直播间状态标记。例如：0：游戏准备中； 1: 游戏中； 2: 游戏结束。
IsUnlimitedRoomEnabled	Bool	选填	是否开启房间混流，房间混流用于优化视频直播的高并发场景， true：开启。 false：关闭，默认为 false。

错误码	含义说明
100001	服务器内部错误，请重试。
100002	请参数非法，请根据错误描述检查请求是否正确。
100003	房间 ID 已存在，请选择其他房间 ID。
100007	无付费信息，需在控制台购买套餐包。
100010	房间 ID 已被使用，并且操作者为房主，可以直接使用。
100011	房间 ID 已被 IM 占用，可以换一个房间 ID 使用，或者先通过 IM 接口解散该群。
100012	创建房间超过频率超限，同一房间 ID 1秒内只能创建一次。

创建房间

本页目录：

功能说明

接口调用说明

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

可能触发的回调

接口调试工具