API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 实时互动-教育版 > 房间管理相关接口 > 创建房间

创建房间

最近更新时间：2024-04-18 01:23:21

我的收藏

本页目录：

1. 接口描述

接口请求域名： lcic.tencentcloudapi.com 。

创建房间

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateRoom。
Version 是 String 公共参数，本接口取值：2022-08-17。
Region 否 String 公共参数，此参数为可选参数。
Name 是 String 房间名称。
示例值：房间名称
StartTime 是 Integer 预定的房间开始时间，unix时间戳（秒）。
示例值：1659600138
EndTime 是 Integer 预定的房间结束时间，unix时间戳（秒）。
示例值：1659600138
SdkAppId 是 Integer 低代码互动课堂的SdkAppId。
示例值：123467
Resolution 是 Integer 分辨率。可以有如下取值：
1 标清
2 高清
3 全高清
示例值：1
MaxMicNumber 是 Integer 设置房间/课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。
示例值：0
SubType 是 String 房间子类型，可以有以下取值：
videodoc 文档+视频
video 纯视频
示例值：videodoc
TeacherId 否 String 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。
示例值：1jmPi2qddazF5PTgJtGYss9bg4T
AutoMic 否 Integer 进入课堂时是否自动连麦。可以有以下取值：
0 不自动连麦（需要手动申请上麦，默认值）
1 自动连麦
示例值：1
TurnOffMic 否 Integer 释放音视频权限后是否自动取消连麦。可以有以下取值：
0 自动取消连麦（默认值）
1 保持连麦状态
示例值：1
AudioQuality 否 Integer 声音音质。可以有以下取值：
0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。
示例值：1
DisableRecord 否 Integer 上课后是否禁止自动录制。可以有以下取值：
0 不禁止录制（自动开启录制，默认值）
1 禁止录制
注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。
示例值：1
Assistants.N 否 Array of String 助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。
示例值：[azsdasfsdfsd,asefawefewf]]
RTCAudienceNumber 否 Integer rtc人数。
示例值：0
AudienceType 否 Integer 观看类型。互动观看 （默认）
示例值：0
RecordLayout 否 Integer 录制模板。房间子类型为视频+白板（SubType=videodoc）时默认为3，房间子类型为纯视频（SubType=video）时默认为0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744
示例值：1
GroupId 否 String 房间绑定的群组ID,非空时限制组成员进入
示例值：abc
EnableDirectControl 否 Integer 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
0 不允许直接控制（需同意，默认值）
1 允许直接控制（无需同意）
示例值：0
InteractionMode 否 Integer 开启专注模式。
0 收看全部角色音视频(默认)
1 只看老师和助教
示例值：0
VideoOrientation 否 Integer 横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型
示例值：0
IsGradingRequiredPostClass 否 Integer 开启课后评分。 0：不开启(默认) 1：开启
示例值：0
RoomType 否 Integer 房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (预留参数，暂未开放)
注：大班课的布局(layout)只有三分屏
示例值：0
EndDelayTime 否 Integer 拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟
示例值：0
LiveType 否 Integer 直播类型：0 常规（默认）1 伪直播
示例值：0
RecordLiveUrl 否 String 伪直播链接
示例值：www.demo.com
EnableAutoStart 否 Integer 是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效
示例值：0
RecordBackground 否 String 录制文件背景图片，支持png、jpg、jpeg、bmp格式，暂不支持透明通道
示例值：www.demo.com/test.png
RecordScene 否 String 录制自定义场景，仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。
示例值：{"scene":"test","lng":"zh","type":"h5","subjectId":"57","customToken":"sajdlfjasdglweqirouoiu"}

3. 输出参数

参数名称 类型 描述
RoomId Integer 房间ID。
示例值：301234567
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建房间

示例

输入示例

POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRoom
<公共请求参数>

{
    "Name": "abc",
    "StartTime": 1,
    "EndTime": 1,
    "TeacherId": "abc",
    "SdkAppId": 1,
    "Resolution": 1,
    "MaxMicNumber": 1,
    "AutoMic": 1,
    "TurnOffMic": 1,
    "AudioQuality": 1,
    "SubType": "abc",
    "DisableRecord": 1,
    "Assistants": [
        "abc"
    ],
    "RTCAudienceNumber": 1,
    "AudienceType": 1,
    "RecordLayout": 1,
    "GroupId": "abc",
    "InteractionMode": 1,
    "VideoOrientation": 1,
    "IsGradingRequiredPostClass": 1,
    "RoomType": 1,
    "EnableDirectControl": 0
}

输出示例

{
    "Response": {
        "RoomId": 1,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
FailedOperation.ClassTooLong 课堂时长不能超过5小时。
FailedOperation.RequestTimedOut 请求超时
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.Content 内容包含非法信息（如色情，恐暴，政治等）。
InvalidParameter.EndTime 结束时间不能早于开始时间。
InvalidParameter.RoomTypeInvalid room类型错误
InvalidParameter.SdkAppId SdkAppId参数错误。
InvalidParameter.StartTime 开始时间不能早于当前时间。
ResourceInsufficient 资源不足。
ResourceInsufficient.Record 存储空间已无剩余，无法使用存储功能。
ResourceInsufficient.Room 打开课堂失败，请前往控制台查看用量情况。
ResourceNotFound.GroupNotExist 群组不存在
ResourceNotFound.User 用户不存在。
中国站