跳到主要内容

文件上传

1. 接口描述​

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

此接口（UploadFiles）用于文件上传。 其中上传的文件，图片类型(png/jpg/jpeg)大小限制为5M，其他大小限制为60M。 调用时需要设置Domain, 正式环境为 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.AppId 和 Agent.ProxyOrganizationOpenId 必填
BusinessType是String文件对应业务类型
1. TEMPLATE - 模板； 文件类型：.pdf/.doc/.docx/.html
2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型：.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
示例值：TEMPLATE
FileInfos.N否Array of UploadFile上传文件内容数组，最多支持20个文件
示例值：FileInfos

3. 输出参数​

参数名称类型描述
TotalCountInteger上传成功文件数量
示例值：20
FileIdsArray of String文件id数组，有效期一个小时；有效期内此文件id可以反复使用
FileUrlsArray of String文件Url
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 多文件上传接口​

多文件上传

输入示例​

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

{
    "Agent": {
        "AppId": "abc",
        "ProxyOrganizationOpenId": "abc"
    },
    "BusinessType": "TEMPLATE",
    "FileInfos": [
        {
            "FileBody": "iVBORw0KGgoAAAANSUhxxxxAElEQVR4Xu3dbah1W5eQ7HmoAAAAASUVORK5CYII=",
            "FileName": "a.pdf"
        }
    ]
}

输出示例​

{
    "Response": {
        "FileIds": [
            "d54e****************A2b7562"
        ],
        "FileUrls": [
            "https://a.b.com/d5****************2b7562"
        ],
        "TotalCount": 1,
        "RequestId": "4fecd****************bdbb7e5"
    }
}

5. 错误码​

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

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