创建文档转码任务

最近更新时间:2019-12-05 17:14:38

1. 接口描述

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

创建一个文档转码任务

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateTranscode
Version String 公共参数,本接口取值:2019-09-19
Region String 公共参数,详见产品支持的 地域列表
SdkAppId Integer 客户的SdkAppId
Url String 需要进行转码文件地址
IsStaticPPT Boolean 是否为静态PPT,默认为False;
如果IsStaticPPT为False,后缀名为.ppt或.pptx的文档会动态转码成HTML5页面,其他格式的文档会静态转码成图片;如果IsStaticPPT为True,所有格式的文档会静态转码成图片;
MinResolution String 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率

注意分辨率宽高中间为英文字母"xyz"的"x"
ThumbnailResolution String 动态PPT转码可以为文件生成该分辨率的缩略图,不传、传空字符串或分辨率格式错误则不生成缩略图,分辨率格式同MinResolution

静态转码这个参数不起作用
CompressFileType String 转码文件压缩格式,不传、传空字符串或不是指定的格式则不生成压缩文件,目前支持如下压缩格式:

zip: 生成.zip压缩包
tar.gz: 生成.tar.gz压缩包

3. 输出参数

参数名称 类型 描述
TaskId String 文档转码任务的唯一标识Id,用于查询该任务的进度以及转码结果
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

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

输入示例

https://tiw.tencentcloudapi.com/?Action=CreateTranscode
&SdkAppId=1400000001
&Url=https://path/to/document.ppt
&ThumbnailResolution=960x540
&<公共请求参数>

输出示例

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

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

创建PPT静态转码任务

输入示例

https://tiw.tencentcloudapi.com/?Action=CreateTranscode
&SdkAppId=1400000001
&Url=https://path/to/document.ppt
&IsStaticPPT=True
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.Transcode 转码失败,具体请参考错误描述或联系客服人员
InvalidParameter.BodyParameterTypeUnmatched 参数类型不匹配
InvalidParameter.FileFormatUnsupported 文档后缀名对应的格式不支持
InvalidParameter.TranscodeParameter 文档转码参数格式不正确
ResourceUnavailable.NotRegistered 未开通互动白板
ResourceUnavailable.ServiceExpired 账户欠费或者互动白板服务已过期
UnauthorizedOperation.SdkAppId SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应