跳到主要内容

查询转换任务状态

1. 接口描述​

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

通过发起转换任务接口（ChannelCreateConvertTaskApi）返回的任务Id查询转换任务状态，通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelGetTaskResultApi。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，本接口不需要传递此参数。
Agent是Agent应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
TaskId是String任务Id，通过ChannelCreateConvertTaskApi接口获得
Operator否UserInfo操作者的信息，不用传
Organization否OrganizationInfo暂未开放

3. 输出参数​

参数名称类型描述
TaskIdString任务Id
TaskStatusInteger任务状态，需要关注的状态
0 :NeedTranform - 任务已提交
4 :Processing - 文档转换中
8 :TaskEnd - 任务处理完成
-2 :DownloadFailed - 下载失败
-6 :ProcessFailed - 转换失败
-13:ProcessTimeout - 转换文件超时
TaskMessageString状态描述，需要关注的状态
NeedTranform - 任务已提交
Processing - 文档转换中
TaskEnd - 任务处理完成
DownloadFailed - 下载失败
ProcessFailed - 转换失败
ProcessTimeout - 转换文件超时
ResourceIdString资源Id，也是FileId，用于文件发起使用
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 查询转换任务​

查询文件转换任务

输入示例​

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

{
    "Agent": {
        "ProxyAppId": "d2b****b66f954d7cc",
        "ProxyOrganizationOpenId": "yDxAyUyK****cb7u0jQn0Zh7f7",
        "ProxyOperator": {
            "OpenId": "732aaef****541b89c49e0cc"
        },
        "AppId": "ed68bc6***********0214e4e"
    },
    "TaskId": "2022*********589282"
}

输出示例​

{
    "Response": {
        "RequestId": "3f08b529-f13e-4129-85a4-9585fd794656",
        "ResourceId": "yDRt2*********EytoAXw44x",
        "TaskId": "2022*********4589282",
        "TaskMessage": "任务处理完成",
        "TaskStatus": 8,
        "PreviewUrl": ""
    }
}

5. 开发者资源​

腾讯云 API 平台​

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

API Inspector​

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

SDK​

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

命令行工具​

6. 错误码​

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

错误码描述
InvalidParameter.ParamError参数错误。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。