跳到主要内容

新建文件转换任务

1. 接口描述​

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

创建文件转换任务

1.1 接口说明​

本接口用于创建文件转换任务，将以下类型的源文件转换为 PDF 文件：

doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt

文件转换为异步耗时操作。任务创建成功后，可调用查询文件转换任务状态接口查询转换进度及结果。

1.2 前提条件​

调用本接口前，请先通过文件上传接口上传源文件，并获取文件对应的资源 ID（ResourceId）。

1.3 适用场景​

  • Word 转 PDF：已上传 Word 文件，需要先将其转换为 PDF，再用于发起合同。
  • 图片转 PDF：已上传 JPG、PNG 等图片文件，需要先将其转换为 PDF，再用于发起合同。
  • 其他文件转 PDF：将 Excel、HTML 或 TXT 文件转换为 PDF，以便预览或用于合同签署流程。

1.4 使用流程​

  1. 调用文件上传接口上传源文件，获取资源 ID。
  2. 调用 CreateFileConvertTask，使用资源 ID 创建转换任务。
  3. 保存接口返回的转换任务 ID。
  4. 调用 DescribeFileConvertTask 查询任务状态。
  5. 转换成功后，获取转换生成的 PDF 文件资源 ID。
  6. 使用转换后的 PDF 文件发起合同。

文件转换整体流程

1.5 注意事项​

  1. 支持转换的文件格式为：doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt。
  2. 文件转换需要一定时间，请勿在创建任务后立即使用转换结果，应通过任务状态查询接口确认转换成功。
  3. 建议在发起合同时开启文件预览，检查转换后的 PDF 是否符合预期，尤其需要关注页面排版、分页、字体及图片清晰度。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateFileConvertTask。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，本接口不需要传递此参数。
Agent是Agent

关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
ResourceType是String

需要进行转换的资源文件类型
支持的文件类型如下：

枚举值：

  • doc： doc
  • docx： docx
  • xls： xls
  • xlsx： xlsx
  • jpg： jpg
  • jpeg： jpeg
  • png： png
  • bmp： bmp
  • html： html
  • txt： txt

示例值：docx
ResourceName是String

需要进行转换操作的文件资源名称，带资源后缀名。

注: 资源名称长度限制为256个字符


示例值：转换
ResourceId是String

需要进行转换操作的文件资源Id，通过UploadFiles接口获取文件资源Id。

注: 目前，此接口仅支持单个文件进行转换。


示例值：yD3JjUUckpe***BvOXIhzJjy

3. 输出参数​

参数名称类型描述
TaskIdString

接口返回的文件转换任务Id，可以调用接口查询转换任务状态获取转换任务的状态和转换后的文件资源Id。


示例值：2026070***875611
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 创建转换任务示例​

创建转换任务示例

输入示例​

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

{
    "Agent": {
        "AppId": "yDwf2UUckps***********0CI2wZ3T8l",
        "ProxyOrganizationOpenId": "eddison******org_id",
        "ProxyOperator": {
            "OpenId": "eddi****hen"
        }
    },
    "ResourceType": "docx",
    "ResourceName": "转换",
    "ResourceId": "yD3JjUUckpe***********BvOXIhzJjy"
}

输出示例​

{
    "Response": {
        "TaskId": "2026070*******875611",
        "RequestId": "b38f53e0-4893-4ff1-b6c7-57275af8af5f"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError.DependsApi依赖的其他api出错。
InvalidParameter.InvalidIdId不存在或者符合规范。
InvalidParameter.ParamError参数错误。
InvalidParameter.ResourceType资源类型错误。
MissingParameter.ResourceName资源名称错误。
OperationDenied操作被拒绝。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈