信封签署 (eSign)接口列表获取合同下载信息

获取合同下载信息

POST/openapi/v1/envelopes/download-url

获取合同下载信息。

只有状态为 completed 的合同才支持下载

报告以 PDF 格式生成


请求参数

Authorization必填string
Bearer <access_token>
X-Operator-User-Id选填string
操作用户 ID。授权码模式下无需传(自动使用授权用户);客户端凭据模式下可选,不填时使用系统用户 ID。
application/json
EnvelopeId必填string
合同 ID(必填)

响应参数

EnvelopeId选填string
合同 ID
Status选填string
合同状态
Files选填array<object>
文件信息数组
子属性
FileType选填string
文件类型(CONTRACT / ATTACHMENT)
CONTRACTATTACHMENT
FileName选填string
文件名
DownloadUrl选填string
下载链接

错误码

错误码说明
OPENAPI.OPERATOR_USER_NOT_FOUND操作员不是当前空间的成员
INVALID_REQUEST参数无效(如 EnvelopeId 为空)
NOT_FOUND合同不存在
FORBIDDEN操作员没有访问该合同的权限
ENVELOPE.DOWNLOAD_NOT_ALLOWED信封当前状态不允许下载(如草稿状态)
ENVELOPE.DOWNLOAD_SIGNED_PDF_GENERATING信封已完成,已签章 PDF 仍在异步生成中,请稍后重试
INTERNAL_ERROR内部服务错误