创建文件转换任务

1. 接口描述

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

此接口（CreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。

前提条件：源文件已经通过 文件上传接口完成上传，并得到了源文件的资源Id。

适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同
适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同

转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过查询转换任务状态接口获取任务状态。

注:

1. 支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt
2. 可通过发起合同时设置预览来检查转换文件是否达到预期效果

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 jpg文件转换示例

适用场景：将jpg文件转换为pdf

输入示例

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

{
    "ResourceType": "jpg",
    "ResourceName": "合同图片.jpg",
    "Operator": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "ResourceId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
}

输出示例

{
    "Response": {
        "RequestId": "d245a68d-e13b-xxxx-xxxx-e5adc794db24",
        "TaskId": "202xxxx3011294"
    }
}

示例2 word文件转换示例

适用场景：将docx文件转换为pdf

输入示例

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

{
    "ResourceType": "docx",
    "ResourceName": "员工劳动合同.docx",
    "Operator": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "ResourceId": "yDRSRUUgygj6qnyvUuO4zjE1vLuGdWjL"
}

输出示例

{
    "Response": {
        "RequestId": "d245a68d-e13b-xxxx-xxxx-e5adc794db24",
        "TaskId": "20220xxxx549202141"
    }
}

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

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