跳到主要内容

创建文件转换任务

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateConvertTaskApi。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
ResourceTypeString需要进行转换的资源文件类型
支持的文件类型如下:
  • doc
  • docx
  • xls
  • xlsx
  • jpg
  • jpeg
  • png
  • html
  • bmp
  • txt

示例值:docx
ResourceNameString需要进行转换操作的文件资源名称,带资源后缀名。

注: 资源名称长度限制为256个字符
示例值:员工劳动合同.docx
ResourceIdString需要进行转换操作的文件资源Id,通过UploadFiles接口获取文件资源Id。

注: 目前,此接口仅支持单个文件进行转换。
示例值:yDRSRUUgygj6qnyvUuO4zjE1vLuGdWjL
OperatorUserInfo执行本接口操作的员工信息。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
AgentAgent代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

3. 输出参数

参数名称类型描述
TaskIdString接口返回的文件转换任务Id,可以调用接口查询转换任务状态获取转换任务的状态和转换后的文件资源Id。
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

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

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

错误码描述
InternalError.DependsApi依赖的第三方API返回错误。
InvalidParameter.InvalidIdid类型参数不合法,请检查后重试。
InvalidParameter.ParamError参数错误。
InvalidParameter.ResourceType不合法的资源类型,请联系客服了解,并在修改后重试。
MissingParameter.ResourceName缺少资源名称,请检查修改后重试。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoIdentityVerify未通过个人实名认证。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062