腾讯电子签集成版文件上传-API 文档-文档中心-腾讯云

1. 接口描述

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

此接口（UploadFiles）文件上传。

适用场景：用于合同，印章的文件上传。文件上传以后，
如果是PDF格式文件可配合用PDF文件创建签署流程接口进行合同流程的发起
如果是其他类型可以配合创建文件转换任务接口转换成PDF文件

注:

图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
此接口调用时需要单独设置Domain请求域名 , 联调开发环境为 file.test.ess.tencent.cn，正式环境需要设置为file.ess.tencent.cn，代码示例
```
HttpProfile httpProfile = new HttpProfile();
httpProfile.setEndpoint("file.test.ess.tencent.cn");
```

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：UploadFiles。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实名认证
BusinessType	是	String	文件对应业务类型,可以选择的类型如下 TEMPLATE : 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过创建文件转换任务转换后才能使用 DOCUMENT : 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html，如果非pdf文件需要通过创建文件转换任务转换后才能使用示例值：TEMPLATE
FileInfos.N	否	Array of UploadFile	上传文件内容数组，最多支持上传20个文件。示例值：FileInfos

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	上传成功文件数量注: `如果一个文件上传失败, 则全部文件皆上传失败` 示例值：20
FileIds	Array of String	文件资源ID数组，每个文件资源ID为32位字符串。建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用`
FileUrls	Array of String	对应上传文件的下载链接，过期时间5分钟
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 文件上传接口

上传两个文件

输入示例

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "BusinessType": "DOCUMENT",
    "FileInfos": [
        {
            "FileBody": "JVBERi0xLjcNCiW1tbW1DQoxIDAgeXBlL(文件内容省略)",
            "FileName": "2023张三入职合同"
        },
        {
            "FileBody": "1DQoxIDAgb2JqDQo8PC9UeXBlvUGFnZ(文件内容省略)",
            "FileName": "2023张三保密协议"
        }
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 2,
        "FileIds": [
            "yDwivUUckpo2v2bhUx8pIP8vBdA0hGSe",
            "yDwivUUckpo2v2b8Ux8pIP8CvvGGWvIs"
        ],
        "FileUrls": [
            "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.PDF?hkey=d13d83**c14",
            "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.PDF?hkey=d13dee**ad"
        ],
        "RequestId": "0ab69fd3-db36-4a26-998f-6521c538b36a"
    }
}

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

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError.Serialize	序列化错误。
InvalidParameter	参数错误。
InvalidParameter.SensitiveFileContent	上传的文件包含敏感（不合规）的内容，请确认。
OperationDenied	操作被拒绝。
ResourceNotFound	资源不存在。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

文件上传

本页目录：