跳到主要内容

文件上传

1. 接口描述​

接口请求域名： file.ess.tencent.cn 。

此接口（UploadFiles）文件上传。

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

注:

  1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
  2. 此接口调用时需要单独设置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. 输出参数​

参数名称类型描述
TotalCountInteger上传成功文件数量
注: 如果一个文件上传失败, 则全部文件皆上传失败
示例值：20
FileIdsArray of String文件资源ID数组，每个文件资源ID为32位字符串。
建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
注:有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用
FileUrlsArray of String对应上传文件的下载链接，过期时间5分钟
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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. 错误码​

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

错误码描述
AuthFailureCAM签名/鉴权错误。
FailedOperation操作失败。
InternalError.Serialize序列化错误。
InvalidParameter参数错误。
OperationDenied操作被拒绝。
ResourceNotFound资源不存在。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。