{ "name": "lcic", "display_name": "实时互动-教育版", "description": "介绍如何使用API对实时互动-教育版进行操作，包括课堂管理，用户管理，应用管理等", "domain": "other", "api_version": "2022-08-17", "endpoint": "lcic.tencentcloudapi.com", "actions": [ { "name": "AddGroupMember", "description": "此接口用于添加成员列表到指定群组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "群组ID", "example": "dfgsdgsg" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "3520371" }, { "name": "MemberIds", "type": "array", "required": true, "description": "成员列表，最大值200", "example": "[member1,member2]", "item_type": "string" } ], "required": [ "GroupId", "SdkAppId", "MemberIds" ] }, { "name": "BatchAddGroupMember", "description": "此接口用于批量添加成员列表到指定群组", "status": "online", "parameters": [ { "name": "GroupIds", "type": "array", "required": true, "description": "待添加群组ID列表，最大值100", "example": "dfgsdgsg", "item_type": "string" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "3520371" }, { "name": "MemberIds", "type": "array", "required": true, "description": "待添加成员列表，最大值200", "example": "[azsdasfsdfsd,asefawefew]", "item_type": "string" } ], "required": [ "GroupIds", "SdkAppId", "MemberIds" ] }, { "name": "BatchCreateGroupWithMembers", "description": "此接口用于批量创建群组", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "13465287" }, { "name": "GroupBaseInfos", "type": "array", "required": true, "description": "批量创建群组基础信息，最大长度限制256", "example": "无", "item_type": "object", "children": [ { "name": "GroupName", "type": "string", "required": true, "description": "待创建群组名", "example": "群组名称" }, { "name": "TeacherId", "type": "string", "required": false, "description": "群组主讲人ID", "example": "Teacher_9657" } ] }, { "name": "MemberIds", "type": "array", "required": false, "description": "群组绑定的成员列表，一次性最多200个", "example": "['2d3FgsZRRB2EbRu5Cwe8Rd7R6Bc','2aiT64yygupUJ5zrkRi2r3hh54x']", "item_type": "string" } ], "required": [ "SdkAppId", "GroupBaseInfos" ] }, { "name": "BatchCreateRoom", "description": "批量创建房间接口", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台的SdkAppId。", "example": "379829232" }, { "name": "RoomInfos", "type": "array", "required": true, "description": "批量创建课堂的配置信息", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "房间名称。字符数不超过256", "example": "房间名称" }, { "name": "StartTime", "type": "integer", "required": true, "description": "预定的房间开始时间，unix时间戳。", "example": "1659600138" }, { "name": "EndTime", "type": "integer", "required": true, "description": "预定的房间结束时间，unix时间戳。", "example": "1659600138" }, { "name": "Resolution", "type": "integer", "required": true, "description": "头像区域，摄像头视频画面的分辨率。可以有如下取值：1 标清2 高清3 全高清", "example": "1" }, { "name": "MaxMicNumber", "type": "integer", "required": true, "description": "设置房间/课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。", "example": "1" }, { "name": "SubType", "type": "string", "required": true, "description": "房间子类型，可以有以下取值： videodoc 文档+视频 video 纯视频", "example": "videodoc" }, { "name": "TeacherId", "type": "string", "required": false, "description": "老师ID。通过[注册用户]接口获取的UserId。", "example": "1jmPi2qddazF5PTgJtGYss9bg4T" }, { "name": "AutoMic", "type": "integer", "required": false, "description": "进入课堂时是否自动连麦。可以有以下取值： 0 不自动连麦（需要手动申请上麦，默认值） 1 自动连麦", "example": "1" }, { "name": "TurnOffMic", "type": "integer", "required": false, "description": "释放音视频权限后是否自动取消连麦。可以有以下取值： 0 自动取消连麦（默认值） 1 保持连麦状态", "example": "1" }, { "name": "AudioQuality", "type": "integer", "required": false, "description": "高音质模式。可以有以下取值： 0 不开启高音质（默认值） 1 开启高音质", "example": "1" }, { "name": "DisableRecord", "type": "integer", "required": false, "description": "上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。", "example": "1" }, { "name": "Assistants", "type": "array", "required": false, "description": "助教Id列表。通过[注册用户]接口获取的UserId。", "example": "[\"azsdasfsdfsd\",\"asefawefewf\"]", "item_type": "string" }, { "name": "AudienceType", "type": "integer", "required": false, "description": "观看类型。", "example": "1" }, { "name": "RecordLayout", "type": "integer", "required": false, "description": "录制布局。", "example": "1" }, { "name": "GroupId", "type": "string", "required": false, "description": "房间绑定的群组ID", "example": "xfdfgdf" }, { "name": "EnableDirectControl", "type": "integer", "required": false, "description": "打开学生麦克风/摄像头的授权开关", "example": "0" }, { "name": "InteractionMode", "type": "integer", "required": false, "description": "开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教", "example": "0" }, { "name": "VideoOrientation", "type": "integer", "required": false, "description": "横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型", "example": "0" }, { "name": "IsGradingRequiredPostClass", "type": "integer", "required": false, "description": "开启课后评分。 0：不开启(默认) 1：开启", "example": "0" }, { "name": "RoomType", "type": "integer", "required": false, "description": "课堂类型: 0 小班课（默认值）; 1 大班课; 2 1V1 (预留参数，暂未开放); 3 圆桌会议 注：大班课的布局(layout)只有三分屏", "example": "0" }, { "name": "EndDelayTime", "type": "integer", "required": false, "description": "拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟", "example": "0" }, { "name": "LiveType", "type": "integer", "required": false, "description": "直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播", "example": "0" }, { "name": "RecordLiveUrl", "type": "string", "required": false, "description": "伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。", "example": "https://791263.vod-qcloud.com/425sfabhs7814/e9049470840ghjk739827/1INCKHSY9QMA.mp4" }, { "name": "EnableAutoStart", "type": "integer", "required": false, "description": "是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效", "example": "0" }, { "name": "RecordBackground", "type": "string", "required": false, "description": "录制文件背景图片，支持png、jpg、jpeg、bmp格式，暂不支持透明通道", "example": "https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/desktop-02_219090_210001.png" }, { "name": "RecordScene", "type": "string", "required": false, "description": "录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。自定义场景参数的含义。如下： scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的\ufffd\ufffd...", "example": "{\"scene\":\"test\",\"lng\":\"zh\",\"customToken\":\"sajdlfjasdglweqirouoiu\"}" }, { "name": "RecordStream", "type": "integer", "required": false, "description": "录制类型 0 仅录制混流（默认） ;1 录制混流+单流，该模式下除混流录制基础上，分别录制老师、台上学生的音视频流，每路录制都会产生相应的录制费用 。示例：0", "example": "1" }, { "name": "WhiteBoardSnapshotMode", "type": "integer", "required": false, "description": "板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式", "example": "0" }, { "name": "SubtitlesTranscription", "type": "integer", "required": false, "description": "字幕转写功能开关。可以有以下取值：0 不开启字幕转写功能（默认值）1 自动转写模式：上课自动开启，下课自动停止2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关", "example": "0" }, { "name": "Guests", "type": "array", "required": false, "description": "嘉宾Id列表。当圆桌会议模式（RoomType==3）时生效", "example": "[\"azsdasfsdfsd\",\"asefawefewf\"]", "item_type": "string" }, { "name": "RecordMerge", "type": "integer", "required": false, "description": "录制文件合并开关。0 关闭 1 开启 注：只有在一节课多次启用手动录制时，此功能才有效", "example": "0" } ] } ], "required": [ "SdkAppId", "RoomInfos" ] }, { "name": "BatchDeleteGroupMember", "description": "此接口用于批量删除成员列表到指定群组列表", "status": "online", "parameters": [ { "name": "GroupIds", "type": "array", "required": true, "description": "待添加群组ID列表，最大值100", "example": "dfgsdgsg", "item_type": "string" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "3520371" }, { "name": "MemberIds", "type": "array", "required": true, "description": "待添加成员列表，最大值256", "example": "['asdad','asdasd']", "item_type": "string" } ], "required": [ "GroupIds", "SdkAppId", "MemberIds" ] }, { "name": "BatchDeleteRecord", "description": "批量删除多个房间的录制文件", "status": "online", "parameters": [ { "name": "RoomIds", "type": "array", "required": true, "description": "房间ID列表", "example": "[123,456]", "item_type": "integer" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "1400001" } ], "required": [ "RoomIds", "SdkAppId" ] }, { "name": "BatchDescribeDocument", "description": "批量获取文档详情", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "3520371" }, { "name": "Page", "type": "integer", "required": true, "description": "分页查询当前页数，从1开始递增", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "每页数据量，最大200", "example": "100" }, { "name": "Permission", "type": "array", "required": true, "description": "课件权限。[0]：获取owner的私有课件；[1]：获取owner的公开课件; [0,1]：则获取owner的私有课件和公开课件；[2]：获取owner的私有课件和所有人(包括owner)的公开课件", "example": "[0]", "item_type": "integer" }, { "name": "Owner", "type": "string", "required": false, "description": "课件所有者的user_id，不填默认获取SdkAppId下所有课件", "example": "abc123" }, { "name": "Keyword", "type": "string", "required": false, "description": "课件名称搜索词", "example": "课件1" }, { "name": "DocumentId", "type": "array", "required": false, "description": "课件id列表，从列表中查询，忽略错误的id", "example": "doc123", "item_type": "string" } ], "required": [ "SdkAppId", "Page", "Limit", "Permission" ] }, { "name": "BatchGetPlaybackToken", "description": "批量获取信令录制回放token，用于回放指定课堂时鉴权", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台的SdkAppId。", "example": "3923193" }, { "name": "RoomIds", "type": "array", "required": true, "description": "房间ID。", "example": "[305745891]", "item_type": "integer" }, { "name": "ExpireSeconds", "type": "integer", "required": false, "description": "token过期时间，单位秒。如果传0则表示不过期", "example": "0" } ], "required": [ "SdkAppId", "RoomIds" ] }, { "name": "BatchRegister", "description": "如果批量注册的用户已存在，则会被覆盖。一次最多注册1000个用户。默认请求频率限制：10次/秒", "status": "online", "parameters": [ { "name": "Users", "type": "array", "required": true, "description": "批量注册用户信息列表", "example": "无", "item_type": "object", "children": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "3467281" }, { "name": "Name", "type": "string", "required": false, "description": "用户名称。", "example": "user123" }, { "name": "OriginId", "type": "string", "required": false, "description": "用户在客户系统的Id，需要在同一应用下唯一。入参为空时默认赋值为UserId 。", "example": "user123" }, { "name": "Avatar", "type": "string", "required": false, "description": "用户头像。", "example": "http://user.com？pic=123" } ] } ], "required": [ "Users" ] }, { "name": "BindDocumentToRoom", "description": "功能概述 本接口提供教学场景下的课程文档预绑定能力，支持将课件课堂ID进行关联映射，实现课件的自动化预加载。 应用场景建议 绑定时机 推荐在创建课堂预约阶段同步完成文档绑定操作，确保课件资源在课堂开始前完成上传。 接口限制与频控策略 频控维度 开发者账号维度限频 默认频控阈值为20 QPS（每秒请求次数） 最佳实践建议 重试策略 当触发限频错误时，建议采用\ufffd...", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID。", "example": "876789" }, { "name": "DocumentId", "type": "string", "required": true, "description": "文档ID。", "example": "ax1esdi2" }, { "name": "BindType", "type": "integer", "required": false, "description": "绑定类型。后台可透传到客户端，默认为0。除以下例值外支持自定义该字段，并在前端实现相应业务逻辑，示例参考： 示例值：0，仅绑定课件到房间 示例值：1，绑定课件到房间后，默认展示课件", "example": "0" } ], "required": [ "RoomId", "DocumentId" ] }, { "name": "CreateDocument", "description": "创建房间内可以使用的文档。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "36718212" }, { "name": "DocumentUrl", "type": "string", "required": true, "description": "文档地址。", "example": "https://www.baidu.com" }, { "name": "DocumentName", "type": "string", "required": true, "description": "文档名称。", "example": "课程文档" }, { "name": "Owner", "type": "string", "required": true, "description": "文档所有者的Id", "example": "Tom" }, { "name": "TranscodeType", "type": "integer", "required": false, "description": "转码类型，可以有如下取值： 0 无需转码（默认），bmp，jpg，jpeg，png，gif 1 需要转码的文档，ppt，pptx，pdf，doc，docx，xls，xlsx 2 需要转码的视频，mp4，3pg，mpeg，avi，flv，wmv，rm，h264等 2 需要转码的音频，mp3，wav，wma，aac，flac，opus 3 备用转码，建议 WPS 制作的课件使用此方式转码，保证课件显示效果 请注意，待录制的页面中任何视频的分辨率不能超过页面录制最大分辨率（1920...", "example": "1" }, { "name": "Permission", "type": "integer", "required": false, "description": "权限，可以有如下取值： 0 私有文档（默认） 1 公共文档", "example": "1" }, { "name": "DocumentType", "type": "string", "required": false, "description": "文档后缀名。", "example": "doc" }, { "name": "DocumentSize", "type": "integer", "required": false, "description": "文档大小，单位 字节", "example": "486" }, { "name": "AutoHandleUnsupportedElement", "type": "boolean", "required": false, "description": "是否对不支持元素开启自动处理的功能。默认关闭。 自动处理的元素如下： 1. 墨迹：移除不支持的墨迹（例如WPS墨迹） 2. 自动翻页：移除PPT上所有自动翻页设置，并设置为单击鼠标翻页 3. 已损坏音视频：移除PPT上对损坏音视频的引用", "example": "false" }, { "name": "MinScaleResolution", "type": "string", "required": false, "description": "转码后文档的最小分辨率，不传、传空字符串或分辨率格式错误则使用文档原分辨率。该参数仅对TranscodeType=1的课件生效。示例：1280x720，注意分辨率宽高中间为英文字母\"xyz\"的\"x\" 示例值：1280x720", "example": "1280x720" } ], "required": [ "SdkAppId", "DocumentUrl", "DocumentName", "Owner" ] }, { "name": "CreateGroupLiveCodes", "description": "创建分组直播参加码", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "38901831" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID。", "example": "23122342" }, { "name": "Number", "type": "integer", "required": true, "description": "分组数量。注：最大数量限制为30", "example": "10" } ], "required": [ "SdkAppId", "RoomId", "Number" ] }, { "name": "CreateGroupWithMembers", "description": "此接口根据成员列表创建群组", "status": "online", "parameters": [ { "name": "GroupName", "type": "string", "required": true, "description": "待创建群组名称", "example": "Group_name" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "3450912" }, { "name": "TeacherId", "type": "string", "required": false, "description": "默认绑定主讲老师ID", "example": "Teacher_98979" }, { "name": "MemberIds", "type": "array", "required": false, "description": "群组成员列表,一次性最多200个", "example": "['asdasd','aasads']", "item_type": "string" } ], "required": [ "GroupName", "SdkAppId" ] }, { "name": "CreateGroupWithSubGroup", "description": "此接口会聚合子群组创建联合群组", "status": "online", "parameters": [ { "name": "GroupName", "type": "string", "required": true, "description": "待创建的新群组名", "example": "Group_name" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "3450918" }, { "name": "SubGroupIds", "type": "array", "required": true, "description": "子群组ID列表，子群组ID不能重复，最多40个", "example": "['subgroup_1','subgroup_2']", "item_type": "string" }, { "name": "TeacherId", "type": "string", "required": false, "description": "群组默认主讲老师ID", "example": "Teacher_9897" } ], "required": [ "GroupName", "SdkAppId", "SubGroupIds" ] }, { "name": "CreateRoom", "description": "创建课堂", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "课堂名称。字符数不超过256", "example": "房间名称" }, { "name": "StartTime", "type": "integer", "required": true, "description": "预定的课堂开始时间，unix时间戳（秒）。", "example": "1659600138" }, { "name": "EndTime", "type": "integer", "required": true, "description": "预定的课堂结束时间，unix时间戳（秒）。", "example": "1659600138" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "123467" }, { "name": "Resolution", "type": "integer", "required": true, "description": "头像区域，摄像头视频画面的分辨率。可以有如下取值：1 标清2 高清3 全高清注意：连麦人数（MaxMicNumber）\u0026gt;6时，仅可使用标清", "example": "1" }, { "name": "MaxMicNumber", "type": "integer", "required": true, "description": "设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。", "example": "0" }, { "name": "SubType", "type": "string", "required": true, "description": "课堂子类型，可以有以下取值：videodoc 文档+视频video 纯视频", "example": "videodoc" }, { "name": "TeacherId", "type": "string", "required": false, "description": "老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。", "example": "1jmPi2qddazF5PTgJtGYss9bg4T" }, { "name": "AutoMic", "type": "integer", "required": false, "description": "进入课堂时是否自动连麦。可以有以下取值：0 不自动连麦（需要手动申请上麦，默认值）1 自动连麦", "example": "1" }, { "name": "TurnOffMic", "type": "integer", "required": false, "description": "释放音视频权限后是否自动取消连麦。可以有以下取值：0 自动取消连麦（默认值）1 保持连麦状态", "example": "1" }, { "name": "AudioQuality", "type": "integer", "required": false, "description": "声音音质。可以有以下取值：0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。", "example": "1" }, { "name": "DisableRecord", "type": "integer", "required": false, "description": "录制方式。枚举值：0： 开启自动录制（默认）1： 禁止录制2： 开启手动录制。（仅支持页面录制，需通过startRecord、stopRecord接口控制录制的开始和结束。）3： 信令录制。", "example": "1" }, { "name": "Assistants", "type": "array", "required": false, "description": "助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。", "example": "[\"azsdasfsdfsd\",\"asefawefewf\"]", "item_type": "string" }, { "name": "AudienceType", "type": "integer", "required": false, "description": "观看类型。互动观看 （默认）", "example": "0" }, { "name": "RecordLayout", "type": "integer", "required": false, "description": "录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744", "example": "1" }, { "name": "GroupId", "type": "string", "required": false, "description": "课堂绑定的群组ID,非空时限制组成员进入", "example": "98781273" }, { "name": "EnableDirectControl", "type": "integer", "required": false, "description": "是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：0 不允许直接控制（需同意，默认值）1 允许直接控制（无需同意）", "example": "0" }, { "name": "InteractionMode", "type": "integer", "required": false, "description": "开启专注模式。0 收看全部角色音视频(默认)1 只看老师和助教", "example": "0" }, { "name": "VideoOrientation", "type": "integer", "required": false, "description": "横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型", "example": "0" }, { "name": "IsGradingRequiredPostClass", "type": "integer", "required": false, "description": "开启课后评分。 0：不开启(默认) 1：开启", "example": "0" }, { "name": "RoomType", "type": "integer", "required": false, "description": "课堂类型。 注：大班课的布局(layout)只有三分屏枚举值：0： 小班课（默认值）1： 大班课2： 1V1 (预留参数，暂未开放);3： 圆桌会议4： 分组直播 默认值：0", "example": "0" }, { "name": "Guests", "type": "array", "required": false, "description": "嘉宾Id列表。当圆桌会议模式（RoomType==3）时生效", "example": "[\"azsdasfsdfsd\",\"asefawefewf\"]", "item_type": "string" }, { "name": "EndDelayTime", "type": "integer", "required": false, "description": "拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟", "example": "0" }, { "name": "LiveType", "type": "integer", "required": false, "description": "直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播", "example": "0" }, { "name": "RecordLiveUrl", "type": "string", "required": false, "description": "伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。", "example": "https://791263.vod-qcloud.com/425sfabhs7814/e9049470840ghjk739827/1INCKHSY9QMA.mp4" }, { "name": "EnableAutoStart", "type": "integer", "required": false, "description": "是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效", "example": "0" }, { "name": "RecordBackground", "type": "string", "required": false, "description": "录制文件背景图片，支持png、jpg、jpeg、bmp格式，暂不支持透明通道", "example": "www.demo.com/test.png" }, { "name": "RecordScene", "type": "string", "required": false, "description": "录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。自定义场景参数的含义。如下： scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的\ufffd\ufffd...", "example": "{\"scene\":\"test\",\"lng\":\"zh\",\"customToken\":\"sajdlfjasdglweqirouoiu\"}" }, { "name": "RecordStream", "type": "integer", "required": false, "description": "录制类型 0 仅录制混流（默认） ;1 录制混流+单流，该模式下除混流录制基础上，分别录制老师、台上学生的音视频流，每路录制都会产生相应的录制费用 。示例：0", "example": "1" }, { "name": "WhiteBoardSnapshotMode", "type": "integer", "required": false, "description": "板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式", "example": "0" }, { "name": "SubtitlesTranscription", "type": "integer", "required": false, "description": "字幕转写功能开关。可以有以下取值：0 不开启字幕转写功能（默认值）1 自动转写模式：上课自动开启，下课自动停止2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关", "example": "0" }, { "name": "RecordMerge", "type": "integer", "required": false, "description": "录制文件合并开关。0 关闭 1 开启 注：只有在一节课多次启用手动录制时，此功能才有效", "example": "0" } ], "required": [ "Name", "StartTime", "EndTime", "SdkAppId", "Resolution", "MaxMicNumber", "SubType" ] }, { "name": "CreateSupervisor", "description": "创建巡课", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用ID。", "example": "1234657" }, { "name": "Users", "type": "array", "required": true, "description": "用户ID列表。", "example": "23LPONM38990", "item_type": "string" } ], "required": [ "SdkAppId", "Users" ] }, { "name": "DeleteAppCustomContent", "description": "删除设置自定义元素。如果参数scenes为空则删除所有自定义元素，否则删除指定的scene自定义元素。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用ID。", "example": "1234657" }, { "name": "Scenes", "type": "array", "required": false, "description": "指定需要删除的已设置的scene场景自定义元素，如果为空则删除应用下已设置的所有自定义元素。", "example": "[\"jaskas\",askao]", "item_type": "string" } ], "required": [ "SdkAppId" ] }, { "name": "DeleteDocument", "description": "删除文档", "status": "online", "parameters": [ { "name": "DocumentId", "type": "string", "required": true, "description": "文档ID。", "example": "fzakslmjpj" } ], "required": [ "DocumentId" ] }, { "name": "DeleteGroup", "description": "此接口用于删除指定群组，支持批量操作。", "status": "online", "parameters": [ { "name": "GroupIds", "type": "array", "required": true, "description": "待删除群组ID列表", "example": "[group1,group2]", "item_type": "string" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "3520371" } ], "required": [ "GroupIds", "SdkAppId" ] }, { "name": "DeleteGroupMember", "description": "此接口用于删除群组中指定成员", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "群组ID，联合群组无法删除群组成员", "example": "dfgsdgsg" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "3520371" }, { "name": "MemberIds", "type": "array", "required": true, "description": "成员列表，最大值200", "example": "['asdad','asdasd']", "item_type": "string" } ], "required": [ "GroupId", "SdkAppId", "MemberIds" ] }, { "name": "DeletePlaybackItem", "description": "删除该堂课的录制记录", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "3520371" }, { "name": "RoomId", "type": "integer", "required": true, "description": "课堂ID。", "example": "340599814" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "DeleteRecord", "description": "删除指定房间的录制文件", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "房间Id。", "example": "24323" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "9087675" } ], "required": [ "RoomId", "SdkAppId" ] }, { "name": "DeleteRoom", "description": "删除房间 删除课堂前，请先删除该课堂下的各类资源（包括录制文件、板书等），并解绑相关课件。", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "课堂ID。", "example": "3123456789" } ], "required": [ "RoomId" ] }, { "name": "DeleteSupervisor", "description": "删除巡课", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用ID", "example": "13465287" }, { "name": "Users", "type": "array", "required": true, "description": "用户ID列表", "example": "[2d3FgsZRRB2EbR5Cwe8Rd7R6Bc,2aiT64yygupUJ5zrkRi2r3hh54x]", "item_type": "string" } ], "required": [ "SdkAppId", "Users" ] }, { "name": "DeleteUser", "description": "删除已注册用户。注：如果该成员已被添加到群组，请先在群组中删除该成员。", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "待删除用户的ID", "example": "Tomfsdss" } ], "required": [ "UserId" ] }, { "name": "DeleteWhiteBoardSnapshot", "description": "删除白板板书截图", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": false, "description": "课堂ID", "example": "301234567" } ], "required": [] }, { "name": "DescribeAnswerList", "description": "获取房间答题详情", "status": "online", "parameters": [ { "name": "QuestionId", "type": "string", "required": true, "description": "问题ID", "example": "0491cbde-opd4-4d4c-a063-96864eccc73c" }, { "name": "Page", "type": "integer", "required": false, "description": "1", "example": "分页查询当前页数，从1开始递增，默认值为1" }, { "name": "Limit", "type": "integer", "required": false, "description": "100", "example": "每页数据量，最大1000，默认值为100" } ], "required": [ "QuestionId" ] }, { "name": "DescribeAppDetail", "description": "获取应用详情", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID。低代码互动课堂的SdkAppId。", "example": "140000011" }, { "name": "DeveloperId", "type": "string", "required": true, "description": "开发商ID", "example": "43234543asda" } ], "required": [ "ApplicationId", "DeveloperId" ] }, { "name": "DescribeCurrentMemberList", "description": "获取当前房间的成员列表，房间结束或过期后无法使用。", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "课堂Id。", "example": "2981712" }, { "name": "Page", "type": "integer", "required": true, "description": "分页查询当前页数，从1开始递增。", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "每页数据量，最大1000。", "example": "10" } ], "required": [ "RoomId", "Page", "Limit" ] }, { "name": "DescribeDeveloper", "description": "开发商信息获取", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDocument", "description": "获取文档信息", "status": "online", "parameters": [ { "name": "DocumentId", "type": "string", "required": true, "description": "文档Id（唯一id）", "example": "rbbepxt" } ], "required": [ "DocumentId" ] }, { "name": "DescribeDocuments", "description": "有新接口替换 批量获取文档信息（已废弃，替代接口BatchDescribeDocument）", "status": "deprecated", "parameters": [ { "name": "SchoolId", "type": "integer", "required": true, "description": "学校id", "example": "1234" }, { "name": "Page", "type": "integer", "required": true, "description": "分页查询当前页数，从1开始递增", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "每页数据量，最大1000", "example": "100" }, { "name": "Permission", "type": "array", "required": true, "description": "课件权限。[0]：获取owner的私有课件；[1]：获取owner的公开课件; [0,1]：则获取owner的私有课件和公开课件；[2]：获取owner的私有课件和所有人(包括owner)的公开课件", "example": "0", "item_type": "integer" }, { "name": "Owner", "type": "string", "required": false, "description": "课件所有者的user_id，不填默认获取school_id下所有课件", "example": "978HopHp" }, { "name": "Keyword", "type": "string", "required": false, "description": "课件名称搜索词", "example": "mpLOdp" }, { "name": "DocumentId", "type": "array", "required": false, "description": "课件id列表，从列表中查询，忽略错误的id", "example": "23423", "item_type": "string" } ], "required": [ "SchoolId", "Page", "Limit", "Permission" ] }, { "name": "DescribeDocumentsByRoom", "description": "此接口获取指定房间下课件列表", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID。", "example": "3123456" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId", "example": "3789212" }, { "name": "Page", "type": "integer", "required": false, "description": "分页查询当前页数，从1开始递增，默认值为1", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数据量，最大1000，默认值为100", "example": "100" }, { "name": "Permission", "type": "array", "required": false, "description": "课件权限。 [0]：获取owner的私有课件； [1]：获取owner的公开课件; [0,1]：则获取owner的私有课件和公开课件； [2]：获取owner的私有课件和所有人(包括owner)的公开课件。 默认值为[2]", "example": "[2]", "item_type": "integer" }, { "name": "Owner", "type": "string", "required": false, "description": "文档所有者的user_id，不填默认获取SdkAppId下所有课件", "example": "Teacher" } ], "required": [ "RoomId", "SdkAppId" ] }, { "name": "DescribeGroup", "description": "此接口用于获取群组详情", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "群组ID", "example": "dfgsdgsg" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "13465287" } ], "required": [ "GroupId", "SdkAppId" ] }, { "name": "DescribeGroupList", "description": "获取群组列表", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "3463813" }, { "name": "Page", "type": "integer", "required": false, "description": "分页查询当前页数，默认从1开始递增。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数据量，默认20，最大1000。", "example": "10" }, { "name": "TeacherId", "type": "string", "required": false, "description": "主讲人ID筛选群组，与MemberId有且只有一个,都传时以此字段获取", "example": "Tom" }, { "name": "MemberId", "type": "string", "required": false, "description": "成员ID刷选群组，与TeacherId有且只有一个", "example": "jhgfhgsfdsYsdd " } ], "required": [ "SdkAppId" ] }, { "name": "DescribeGroupLiveCodes", "description": "获取分组直播参加码", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": false, "description": "学校ID", "example": "38742230" }, { "name": "RoomId", "type": "integer", "required": false, "description": "房间ID", "example": "3323849" } ], "required": [] }, { "name": "DescribeGroupMemberList", "description": "此接口用于获取群组成员列表", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "群组ID", "example": "dfgsdgs" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "325372" }, { "name": "Page", "type": "integer", "required": false, "description": "分页值，默认1", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数据量，默认20，最大1000", "example": "10" } ], "required": [ "GroupId", "SdkAppId" ] }, { "name": "DescribeMarquee", "description": "查询跑马灯配置", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "学校ID", "example": "3879279" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间号", "example": "345214" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "DescribePlayRecords", "description": "信令录制视频观看记录查询接口，用于查询指定课堂在指定时间段内的用户播放记录。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "3520371" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID。", "example": "322220255" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间，unix时间戳（秒）。", "example": "1770174290" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间，unix时间戳（秒）。", "example": "1770260690" }, { "name": "Page", "type": "integer", "required": true, "description": "页码，从1开始递增。默认值：1", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页获取的记录条数。取值范围：[1, 200]默认值：20", "example": "10" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID。", "example": "2qkMhWixIzNQC7UizlM7*******" } ], "required": [ "SdkAppId", "RoomId", "StartTime", "EndTime", "Page", "PageSize" ] }, { "name": "DescribePlaybackList", "description": "查询录制信息", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台的SdkAppId。", "example": "3923193" }, { "name": "RoomId", "type": "integer", "required": false, "description": "房间ID", "example": "352214288" }, { "name": "Page", "type": "integer", "required": false, "description": "分页查询当前页数，从1开始递增", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "默认10条，最大上限为100条", "example": "10" } ], "required": [ "SdkAppId" ] }, { "name": "DescribeQuestionList", "description": "获取房间提问列表", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID", "example": "312345678" }, { "name": "Page", "type": "integer", "required": false, "description": "分页查询当前页数，从1开始递增，默认值为1", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询当前页数，从1开始递增，默认值为1", "example": "100" } ], "required": [ "RoomId" ] }, { "name": "DescribeRecord", "description": "查询录制信息", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "学校ID", "example": "3456721" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID", "example": "9090" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "DescribeRecordStream", "description": "录制流查询", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "学校ID", "example": "3490281" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID", "example": "9090" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "DescribeRecordTask", "description": "查询录制任务ID", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "学校ID", "example": "3456721" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID", "example": "9090" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "DescribeRoom", "description": "获取房间配置信息", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "课堂Id。", "example": "301234567" }, { "name": "RTMPStreamingURL", "type": "integer", "required": false, "description": "请求RTMP推流链接，0：否，1：是，默认为0。", "example": "0" } ], "required": [ "RoomId" ] }, { "name": "DescribeRoomForbiddenUser", "description": "根据房间ID获取群组中被禁言的用户列表。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "23134" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID。", "example": "12333" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "DescribeRoomStatistics", "description": "获取房间统计信息，仅可在房间结束后调用。", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "课堂Id。", "example": "1234657" }, { "name": "Page", "type": "integer", "required": true, "description": "分页查询当前页数，从1开始递增。", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "每页数据量，最大1000。", "example": "10" } ], "required": [ "RoomId", "Page", "Limit" ] }, { "name": "DescribeScoreList", "description": "获取课堂评分列表", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "课堂ID", "example": "9876" }, { "name": "Page", "type": "integer", "required": false, "description": "分页查询当前页数，从1开始递增", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "默认是10条", "example": "10" } ], "required": [ "RoomId" ] }, { "name": "DescribeSdkAppIdUsers", "description": "此接口用于获取指定应用ID下用户列表", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用ID", "example": "38901092" }, { "name": "Page", "type": "integer", "required": false, "description": "分页，默认值为1", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页数据限制，默认值为20", "example": "1" } ], "required": [ "SdkAppId" ] }, { "name": "DescribeSupervisors", "description": "获取巡课列表", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数据量，最大100。 不填默认20.", "example": "50" }, { "name": "Page", "type": "integer", "required": false, "description": "分页查询当前页数，从1开始递增，不填默认为1。", "example": "1" } ], "required": [ "SdkAppId" ] }, { "name": "DescribeUser", "description": "获取用户信息", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": false, "description": "用户id。支持通过 user_id 或 OriginId 查询用户信息，优先使用 user_id 进行查询。", "example": "2kJJBH6G1dfBFUJqXLh0Mg3ELLk" }, { "name": "OriginId", "type": "string", "required": false, "description": "用户在客户系统的Id。支持通过 user_id 或 OriginId 查询用户信息，优先使用 user_id 进行查询（UserId不为空时，OriginId不生效）。", "example": "46528c8696ca" } ], "required": [] }, { "name": "DescribeUserDetail", "description": "获取用户信息", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": false, "description": "用户id。支持通过 user_id 或 OriginId 查询用户信息，优先使用 user_id 进行查询。", "example": "2kJJBH6G1dfBFUJqXLh0Mg3ELLk" }, { "name": "OriginId", "type": "string", "required": false, "description": "用户在客户系统的Id。支持通过 user_id 或 OriginId 查询用户信息，优先使用 user_id 进行查询（UserId不为空时，OriginId不生效）。", "example": "46528c8696ca" } ], "required": [] }, { "name": "DescribeWhiteBoardSnapshot", "description": "查询白板板书截图 课程结束后，可以查询和以图片的形式导出这些内容，方便后续查看、整理与分享。 注意：不支持屏幕共享中的板书导出。", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": false, "description": "房间ID", "example": "301234567" } ], "required": [] }, { "name": "EndRoom", "description": "结束房间的直播", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "课堂ID", "example": "3123456789" } ], "required": [ "RoomId" ] }, { "name": "ForbidSendMsg", "description": "禁止指定房间中某些用户在一段时间内发言。 取消对某些用户的禁言。 被禁言用户退出房间之后再进入同一房间，禁言仍然有效。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "23134" }, { "name": "RoomId", "type": "integer", "required": true, "description": "课堂ID", "example": "12333" }, { "name": "MembersAccount", "type": "array", "required": true, "description": "需要禁言的用户账号，最多支持500个账号", "example": "peter", "item_type": "string" }, { "name": "MuteTime", "type": "integer", "required": true, "description": "需禁言时间，单位为秒，为0时表示取消禁言，4294967295为永久禁言。", "example": "30" } ], "required": [ "SdkAppId", "RoomId", "MembersAccount", "MuteTime" ] }, { "name": "GetPlaybackToken", "description": "获取信令录制回放token，用于回放指定课堂时鉴权", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台的SdkAppId。", "example": "3520371" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID。", "example": "374377112" }, { "name": "UserId", "type": "string", "required": false, "description": "用户ID。", "example": "2qkMhWixIzNQC7UizlM7*******" }, { "name": "ExpireSeconds", "type": "integer", "required": false, "description": "token过期时间，单位秒。如果传0则表示不过期", "example": "0" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "GetRoomEvent", "description": "获取房间事件,仅在课堂结束1小时内有效。", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "课堂Id。", "example": "301234567" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用Id。", "example": "13465287" }, { "name": "Page", "type": "integer", "required": true, "description": "起始页，1开始。keyword为空时有效。", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "每页个数。keyword为空时有效。一次性最多100条。", "example": "10" }, { "name": "Keyword", "type": "string", "required": false, "description": "搜索事件类型。有以下事件类型: RoomStart:房间开始 RoomEnd:房间结束 MemberJoin:成员加入 MemberQuit:成员退出 RecordFinish:录制结束 CameraOn: 摄像头打开 CameraOff: 摄像头关闭 MicOn: 麦克风打开 MicOff: 麦克风关闭 ScreenOn: 屏幕共享打开 ScreenOff: 屏幕共享关闭 VisibleOn: 页面可见 VisibleOff: 页面不可见", "example": "RoomStart" } ], "required": [ "RoomId", "SdkAppId", "Page", "Limit" ] }, { "name": "GetRoomMessage", "description": "获取房间历史消息(房间历史消息保存7天)", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "3986281" }, { "name": "RoomId", "type": "integer", "required": true, "description": "课堂Id。", "example": "9028" }, { "name": "Seq", "type": "integer", "required": false, "description": "消息序列。获取该序列以前的消息(不包含该seq消息)", "example": "890989" }, { "name": "Limit", "type": "integer", "required": false, "description": "消息拉取的条数。最大数量不能超过套餐包限制。", "example": "10" }, { "name": "UserId", "type": "string", "required": false, "description": "请求消息的userId", "example": "xxxxxxx" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "GetRooms", "description": "获取房间列表", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台的SdkAppId。", "example": "2343313242" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间。默认以当前时间减去半小时作为开始时间。", "example": "1708921829" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间。默认以当前时间加上半小时作为结束时间。", "example": "1708936229" }, { "name": "Page", "type": "integer", "required": false, "description": "分页查询当前页数，从1开始递增", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "默认10条，最大上限为100条", "example": "10" }, { "name": "Status", "type": "array", "required": false, "description": "课堂状态。默认展示所有课堂，0为未开始，1为正在上课，2为已结束，3为已过期", "example": "0", "item_type": "integer" } ], "required": [ "SdkAppId" ] }, { "name": "GetWatermark", "description": "获取水印设置", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "98789" } ], "required": [ "SdkAppId" ] }, { "name": "KickUserFromRoom", "description": "从房间里面踢出用户", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "课堂Id。", "example": "30123456" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台的SdkAppId。", "example": "3692919" }, { "name": "UserId", "type": "string", "required": true, "description": "需要踢出成员Id", "example": "dfgsadffg" }, { "name": "KickType", "type": "integer", "required": true, "description": "踢出类型： 1：临时踢出，可以使用Duration参数指定污点时间，污点时间间隔内用户无法进入房间。 2：永久踢出", "example": "1" }, { "name": "Duration", "type": "integer", "required": true, "description": "污点时间(单位秒)，KickType = 1时生效，默认为0", "example": "10" } ], "required": [ "RoomId", "SdkAppId", "UserId", "KickType", "Duration" ] }, { "name": "LoginOriginId", "description": "使用源账号登录，源账号为注册时填入的originId", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "1234657" }, { "name": "OriginId", "type": "string", "required": true, "description": "用户在客户系统的Id，需要在同一应用下唯一。", "example": "userid" } ], "required": [ "SdkAppId", "OriginId" ] }, { "name": "LoginOriginIdWithRoom", "description": "使用源账号登录课堂，源账号为注册时填入的originId", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "3096436" }, { "name": "OriginId", "type": "string", "required": true, "description": "用户在客户系统的Id，需要在同一应用下唯一。", "example": "o*****Id_******086" }, { "name": "RoomId", "type": "integer", "required": true, "description": "课堂 ID", "example": "10086" } ], "required": [ "SdkAppId", "OriginId", "RoomId" ] }, { "name": "LoginUser", "description": "登录", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "注册获取的用户id。", "example": "2i5WfUzRRC2Eb2uNLNv96gzxCv" } ], "required": [ "UserId" ] }, { "name": "LoginUserWithRoom", "description": "登录课堂", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "注册获取的用户id。", "example": "39V**W****m3BNzU**h**b*q**Z" }, { "name": "RoomId", "type": "integer", "required": true, "description": "课堂 ID", "example": "10086" } ], "required": [ "UserId", "RoomId" ] }, { "name": "ModifyApp", "description": "修改应用", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "3865311" }, { "name": "Callback", "type": "string", "required": false, "description": "回调地址。", "example": "https://www.baidu.com" }, { "name": "CallbackKey", "type": "string", "required": false, "description": "回调key。", "example": "mKpLAZLN" }, { "name": "TransferId", "type": "string", "required": false, "description": "转存id", "example": "121212" }, { "name": "TransferUrl", "type": "string", "required": false, "description": "转存地址", "example": "https://www.baidu.com" } ], "required": [ "SdkAppId" ] }, { "name": "ModifyGroup", "description": "此接口修改群组信息", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "需要修改的群组ID", "example": "asfeasewfawe" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台应用ID", "example": "134652876" }, { "name": "TeacherId", "type": "string", "required": false, "description": "默认绑定主讲老师ID", "example": "adfgdsfgdf" }, { "name": "GroupName", "type": "string", "required": false, "description": "待修改的群组名称", "example": "group1" } ], "required": [ "GroupId", "SdkAppId" ] }, { "name": "ModifyRoom", "description": "修改房间", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID。", "example": "312345678" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId", "example": "123467" }, { "name": "StartTime", "type": "integer", "required": false, "description": "预定的房间开始时间，unix时间戳（秒）。直播开始后不允许修改。", "example": "1659600138" }, { "name": "EndTime", "type": "integer", "required": false, "description": "预定的房间结束时间，unix时间戳（秒）。直播开始后不允许修改。", "example": "1659600138" }, { "name": "TeacherId", "type": "string", "required": false, "description": "老师ID。直播开始后不允许修改。", "example": "1jmPi2qddazF5PTgJtGYss9bg4T" }, { "name": "Name", "type": "string", "required": false, "description": "房间名称。字符数不超过256", "example": "房间名称" }, { "name": "Resolution", "type": "integer", "required": false, "description": "分辨率。可以有如下取值：1 标清2 高清3 全高清直播开始后不允许修改。", "example": "1" }, { "name": "MaxMicNumber", "type": "integer", "required": false, "description": "设置房间/课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。", "example": "1" }, { "name": "AutoMic", "type": "integer", "required": false, "description": "进入房间时是否自动连麦。可以有以下取值：0 不自动连麦（默认值）1 自动连麦直播开始后不允许修改。", "example": "1" }, { "name": "AudioQuality", "type": "integer", "required": false, "description": "高音质模式。可以有以下取值：0 不开启高音质（默认值）1 开启高音质直播开始后不允许修改。", "example": "1" }, { "name": "SubType", "type": "string", "required": false, "description": "房间子类型，可以有以下取值：videodoc 文档+视频video 纯视频直播开始后不允许修改。", "example": "video" }, { "name": "DisableRecord", "type": "integer", "required": false, "description": "禁止录制。可以有以下取值：0 不禁止录制（默认值）1 禁止录制直播开始后不允许修改。", "example": "1" }, { "name": "Assistants", "type": "array", "required": false, "description": "助教Id列表。直播开始后不允许修改。", "example": "[\"azsdasfsdfsd\",\"asefawefewf\"]", "item_type": "string" }, { "name": "GroupId", "type": "string", "required": false, "description": "房间绑定的群组ID。直播开始后不允许修改。", "example": "7230232" }, { "name": "EnableDirectControl", "type": "integer", "required": false, "description": "打开学生麦克风/摄像头的授权开关。直播开始后不允许修改。", "example": "0" }, { "name": "InteractionMode", "type": "integer", "required": false, "description": "开启专注模式。0 收看全部角色音视频(默认)1 只看老师和助教", "example": "0" }, { "name": "VideoOrientation", "type": "integer", "required": false, "description": "横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型", "example": "0" }, { "name": "IsGradingRequiredPostClass", "type": "integer", "required": false, "description": "开启课后评分。 0：不开启(默认) 1：开启", "example": "0" }, { "name": "RoomType", "type": "integer", "required": false, "description": "房间类型: 0 小班课（默认值）; 1 大班课; 2 1V1 （预留参数、暂未开放)注：大班课的布局(layout)只有三分屏", "example": "0" }, { "name": "RecordLayout", "type": "integer", "required": false, "description": "录制模板。仅可修改还未开始的房间。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744", "example": "0" }, { "name": "EndDelayTime", "type": "integer", "required": false, "description": "拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟", "example": "0" }, { "name": "LiveType", "type": "integer", "required": false, "description": "直播方式：0 常规模式（默认）1 回放直播模式（伪直播）。 目前支持从回放直播模式（伪直播）改为常规模式，不支持从常规模式改为回放直播模式（伪直播）", "example": "0" }, { "name": "RecordLiveUrl", "type": "string", "required": false, "description": "伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。", "example": "https://791263.vod-qcloud.com/425sfabhs7814/e9049470840ghjk739827/1INCKHSY9QMA.mp4" }, { "name": "EnableAutoStart", "type": "integer", "required": false, "description": "是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1的时候有效", "example": "0" }, { "name": "RecordScene", "type": "string", "required": false, "description": "录制自定义场景，仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。", "example": "{\"scene\":\"test\",\"lng\":\"zh\",\"type\":\"h5\",\"subjectId\":\"57\",\"customToken\":\"sajdlfjasdglweqirouoiu\"}" }, { "name": "WhiteBoardSnapshotMode", "type": "integer", "required": false, "description": "板书截图生成类型。0 不生成板书；1 全量模式；2 单页去重模式", "example": "0" }, { "name": "SubtitlesTranscription", "type": "integer", "required": false, "description": "字幕转写功能开关。可以有以下取值：0 不开启字幕转写功能（默认值）1 自动转写模式：上课自动开启，下课自动停止2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关", "example": "0" }, { "name": "Guests", "type": "array", "required": false, "description": "嘉宾Id列表。当圆桌会议模式（RoomType==3）时生效", "example": "[\"azsdasfsdfsd\",\"asefawefewf\"]", "item_type": "string" }, { "name": "RecordMerge", "type": "integer", "required": false, "description": "录制文件合并开关。0 关闭 1 开启 注：只有在一节课多次启用手动录制时，此功能才有效", "example": "0" } ], "required": [ "RoomId", "SdkAppId" ] }, { "name": "ModifyUserProfile", "description": "此接口用于修改用户信息，例如头像、昵称（用户名）等。注意，课中的用户信息不会立即同步修改，需待下次上课时，修改后的信息才会更新显示。", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "待修改用户ID", "example": "2kJJBH6G1dfBFUJqXLh0Mg3ELLk" }, { "name": "Nickname", "type": "string", "required": false, "description": "待修改的用户名。对应注册用户下“Name“字段，本次修改是对此内容进行修改。", "example": "zhanwsan" }, { "name": "Avatar", "type": "string", "required": false, "description": "待修改头像url", "example": "https://www.baidu.com/avatar.png" } ], "required": [ "UserId" ] }, { "name": "RegisterUser", "description": "注册用户", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "3475672" }, { "name": "Name", "type": "string", "required": false, "description": "对应用户昵称。对应修改用户信息下“nickname“字段，在修改用户信息时，可以对该字段进行调整，从而更改用户的昵称。", "example": "nickname" }, { "name": "OriginId", "type": "string", "required": false, "description": "用户在客户系统的Id，需要在同一应用下唯一。入参为空时默认赋值为UserId。", "example": "id12345" }, { "name": "Avatar", "type": "string", "required": false, "description": "用户头像。", "example": "Avatar" } ], "required": [ "SdkAppId" ] }, { "name": "SendRoomNormalMessage", "description": "1、按照指定身份发送消息，目前支持表情消息、图片消息、文本消息。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "3534223" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID。", "example": "1212457" }, { "name": "FromAccount", "type": "string", "required": true, "description": "管理员指定消息发送方账号（若需设置 FromAccount 信息，则该参数取值不能为空）", "example": "2WqeRoOMJKQqnnL1lILRFHpdFla" }, { "name": "MsgBody", "type": "array", "required": true, "description": "自定义消息", "example": "无", "item_type": "object", "children": [ { "name": "MsgType", "type": "string", "required": true, "description": "TIM 消息对象类型，目前支持的消息对象包括： TIMTextElem（文本消息） TIMFaceElem（表情消息） TIMImageElem（图像消息） TIMCustomElem（自定义消息）", "example": "TIMImageElem" }, { "name": "TextMsgContent", "type": "object", "required": false, "description": "文本消息，当MsgType 为TIMTextElem（文本消息）必选。", "example": "无", "children": [ { "name": "Text", "type": "string", "required": true, "description": "文本消息。", "example": "\"你好\"" } ] }, { "name": "FaceMsgContent", "type": "object", "required": false, "description": "表情消息，当MsgType 为TIMFaceElem（表情消息）必选。", "example": "无", "children": [ { "name": "Index", "type": "integer", "required": true, "description": "表情索引，用户自定义。", "example": "1" }, { "name": "Data", "type": "string", "required": false, "description": "额外数据。", "example": "\"face\"" } ] }, { "name": "ImageMsgContent", "type": "object", "required": false, "description": "图像消息，当MsgType为TIMImageElem（图像消息）必选。", "example": "无", "children": [ { "name": "UUID", "type": "string", "required": true, "description": "图片的唯一标识，客户端用于索引图片的键值。", "example": "1853095_D61040894AC3DE44CDFFFB3EC7EB720F" }, { "name": "ImageFormat", "type": "integer", "required": true, "description": "图片格式。 JPG = 1 GIF = 2 PNG = 3 BMP = 4 其他 = 255", "example": "3" }, { "name": "ImageInfoList", "type": "array", "required": true, "description": "图片信息", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "图片类型： 1-原图 2-大图 3-缩略图", "example": "2" }, { "name": "Size", "type": "integer", "required": true, "description": "图片数据大小，单位：字节。", "example": "1024" }, { "name": "Width", "type": "integer", "required": true, "description": "图片宽度，单位为像素。", "example": "2448" }, { "name": "Height", "type": "integer", "required": true, "description": "图片高度，单位为像素。", "example": "3264" }, { "name": "URL", "type": "string", "required": true, "description": "图片下载地址。", "example": "http://xxx/3200490432214177468_144115198371610486_D61040894AC3DE44CDFFFB3EC7EB720F/198" } ] } ] }, { "name": "CustomMsgContent", "type": "object", "required": false, "description": "自定义消息，TIMCustomElem（自定义消息）必选。", "example": "无", "children": [ { "name": "Data", "type": "string", "required": false, "description": "自定义消息数据。", "example": "你好" }, { "name": "Desc", "type": "string", "required": false, "description": "自定义消息描述信息。", "example": "自定义消息描述" }, { "name": "Ext", "type": "string", "required": false, "description": "扩展字段。", "example": "CHAT" } ] } ] }, { "name": "CloudCustomData", "type": "string", "required": false, "description": "消息自定义数据（云端保存，会发送到对端，程序卸载重装后还能拉取到）。", "example": "your cloud custom data" }, { "name": "NickName", "type": "string", "required": false, "description": "昵称，当FromAccount没有在房间中，需要填写NickName，当FromAccount在房间中，填写NickName无意义", "example": "菲菲" }, { "name": "Priority", "type": "string", "required": false, "description": "消息的优先级，默认优先级 Normal。 可以指定3种优先级，从高到低依次为 High、Normal 和 Low，区分大小写。", "example": "Normal" } ], "required": [ "SdkAppId", "RoomId", "FromAccount", "MsgBody" ] }, { "name": "SendRoomNotificationMessage", "description": "App 管理员可以通过该接口在群组中发送通知、公告等。目前仅支持文本消息。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "112367" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID。", "example": "12567" }, { "name": "MsgContent", "type": "string", "required": true, "description": "消息。", "example": "\"大家好\"" } ], "required": [ "SdkAppId", "RoomId", "MsgContent" ] }, { "name": "SetAppCustomContent", "description": "设置应用的自定义内容，包括应用图标，自定义的代码等。如果已存在，则为更新。更新js、css内容后，要生效也需要调用该接口", "status": "online", "parameters": [ { "name": "CustomContent", "type": "array", "required": true, "description": "自定义内容。", "example": "无", "item_type": "object", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "场景参数，一个应用下可以设置多个不同场景。", "example": "Test" }, { "name": "LogoUrl", "type": "string", "required": false, "description": "logo地址，用于上课时展示的课堂或平台图标，支持开发商自定义业务品牌展示。", "example": "https://tcic-dev-siwygftrdtfghj5678853/36e7627678jh-8916-ac33b240cfb3" }, { "name": "HomeUrl", "type": "string", "required": false, "description": "HomeUrl：主页地址，用于上课结束后课堂跳转，支持跳转到自己的业务系统。如果配置为空则下课后关闭课堂页面。", "example": "www.baidu.com" }, { "name": "JsUrl", "type": "string", "required": false, "description": "JsUrl ：自定义js。针对应用用于开发上自定义课堂界面、模块功能、监控操作，支持数据请求与响应处理。", "example": "https://lifeid0ecsfsdec0341127.umd.min.js" }, { "name": "CssUrl", "type": "string", "required": false, "description": "Css : 自定义的css。针对应用用于支持课堂界面的、模块的UI渲染修改、皮肤配色修改、功能模块的隐藏和展示。", "example": "https://lifeisfddskjdhg1cbeec0341127.css" } ] }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用ID。", "example": "1234657" } ], "required": [ "CustomContent", "SdkAppId" ] }, { "name": "SetMarquee", "description": "设置跑马灯参数设置", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "学校ID", "example": "3290189" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间号", "example": "1123" }, { "name": "MarqueeType", "type": "integer", "required": true, "description": "跑马灯类型：1为固定值，2为用户昵称，3为固定值+用户昵称，4为用户ID，5为originId+固定值，6为用户昵称（originId）", "example": "1" }, { "name": "DisplayMode", "type": "integer", "required": true, "description": "显示方式：1为滚动，2为闪烁", "example": "1" }, { "name": "Content", "type": "string", "required": false, "description": "固定值内容（当MarqueeType=1或5，则展示固定值内容）", "example": "直播课堂" }, { "name": "FontSize", "type": "integer", "required": false, "description": "字体大小（数字，像素单位，范围：10到24）。", "example": "10" }, { "name": "FontWeight", "type": "integer", "required": false, "description": "字体粗细：1为粗体，0为细体", "example": "1" }, { "name": "FontColor", "type": "string", "required": false, "description": "字体颜色（十六进制颜色值，例如：#00FF00（绿色））", "example": "#00FF00" }, { "name": "FontOpacity", "type": "float", "required": false, "description": "字体透明度（数字，范围 0.0 到 1.0）", "example": "0.3" }, { "name": "BackgroundColor", "type": "string", "required": false, "description": "背景颜色（十六进制颜色值，例如：#FFFF00（黄色））", "example": "#FFFF00" }, { "name": "BackgroundOpacity", "type": "float", "required": false, "description": "背景透明度（数字，范围 0.0 到 1.0）", "example": "0.1" }, { "name": "Duration", "type": "integer", "required": false, "description": "跑马灯文字移动/闪烁指定像素所需时间，范围：1-10；数值越小，跑马灯滚动/闪烁速度越快", "example": "1" }, { "name": "MarqueeCount", "type": "integer", "required": false, "description": "跑马灯个数：目前仅支持1或2, 对应显示单排或双排", "example": "1" } ], "required": [ "SdkAppId", "RoomId", "MarqueeType", "DisplayMode" ] }, { "name": "SetWatermark", "description": "设置水印", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码互动课堂的SdkAppId。", "example": "12333" }, { "name": "TeacherUrl", "type": "string", "required": false, "description": "老师视频区域的水印参数地址，设置为空字符串表示删除", "example": "https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/teacher-02_219090_210001.png" }, { "name": "BoardUrl", "type": "string", "required": false, "description": "白板视频区域的水印参数地址，设置为空字符串表示删除", "example": "https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/board-02_219090_210001.png" }, { "name": "VideoUrl", "type": "string", "required": false, "description": "视频默认图片（在没有视频流的时候显示），设置为空字符串表示删除", "example": "https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/video-02_219090_210001.png" }, { "name": "BoardW", "type": "float", "required": false, "description": "白板区域水印的宽度，取值:0-100，默认为0，表示区域X方向的百分比", "example": "0" }, { "name": "BoardH", "type": "float", "required": false, "description": "白板区域水印的高度，取值:0-100，默认为0, 表示区域Y方向的百分比", "example": "0" }, { "name": "BoardX", "type": "float", "required": false, "description": "白板区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间", "example": "50" }, { "name": "BoardY", "type": "float", "required": false, "description": "白板区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间", "example": "50" }, { "name": "TeacherW", "type": "float", "required": false, "description": "老师视频区域水印的宽度，取值:0-100，默认为0，表示区域X方向的百分比", "example": "0" }, { "name": "TeacherH", "type": "float", "required": false, "description": "老师视频区域水印的高度，取值:0-100，默认为0, 表示区域Y方向的百分比", "example": "0" }, { "name": "TeacherX", "type": "float", "required": false, "description": "老师视频区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间", "example": "50" }, { "name": "TeacherY", "type": "float", "required": false, "description": "老师视频区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间", "example": "50" }, { "name": "Text", "type": "string", "required": false, "description": "文字水印内容，设置为空字符串表示删除", "example": "文本内容" }, { "name": "TextColor", "type": "string", "required": false, "description": "文字水印颜色", "example": "黑" } ], "required": [ "SdkAppId" ] }, { "name": "StartRecord", "description": "开始录制", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "学校ID", "example": "3452141" }, { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID", "example": "23121" } ], "required": [ "SdkAppId", "RoomId" ] }, { "name": "StartRoom", "description": "开始房间的直播。 说明：开始房间接口调用之前需要有用户进入课堂初始化课堂信息。", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "课堂ID", "example": "3123456789" } ], "required": [ "RoomId" ] }, { "name": "StopRecord", "description": "停止录制", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "学校ID", "example": "134112232" }, { "name": "RoomId", "type": "integer", "required": true, "description": "课堂ID", "example": "31211232" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务ID", "example": "ds12322123" } ], "required": [ "SdkAppId", "RoomId", "TaskId" ] }, { "name": "UnbindDocumentFromRoom", "description": "文档从房间解绑", "status": "online", "parameters": [ { "name": "RoomId", "type": "integer", "required": true, "description": "房间ID。", "example": "3478192" }, { "name": "DocumentId", "type": "string", "required": true, "description": "文档ID。", "example": "sjdsoowihe" } ], "required": [ "RoomId", "DocumentId" ] }, { "name": "UnblockKickedUser", "description": "解禁从房间里面踢出的用户", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "低代码平台的SdkAppId。", "example": "3986898" }, { "name": "RoomId", "type": "integer", "required": true, "description": "课堂Id。", "example": "30123456" }, { "name": "UserId", "type": "string", "required": true, "description": "需要解禁踢出的成员Id。", "example": "dfgsadffg" } ], "required": [ "SdkAppId", "RoomId", "UserId" ] } ] }