互动白板
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>互动白板>服务端 API>文档转码相关接口>创建文档转码任务

创建文档转码任务

最近更新时间：2024-03-12 01:56:25

我的收藏

本页目录：

1. 接口描述

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

创建一个文档转码任务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateTranscode。
Version 是 String 公共参数，本接口取值：2019-09-19。
Region 是 String 公共参数，详见产品支持的 地域列表。
SdkAppId 是 Integer 客户的SdkAppId
示例值：1400000001
Url 是 String 经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式，比如文档地址为http://example.com/测试.pdf，经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率，请对URL进行编码。
示例值：https://path/to/document.ppt
IsStaticPPT 否 Boolean 是否为静态PPT，默认为False；
如果IsStaticPPT为False，后缀名为.ppt或.pptx的文档会动态转码成HTML5页面，其他格式的文档会静态转码成图片；如果IsStaticPPT为True，所有格式的文档会静态转码成图片；
示例值：False
MinResolution 否 String 注意: 该参数已废弃, 请使用最新的 云API SDK ，使用 MinScaleResolution字段传递分辨率

转码后文档的最小分辨率，不传、传空字符串或分辨率格式错误则使用文档原分辨率

示例：1280x720，注意分辨率宽高中间为英文字母"xyz"的"x"
示例值：960x540
ThumbnailResolution 否 String 动态PPT转码可以为文件生成该分辨率的缩略图，不传、传空字符串或分辨率格式错误则不生成缩略图，分辨率格式同MinResolution
示例值：960x540
CompressFileType 否 String 转码文件压缩格式，不传、传空字符串或不是指定的格式则不生成压缩文件，目前支持如下压缩格式：

zip： 生成.zip压缩包
tar.gz： 生成.tar.gz压缩包
示例值：zip
ExtraData 否 String 内部参数
示例值：空
Priority 否 String 文档转码优先级， 只有对于PPT动态转码生效，支持填入以下值：

- low: 低优先级转码，对于动态转码，能支持500MB（下载超时时间10分钟）以及2000页文档，但资源有限可能会有比较长时间的排队，请酌情使用该功能。

- 不填表示正常优先级转码，支持200MB文件（下载超时时间2分钟），500页以内的文档进行转码


注意：对于PDF等静态文件转码，无论是正常优先级或者低优先级，最大只能支持200MB
示例值：空
MinScaleResolution 否 String 转码后文档的最小分辨率，不传、传空字符串或分辨率格式错误则使用文档原分辨率。
分辨率越高，效果越清晰，转出来的图片资源体积会越大，课件加载耗时会变长，请根据实际使用场景配置此参数。

示例：1280x720，注意分辨率宽高中间为英文字母"xyz"的"x"
示例值：960x540
AutoHandleUnsupportedElement 否 Boolean 此参数仅对动态转码生效。

是否对不支持元素开启自动处理的功能，默认不开启。
true -- 开启
false -- 不开启

当设置为true时，可配合AutoHandleUnsupportedElementTypes参数使用，具体有哪些不兼容元素类型，可参考AutoHandleUnsupportedElementTypes参数的说明。
示例值：true
AutoHandleUnsupportedElementTypes.N 否 Array of Integer 此参数仅在AutoHandleUnsupportedElement参数为true的情况下有效。

指定需要自动处理的不兼容元素类型，默认对所有不兼容的元素进行自动处理。

目前支持检测的不兼容元素类型及对应的自动处理方式如下：
0: 不支持的墨迹类型
-- 自动处理方式：移除墨迹

1: 自动翻页
-- 自动处理方式：移除自动翻页设置，并修改为单击切换

2: 已损坏音视频
-- 自动处理方式：移除对损坏音视频的引用

3: 不可访问资源
-- 自动处理方式：移除对不可访问的资源的引用

4: 只读文件
-- 自动处理方式：移除只读设置

5: 不支持的元素编辑锁定状态
-- 自动处理方式：移除锁定状态

6: 可能有兼容问题的字体
-- 自动处理方式： 不支持处理

7: 设置了柔化边缘的GIF图片
-- 自动处理方式：移除柔化边缘设置

8: 存在不兼容的空格下划线
-- 自动处理方式：通过调整空格下划线前后文本的字体语言体系，保证空格下划线表现正常

9: 存在设置了分段动画的数学公式和文本混合内容
-- 自动处理方式： 不支持处理

10: 存在设置了分段动画的渐变色文本
-- 自动处理方式： 不支持处理

11: 存在不兼容的分散对齐方式
-- 自动处理方式： 不支持处理

12: 存在不兼容的多倍行距设置
-- 自动处理方式： 不支持处理
示例值：[0, 1, 2]
ExcelParam 否 ExcelParam Excel表格转码参数，可设置转码时表格纸张大小及纸张方向等参数（仅对转码文件为Excel表格文件的静态转码任务生效）

3. 输出参数

参数名称 类型 描述
TaskId String 文档转码任务的唯一标识Id，用于查询该任务的进度以及转码结果
示例值：g6ls63ps49vteb8bk1mb
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建PPT动态转码任务

创建PPT动态转码任务，并生成分辨率为960x540的缩略图

输入示例

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

{
    "Url": "https://path/to/document.ppt",
    "ThumbnailResolution": "960x540",
    "SdkAppId": "1400000001"
}

输出示例

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "TaskId": "g6ls63ps49vteb8bk1mb"
    }
}

示例2 创建PPT静态转码任务

创建PPT静态转码任务

输入示例

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

{
    "Url": "https://path/to/document.ppt",
    "IsStaticPPT": "True",
    "SdkAppId": "1400000001"
}

输出示例

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "TaskId": "g6ls63ps49vteb8bk1mb"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation.Transcode 转码失败，具体请参考错误描述或联系客服人员。
InvalidParameter.BodyParameterTypeUnmatched 参数类型不匹配。
InvalidParameter.FileFormatUnsupported 文档后缀名对应的格式不支持。
InvalidParameter.PreprocessParameter 转码预处理参数格式不正确。
InvalidParameter.SdkAppIdNotFound SdkAppId不存在或格式错误。
InvalidParameter.TranscodeParameter 文档转码参数格式不正确。
LimitExceeded.TaskConcurrency 转码或录制任务并发数量超过限制，请参考错误描述或稍后重试。
ResourceUnavailable.NotRegistered 未开通互动白板。
ResourceUnavailable.ServiceExpired 账户欠费或者互动白板服务已过期。
UnauthorizedOperation.SdkAppId SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。
中国站
文档反馈
文档活动
message-icon联系我们
目录