信封签署 (eSign)场景说明

场景说明

信封签署 (eSign) 提供完整的电子签署 API，支持从文件上传到签署完成的全流程自动化。

什么是信封？

在 Tencent eSign 中，信封（Envelope） 是签署流程的核心载体，一个信封包含：

  • 文档（Documents） — 需要签署的文件（PDF、Word 等）
  • 接收人（Recipients） — 签署人（Signer）或抄送人（Carbon Copy）
  • 签署控件（Tabs） — 签名位、日期、文本框等控件，指定在文档中的位置
  • 签署设置 — 并行/顺序签署、是否允许拒签等

信封生命周期

draft → sending → sent → completed
                        ↘ declined
                        ↘ voided
              ↘ sent_failed
状态说明
draft草稿，尚未发送
sending发送中（仅大文档信封可能出现），正在异步解析文档中的关键字位置
sent已发送，签署流程进行中
sent_failed发送失败（仅大文档信封可能出现），关键字解析失败或超时，可使用相同 OutEnvelopeId 重新发送
completed所有签署人均已签署
declined任一签署人拒签
voided发件人主动作废，或信封过期后系统自动作废
ℹ️

通过 Open API 创建的信封会立即发送。如果信封包含 >60MB 的文档，发送后先进入 sending 状态（异步关键字解析），解析成功后才变为 sent；解析失败则进入 sent_failed。小文档信封发送后直接进入 sent 状态。

接口列表

POST
上传文件
/openapi/v1/files/upload
上传文档文件，获取 FileId
POST
创建文件转换任务
/openapi/v1/files/convert-tasks
将非 PDF 文件异步转为 PDF，得到 TaskId
POST
批量查询文件转换任务
/openapi/v1/files/convert-tasks/query
轮询转换任务状态，取得 ConvertedFileId
POST
创建并发送信封
/openapi/v1/envelopes/quick-create
一次调用完成信封创建与发送
POST
查询信封详情
/openapi/v1/envelopes/detail
查询信封状态及签署进度
POST
获取签署/查看链接
/openapi/v1/envelopes/signing-view
生成一次性签署或查看链接
完成文件分片上传快速开始