互动白板创建白板板书生成任务-服务端 API-文档中心-腾讯云

1. 接口描述

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

创建白板板书生成任务, 在任务结束后，如果提供了回调地址，将通过回调地址通知板书生成结果

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateSnapshotTask。
Version	是	String	公共参数，本接口取值：2019-09-19。
Region	是	String	公共参数，详见产品支持的地域列表。
Whiteboard	是	SnapshotWhiteboard	白板相关参数
SdkAppId	是	Integer	白板房间 `SdkAppId` 示例值：1400124720
RoomId	是	Integer	白板房间号示例值：1234
CallbackURL	否	String	白板板书生成结果通知回调地址示例值：http://xxx
COS	否	SnapshotCOS	白板板书文件 `COS` 存储参数，不填默认存储在公共存储桶，公共存储桶的数据仅保存3天
SnapshotMode	否	String	白板板书生成模式，默认为 `AllMarks`。取值说明如下： `AllMarks` - 全量模式，即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。 `LatestMarksOnly` - 单页去重模式，即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。（注意：`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效，否则即使在调用本API是指定了 `LatestMarksOnly` 模式，服务后台会使用默认的 `AllMarks` 模式生成白板板书）示例值：AllMarks

3. 输出参数

参数名称	类型	描述
TaskID	String	白板板书生成任务ID，只有任务创建成功的时候才会返回此字段示例值：d1806f20-25b8-4c30-8176-c0832bf84e02
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建白板板书生成任务

输入示例

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

{
    "COS": {
        "TargetDir": "snapshot/",
        "Region": "ap-guangzhou",
        "Bucket": "test-123070000",
        "Domain": "xxx.file.com",
        "Uin": 130001358
    },
    "Whiteboard": {
        "Width": 1280,
        "InitParams": "{\"ratio\":\"16:9\"}",
        "Height": 720
    },
    "RoomId": 12345,
    "SdkAppId": 1400123480,
    "CallbackURL": "http://xx/callback"
}

输出示例

{
    "Response": {
        "TaskID": "d1806f20-25b8-4c30-8176-c0832bf84e02",
        "RequestId": "fe36df20-25b8-4c30-8176-cff28afacb25"
    }
}

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. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
RequestLimitExceeded	请求的次数超过了频率限制。
ResourceUnavailable	资源不可用。
ResourceUnavailable.NotRegistered	未开通互动白板。
ResourceUnavailable.ServiceExpired	账户欠费或者互动白板服务已过期。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.SdkAppId	SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。

创建白板板书生成任务

本页目录：