绑定课件到房间

最近更新时间:2025-03-20 11:50:13

我的收藏

1. 接口描述

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

功能概述
本接口提供教学场景下的课程文档预绑定能力,支持将课件课堂ID进行关联映射,实现课件的自动化预加载。

应用场景建议

绑定时机
推荐在创建课堂预约阶段同步完成文档绑定操作,确保课件资源在课堂开始前完成上传。

接口限制与频控策略

频控维度
开发者账号维度限频
默认频控阈值为20 QPS(每秒请求次数)

最佳实践建议

重试策略
当触发限频错误时,建议采用以下策略:
启用退避重试机制(建议使用指数退避算法)
初始重试间隔不低于500ms
最大重试次数不超过3次

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:BindDocumentToRoom。
Version String 公共参数,本接口取值:2022-08-17。
Region String 公共参数,此参数为可选参数。
RoomId Integer 房间ID。
示例值:876789
DocumentId String 文档ID。
示例值:ax1esdi2
BindType Integer 绑定类型。后台可透传到客户端,默认为0。除以下例值外支持自定义该字段,并在前端实现相应业务逻辑,示例参考:
示例值:0,仅绑定课件到房间
示例值:1,绑定课件到房间后,默认展示课件
示例值:0

3. 输出参数

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

4. 示例

示例1 绑定文档到房间

输入示例

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

{
    "DocumentId": "dmop89Kq",
    "RoomId": 123
}

输出示例

复制
复制成功
{
    "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。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.SdkAppId SdkAppId参数错误。
ResourceNotFound.Document 文档不存在。
ResourceNotFound.Room 房间不存在。

如果遇到产品相关问题,您可咨询 在线客服 寻求帮助。

返回顶部
可通过正文划词反馈文档内容问题,我们会快速处理并更新文档内容。