实时互动-教育版获取课堂配置信息

1. 接口描述

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

获取房间配置信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeRoom。
Version	是	String	公共参数，本接口取值：2022-08-17。
Region	否	String	公共参数，此参数为可选参数。
RoomId	是	Integer	课堂Id。示例值：301234567
RTMPStreamingURL	否	Integer	请求RTMP推流链接，0：否，1：是，默认为0。示例值：0

3. 输出参数

参数名称	类型	描述
Name	String	课堂名称。示例值：房间名称
StartTime	Integer	预定的课堂开始时间，unix时间戳（秒）。示例值：1659600138
EndTime	Integer	预定的课堂结束时间，unix时间戳（秒）。示例值：1659600138
TeacherId	String	老师的UserId。示例值：1jmPi2qddazF5PTgJtGYss9bg4T
SdkAppId	Integer	低代码互动课堂的SdkAppId。示例值：123467
AudienceType	Integer	观看类型。互动观看（默认）示例值：1
Resolution	Integer	头像区域，摄像头视频画面的分辨率。可以有如下取值： 1 标清 2 高清 3 全高清示例值：1
MaxMicNumber	Integer	设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。示例值：1
AutoMic	Integer	进入课堂时是否自动连麦。可以有以下取值： 0 不自动连麦（需要手动申请上麦，默认值） 1 自动连麦示例值：1
AudioQuality	Integer	高音质模式。可以有以下取值： 0 不开启高音质（默认值） 1 开启高音质示例值：1
SubType	String	课堂子类型，可以有以下取值：videodoc 文档+视频video 纯视频示例值：video
DisableRecord	Integer	上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。示例值：1
Assistants	Array of String	助教UserId列表。示例值： [azsdasfsdfsd,asefawefew]
RecordUrl	String	录制地址（协议为https)。仅在房间结束后存在。示例值：https://abc.mp4
Status	Integer	课堂状态。0为未开始，1为已开始，2为已结束，3为已过期。示例值：0
GroupId	String	课堂绑定的群组ID 示例值：2435342
EnableDirectControl	Integer	打开学生麦克风/摄像头的授权开关示例值：0
InteractionMode	Integer	开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教示例值：0
VideoOrientation	Integer	横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型示例值：0
IsGradingRequiredPostClass	Integer	该课堂是否开启了课后评分功能。0：未开启 1：开启示例值：0
RoomType	Integer	课堂类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (后续扩展)注：大班课的布局(layout)只有三分屏示例值：0
VideoDuration	Integer	录制时长示例值：0
EndDelayTime	Integer	拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟示例值：0
LiveType	Integer	直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播示例值：0
RecordLiveUrl	String	伪直播链接示例值：https://1101910181.vod2.myqcloud.com/6casjaisjaidcq1101910181/d26589e12312512121842/f0.mp4
EnableAutoStart	Integer	是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效示例值：0
RecordBackground	String	录制文件背景图片，支持png、jpg、jpeg、bmp格式，暂不支持透明通道示例值：https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/desktop-02_219090_210001.png
RTMPStreamingURL	String	RTMP推流链接示例值：rtmp://rtmp.rtc.qq.com/push/301234567?sdkappid=141234567&userid=abcdefg123456789&usersig=&use_number_room_id=1
RecordScene	String	录制自定义场景，仅recordlayout=9的时候此参数有效示例值：default
RecordLang	String	录制自定义语言，仅recordlayout=9的时候此参数有效示例值：en
RecordStream	Integer	录制类型 0 仅录制混流（默认） ;1 录制混流+单流，该模式下除混流录制基础上，分别录制老师、台上学生的音视频流，每路录制都会产生相应的录制费用。示例：0 示例值：1
RecordLayout	Integer	录制模板。房间子类型为视频+白板（SubType=videodoc）时默认为3，房间子类型为纯视频（SubType=video）时默认为0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744 示例值：3
WhiteBoardSnapshotMode	Integer	板书截图生成类型。0 不生成板书；1 全量模式；2 单页去重模式示例值：0
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

获取房间信息

输入示例

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

{
    "RoomId": 331450358
}

输出示例

{
    "Response": {
        "Assistants": [],
        "AudienceType": 1,
        "AudioQuality": 0,
        "AutoMic": 0,
        "DisableRecord": 0,
        "EnableDirectControl": 0,
        "EndTime": 1687943391,
        "GroupId": "",
        "InteractionMode": 1,
        "IsGradingRequiredPostClass": 0,
        "MaxMicNumber": 2,
        "Name": "测试1",
        "RecordUrl": "",
        "RequestId": "a8dea9b9-5172-4c01-a53d-5a53437f7fdf",
        "Resolution": 1,
        "RoomType": 1,
        "SdkAppId": 3923193,
        "StartTime": 1687943339,
        "Status": 0,
        "SubType": "video",
        "TeacherId": "2O2bjPEXxStIac3NC9kfH3mHeBC",
        "VideoOrientation": 1,
        "VideoDuration": 0
    }
}

示例2 房间信息

获取课堂房间信息

输入示例

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

{
    "RoomId": 1
}

输出示例

{
    "Response": {
        "AutoMic": 1,
        "RecordUrl": "https://example.com/test.mp4",
        "Name": "sdsdsdf",
        "AudioQuality": 1,
        "MaxMicNumber": 1,
        "SubType": "videodoc",
        "SdkAppId": 1,
        "RequestId": "sdfgsdfg",
        "StartTime": 1,
        "AudienceType": 1,
        "TeacherId": "sdfgsdefg",
        "Assistants": [
            "test"
        ],
        "EndTime": 1,
        "Resolution": 1,
        "DisableRecord": 1,
        "Status": 0,
        "EnableDirectControl": 0,
        "GroupId": "afdg"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
ResourceNotFound.Room	房间不存在。

热门搜索HOT

搜索趋势NEW

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

云函数

私有网络

API 网关

批量计算

专线接入

对象存储

微服务平台 TSF

文件存储

全站加速网络

消息队列 CKafka 版

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

云数据库 Redis®

内容分发网络 CDN

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

数据传输服务

全球应用加速

腾讯云区块链服务平台 TBaaS

云拨测

访问管理

主机安全

标签

DDoS 防护

Web 应用防火墙

密钥管理系统

操作审计

域名注册

SSL 证书

数据万象

短信

NLP 技术

云点播

云加密机

云市场

云安全中心

云开发 CloudBase

人脸识别

腾讯云数据仓库 TCHouse-P

文字识别

流计算 Oceanus

图像识别

口语评测（基础版）

集团账号管理

Elasticsearch Service

媒体处理

云直播

云联络中心

机器翻译

物联网通信

人脸融合

游戏数据库 TcaplusDB

弹性 MapReduce

腾讯云 BI

游戏多媒体引擎

实时音视频

TI-ONE 训练平台

渠道合作伙伴

数据安全审计

腾讯云 CA

腾讯云健康看板

文旅客情大数据

商场客留大数据

声音复刻

云压测

实时互动-工业能源版

腾讯健康组学平台

大模型图像创作引擎

数据加速器 GooseFS