信封签署 (eSign)接口列表上传文件

上传文件

POST/openapi/v1/files/upload

上传文档文件,获取 FileId 供创建信封时引用。

  • 单次最多上传 20 个文件,结果顺序与请求一致
  • FileId 有效期 24 小时,过期须重新上传
  • 支持格式:pdf / doc / docx / jpg / jpeg / png
  • 大小限制:图片 ≤ 10 MB;PDF / Word ≤ 60 MB

请求参数

Authorization必填string
Bearer <access_token>
X-Operator-User-Id选填string
操作用户 ID(可选,不填时使用系统用户 ID)
application/json
Files必填array<object>
文件列表,至少 1 个,最多 20 个
子属性
FileName必填string
文件名,须包含扩展名,例如 contract.pdf
FileBody必填string
文件内容,Base64 编码。支持格式:pdf / doc / docx / jpg / jpeg / png。大小限制:图片 ≤ 10 MB;PDF / Word ≤ 60 MB

请求示例

{
  "Files": [
    {
      "FileName": "contract.pdf",
      "FileBody": "JVBERi0xLjQK..."
    },
    {
      "FileName": "appendix.pdf",
      "FileBody": "JVBERi0xLjUK..."
    }
  ]
}

响应参数

Files选填array<object>
上传结果列表,顺序与请求中 Files 一致
子属性
FileName选填string
对应请求中的文件名
FileId选填string
文件资源 ID,有效期 24 小时,用于 CreateEnvelope 请求中引用

响应示例

{
  "Response": {
    "RequestId": "req-abc123",
    "Error": null,
    "Data": {
      "Files": [
        {
          "FileName": "contract.pdf",
          "FileId": "SGf1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6"
        },
        {
          "FileName": "appendix.pdf",
          "FileId": "SGf7g8h9i0j1k2l3m4n5o6p7q8r9s0t1u2"
        }
      ]
    }
  }
}

错误码

错误码说明
OPENAPI.UPLOAD_FILES_REQUIREDFiles 列表为空
OPENAPI.UPLOAD_FILES_COUNT_EXCEEDSFiles 数量超过上限 20
OPENAPI.UPLOAD_FILE_NAME_REQUIRED某个文件的 FileName 为空
OPENAPI.UPLOAD_FILE_BODY_REQUIRED某个文件的 FileBody 为空
OPENAPI.UPLOAD_FILE_EXT_UNSUPPORTED不支持的文件扩展名(仅支持 pdf/doc/docx/jpg/jpeg/png)
OPENAPI.UPLOAD_FILE_BASE64_INVALIDFileBody 不是合法的 Base64 编码
FILE.TOO_LARGE文件超过大小限制(图片 ≤ 10MB,PDF/Word ≤ 60MB)
INTERNAL_ERROR服务内部错误(文件存储失败等)