实时互动-教育版修改课堂

1. 接口描述

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

修改房间

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyRoom。
Version	是	String	公共参数，本接口取值：2022-08-17。
Region	否	String	公共参数，此参数为可选参数。
RoomId	是	Integer	房间ID。示例值：312345678
SdkAppId	是	Integer	低代码互动课堂的SdkAppId 示例值：123467
StartTime	否	Integer	预定的房间开始时间，unix时间戳（秒）。直播开始后不允许修改。示例值：1659600138
EndTime	否	Integer	预定的房间结束时间，unix时间戳（秒）。直播开始后不允许修改。示例值：1659600138
TeacherId	否	String	老师ID。直播开始后不允许修改。示例值：1jmPi2qddazF5PTgJtGYss9bg4T
Name	否	String	房间名称。示例值：房间名称
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 禁止录制直播开始后不允许修改。示例值：1
Assistants.N	否	Array of String	助教Id列表。直播开始后不允许修改。示例值： [azsdasfsdfsd,asefawefew]
GroupId	否	String	房间绑定的群组ID。直播开始后不允许修改。示例值：490194023
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
RecordLayout	否	Integer	录制模板。仅可修改还未开始的房间。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744 示例值：0
EndDelayTime	否	Integer	拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟示例值：0
LiveType	否	Integer	直播方式：0 常规模式（默认）1 回放直播模式（伪直播）。目前支持从回放直播模式（伪直播）改为常规模式，不支持从常规模式改为回放直播模式（伪直播）示例值：0
RecordLiveUrl	否	String	伪直播链接示例值：https://1101910181.vod2.myqcloud.com/6casjaisjaidcq1101910181/d26589e12312512121842/f0.mp4
EnableAutoStart	否	Integer	是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效示例值：0
RecordScene	否	String	录制自定义场景，仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。示例值：{"scene":"test","lng":"zh","type":"h5","subjectId":"57","customToken":"sajdlfjasdglweqirouoiu"}
WhiteBoardSnapshotMode	否	Integer	板书截图生成类型。0 不生成板书；1 全量模式；2 单页去重模式示例值：0

3. 输出参数

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

4. 示例

示例1 示例

修改类型

输入示例

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

{
    "RoomId": 368760996,
    "SdkAppId": 3520371,
    "InteractionMode": 0,
    "VideoOrientation": 0,
    "IsGradingRequiredPostClass": 1,
    "RoomType": 0
}

输出示例

{
    "Response": {
        "RequestId": "50034c8f-cd77-43f2-815e-afe990fb023d"
    }
}

示例2 修改房间

修改房间参数示例

输入示例

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

{
    "RoomId": 301234567,
    "StartTime": 1704074400,
    "EndTime": 1704076200,
    "TeacherId": "2i5WfUzRRC2Eb2uNmLNv96gzxCv",
    "Name": "myClass",
    "Resolution": 1,
    "MaxMicNumber": 1,
    "AutoMic": 1,
    "AudioQuality": 1,
    "SubType": "videodoc",
    "DisableRecord": 1,
    "Assistants": [
        "2d3FgsZRRB2EbRu5Cwe8Rd7R6Bc"
    ],
    "SdkAppId": 1,
    "GroupId": "301234567",
    "EnableDirectControl": 1
}

输出示例

{
    "Response": {
        "RequestId": "e574aae1-lp02-4225-a2f8-9032h7199f5f0"
    }
}

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	操作失败。
FailedOperation.ClassEnded	房间状态错误，房间已结束。
FailedOperation.ClassExpired	房间状态错误，房间已过期。
FailedOperation.ClassStarted	课堂状态错误，课堂已开始。
FailedOperation.ClassTooLong	预约课堂的时长不能超过72小时（不影响实际上课）。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.Content	文案涉及敏感词，请调整后重新输入。
InvalidParameter.EndTime	结束时间不能早于开始时间。
InvalidParameter.SdkAppId	SdkAppId参数错误。
InvalidParameter.StartTime	开始时间不能早于当前时间。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
ResourceNotFound.Room	房间不存在。
ResourceNotFound.User	用户不存在。
UnknownParameter	未知参数错误。

近期搜索热词

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

云函数

私有网络

批量计算

API 网关

专线接入

对象存储

微服务平台 TSF

文件存储

消息队列 CKafka 版

全站加速网络

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

云数据库 Redis®

内容分发网络 CDN

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

数据传输服务

全球应用加速

腾讯云区块链服务平台 TBaaS

云拨测

访问管理

主机安全

标签

DDoS 防护

密钥管理系统

Web 应用防火墙

操作审计

域名注册

SSL 证书

数据万象

短信

NLP 技术

云点播

云市场

云加密机

云安全中心

云开发 CloudBase

文字识别

流计算 Oceanus

腾讯云数据仓库 TCHouse-P

人脸识别

Elasticsearch Service

集团账号管理

口语评测（基础版）

图像识别

媒体处理

云直播

云联络中心

机器翻译

物联网通信

人脸融合

游戏数据库 TcaplusDB

弹性 MapReduce

游戏多媒体引擎

腾讯云 BI

实时音视频

渠道合作伙伴

TI-ONE 训练平台

数据安全审计

分布式身份

数据加速器 GooseFS

腾讯云健康看板

统一 Catalog 服务

消息队列 RabbitMQ 版

声音复刻

文旅客情大数据

实时互动-工业能源版

腾讯健康组学平台

大模型图像创作引擎

云压测