1. 接口描述
接口请求域名: tiw.tencentcloudapi.com 。
查询文档转码任务的执行进度与转码结果
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTranscode。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SdkAppId | 是 | Integer | 客户的SdkAppId 示例值:1400000001 |
TaskId | 是 | String | 文档转码任务的唯一标识Id 示例值:g0jb42ps49vtebjshilb |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Pages | Integer | 文档的总页数 示例值:1 |
Progress | Integer | 转码的当前进度,取值范围为0~100 示例值:100 |
Resolution | String | 文档的分辨率 示例值:793x1122 |
ResultUrl | String | 转码完成后结果的URL 动态转码:PPT转动态H5的链接 静态转码:文档每一页的图片URL前缀,比如,该URL前缀为 http://example.com/g0jb42ps49vtebjshilb/ ,那么文档第1页的图片URL为http://example.com/g0jb42ps49vtebjshilb/1.jpg ,其它页以此类推示例值:https://transcode-result/0agdnligqtgtvkm65emb/index.html |
Status | String | 任务的当前状态 - QUEUED: 正在排队等待转换 - PROCESSING: 转换中 - FINISHED: 转换完成 示例值:FINISHED |
TaskId | String | 转码任务的唯一标识Id 示例值:0agdnligqtgtvkm65emb |
Title | String | 文档的文件名 示例值:59378.docx |
ThumbnailUrl | String | 缩略图URL前缀,比如,该URL前缀为http://example.com/g0jb42ps49vtebjshilb/ ,那么动态PPT第1页的缩略图URL为http://example.com/g0jb42ps49vtebjshilb/1.jpg ,其它页以此类推如果发起文档转码请求参数中带了ThumbnailResolution参数,并且转码类型为动态转码,该参数不为空,其余情况该参数为空字符串 示例值:https://transcode-thumbnal/0agdnligqtgtvkm65emb/ |
ThumbnailResolution | String | 动态转码缩略图生成分辨率 示例值:793x1122 |
CompressFileUrl | String | 转码压缩文件下载的URL,如果发起文档转码请求参数中CompressFileType 为空或者不是支持的压缩格式,该参数为空字符串 |
ResourceListUrl | String | 资源清单文件下载URL(内测体验) 注意:此字段可能返回 null,表示取不到有效值。 |
Ext | String | 文档制作方式(内测体验) 注意:此字段可能返回 null,表示取不到有效值。 示例值:office |
CreateTime | Integer | 文档转码任务创建时间,单位s 注意:此字段可能返回 null,表示取不到有效值。 示例值:1688974545 |
AssignTime | Integer | 文档转码任务分配时间,单位s 注意:此字段可能返回 null,表示取不到有效值。 示例值:1688974545 |
FinishedTime | Integer | 文档转码任务完成时间,单位s 注意:此字段可能返回 null,表示取不到有效值。 示例值:1688974545 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询文档动态转码任务
查询文档动态转码任务结果
输入示例
POST / HTTP/1.1
Host: tiw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTranscode
<公共请求参数>
{
"TaskId": "g0jb42ps49vtebjshilb",
"SdkAppId": "1400000001"
}
输出示例
{
"Response": {
"Pages": 1,
"Progress": 100,
"RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"Resolution": "793x1122",
"ResultUrl": "https://transcode-result/0agdnligqtgtvkm65emb/index.html",
"Status": "FINISHED",
"TaskId": "0agdnligqtgtvkm65emb",
"Title": "59378.docx",
"ThumbnailUrl": "https://transcode-thumbnal/0agdnligqtgtvkm65emb/",
"ThumbnailResolution": "793x1122",
"CompressFileUrl": "",
"ResourceListUrl": "https://transcode-result/0agdnligqtgtvkm65emb/resources.txt",
"Ext": "Office"
}
}
示例2 查询文档静态转码任务
查询文档静态转码任务结果
输入示例
POST / HTTP/1.1
Host: tiw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTranscode
<公共请求参数>
{
"TaskId": "g0jb42ps49vtebjshilb",
"SdkAppId": "1400000001"
}
输出示例
{
"Response": {
"Pages": 1,
"Progress": 100,
"RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"Resolution": "793x1122",
"ResultUrl": "https://transcode-result/0agdnligqtgtvkm65emb/",
"Status": "FINISHED",
"TaskId": "0agdnligqtgtvkm65emb",
"Title": "59378.docx",
"ThumbnailUrl": "",
"ThumbnailResolution": "",
"CompressFileUrl": "",
"ResourceListUrl": "https://transcode-result/0agdnligqtgtvkm65emb/resources.txt",
"Ext": "Office"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation.FileDownloadFail | 文档下载失败,请检查请求参数中URL是否正确,或者如果您使用其他的文件存储服务,请检查文件存储服务的上传带宽,文档转码服务仅提供1分钟的下载时间,如果下载不成功本次的转码请求将以失败终止。 |
FailedOperation.FileFormatError | 文档格式错误,不支持转换只读文档或者已加密的文档。 |
FailedOperation.FileOpenFail | 文档打开失败,请检查提交转码的文档是否加密或有其他格式问题。 |
FailedOperation.FileUploadFail | 转码后上传结果失败,请稍后重试。 |
FailedOperation.Transcode | 转码失败,具体请参考错误描述或联系客服人员。 |
FailedOperation.TranscodeServerError | 转码服务出现内部错误,请稍后重试或联系客户人员。 |
InvalidParameter.BodyParameterTypeUnmatched | 参数类型不匹配。 |
InvalidParameter.FileFormatUnsupported | 文档后缀名对应的格式不支持。 |
InvalidParameter.TaskNotFound | 需要查询的任务不存在。 |
InvalidParameter.TranscodeParameter | 文档转码参数格式不正确。 |
InvalidParameter.UrlFormatError | 文档下载Url格式错误,请检查请求参数里的Url。 |
LimitExceeded.TranscodePagesLimitation | 超过文档最大页数限制,目前不支持超过500页的文件转码,如有特殊需求,请联系客服人员。 |
ResourceUnavailable.NotRegistered | 未开通互动白板。 |
ResourceUnavailable.ServiceExpired | 账户欠费或者互动白板服务已过期。 |
UnauthorizedOperation.SdkAppId | SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。 |