新建文件转换任务

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次/秒。

2. 输入参数

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

3. 输出参数

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. 开发者资源

腾讯云 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: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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