获取签署报告下载链接
POST/openapi/v1/envelopes/report-url
获取合同签署报告的下载链接。
只有状态为 completed 的合同才支持下载报告
报告以 PDF 格式生成,支持多种语言。
请求参数
Header 参数
Authorization必填string
Bearer <access_token>
X-Operator-User-Id必填string
操作用户 ID(必填,用于权限校验)
language选填string
报告语言(可选,默认:en。支持:zh / zh-Hant / en)
Body 请求体
application/jsonEnvelopeId必填string
合同 ID(必填)
响应参数
Response.Data
EnvelopeId选填string
合同 ID
Status选填string
合同状态
ReportFile选填object
报告文件信息(当合同状态非 completed 时为 null)
FileName选填string
文件名
DownloadUrl选填string
下载链接
错误码
| 错误码 | 说明 |
|---|---|
OPENAPI.OPERATOR_USER_ID_REQUIRED | 缺少 X-Operator-User-Id 请求头 |
OPENAPI.OPERATOR_USER_NOT_FOUND | 操作员不是当前空间的成员 |
INVALID_REQUEST | 参数无效(如 EnvelopeId 为空) |
NOT_FOUND | 合同不存在 |
FORBIDDEN | 操作员没有访问该合同的权限 |
INTERNAL_ERROR | 内部服务错误(生成报告失败) |