获取板书截图

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

我的收藏

1. 接口描述

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

查询白板板书截图

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeWhiteBoardSnapshot。
Version String 公共参数,本接口取值:2022-08-17。
Region String 公共参数,此参数为可选参数。
RoomId Integer 房间ID
示例值:301234567

3. 输出参数

参数名称 类型 描述
WhiteBoardSnapshotMode Integer 板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式
示例值:1
Status Integer 板书任务状态,0:未开始,1:进行中,2:失败,3:成功,4:已删除
示例值:2
Result Array of String 板书截图链接
Total Integer 总数
示例值:3
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询白板板书截图

输入示例

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

{
    "RoomId": 345740000
}

输出示例

复制
复制成功
{
    "Response": {
        "RequestId": "2fbab292-694c-437c-9182-5f9af464ebb0",
        "Result": [
            "https://example.cos.ap-shanghai.myqcloud.com/snapshot1.png",
            "https://example.cos.ap-shanghai.myqcloud.com/snapshot2.png",
            "https://example.cos.ap-shanghai.myqcloud.com/snapshot3.png",
            "https://example.cos.ap-shanghai.myqcloud.com/snapshot4.png",
            "https://example.cos.ap-shanghai.myqcloud.com/snapshot5.png"
        ],
        "Status": 3,
        "Total": 5,
        "WhiteBoardSnapshotMode": 1
    }
}

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 内部错误。

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

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