腾讯电子签集成版查询转换任务状态-API 文档-文档中心-腾讯云

1. 接口描述

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

此接口（ChannelGetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用创建文件转换任务接口进行资源文件的转换操作

前提条件：已调用创建文件转换任务接口进行文件转换，并得到了返回的转换任务Id。

适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。

注：

大文件转换所需的时间可能会比较长

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelGetTaskResultApi。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实名认证
TaskId	是	String	转换任务Id，通过接口创建文件转换任务接口得到的转换任务id

3. 输出参数

参数名称	类型	描述
TaskId	String	任务Id
TaskStatus	Integer	任务状态，需要关注的状态 0 :NeedTranform - 任务已提交 4 :Processing - 文档转换中 8 :TaskEnd - 任务处理完成 -2 :DownloadFailed - 下载失败 -6 :ProcessFailed - 转换失败 -13:ProcessTimeout - 转换文件超时
TaskMessage	String	状态描述，需要关注的状态 NeedTranform : 任务已提交 Processing : 文档转换中 TaskEnd : 任务处理完成 DownloadFailed : 下载失败 ProcessFailed : 转换失败 ProcessTimeout : 转换文件超时
ResourceId	String	资源Id（即FileId），用于用PDF文件创建签署流程
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询转换任务

查询文件转换任务

输入示例

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "TaskId": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68"
}

输出示例

{
    "Response": {
        "RequestId": "s1698837600515440954",
        "ResourceId": "yDSLOUUckpoji469U5GRz2w1NRiV2lPp",
        "TaskId": "20231101191954296703",
        "TaskMessage": "任务处理完成",
        "TaskStatus": 8
    }
}

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

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

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

查询转换任务状态

本页目录：