互动白板通过文档URL查询转码任务状态-服务端 API-文档中心-腾讯云

1. 接口描述

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

通过文档URL查询转码任务，返回最近一次的转码任务状态

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTranscodeByUrl。
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

3. 输出参数

参数名称	类型	描述
Progress	Integer	转码的当前进度,取值范围为0~100 示例值：100
Status	String	任务的当前状态 - QUEUED: 正在排队等待转换 - PROCESSING: 转换中 - FINISHED: 转换完成 - EXCEPTION: 转换异常示例值：FINISHED
TaskId	String	转码任务的唯一标识Id 示例值：0agdnligqtgtvkm65emb
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 通过url查询文档动态转码任务状态

通过url查询文档动态转码任务状态

输入示例

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

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

输出示例

{
    "Response": {
        "Progress": 100,
        "RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "Status": "FINISHED",
        "TaskId": "0agdnligqtgtvkm65emb"
    }
}

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

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation.TranscodeServerError	转码服务出现内部错误，请稍后重试或联系客户人员。
InvalidParameter.BodyParameterTypeUnmatched	参数类型不匹配。
InvalidParameter.TaskNotFound	需要查询的任务不存在。
ResourceUnavailable.NotRegistered	未开通互动白板。
ResourceUnavailable.ServiceExpired	账户欠费或者互动白板服务已过期。
UnauthorizedOperation.SdkAppId	SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。

通过文档URL查询转码任务状态

本页目录：