获取签署链接
POST/openapi/v1/envelopes/signing-view
为信封的签署人生成一次性签署链接。
- 链接默认有效期 30 分钟，过期须重新调用本接口获取
- 同一签署人多次调用会使旧链接失效，请勿缓存链接
- 抄送人（CarbonCopies）不返回签署链接
筛选规则
- 同时传
RecipientId与RecipientEmail时，以RecipientId为准，RecipientEmail被忽略 - 只传其中一项，按该字段筛选返回单个签署人的链接
- 两者都不传，返回该信封下所有签署人的链接列表
请求参数
Header 参数
Authorization必填string
Bearer <access_token>
X-Operator-User-Id选填string
操作用户 ID（可选，不填时使用系统用户 ID）
Body 请求体
application/jsonEnvelopeId必填string
信封 ID（必填）
RecipientId选填string
签署人 ID（可选，用于筛选单个签署人）
RecipientEmail选填string(email)
签署人邮箱（可选，用于筛选单个签署人）。若同时传 RecipientId 与 RecipientEmail，以 RecipientId 为准，Email 被忽略
请求示例
{
"EnvelopeId": "SGEV1234567890",
"RecipientId": "r1"
}响应参数
Response.Data
EnvelopeId选填string
信封 ID
EnvelopeStatus选填string
信封当前状态。draft=草稿；sent=签署中；completed=已完成；voided=已作废；declined=已拒签
draftsentcompletedvoideddeclined
SignerInfos选填array<object>
签署人签署链接列表
RecipientId选填string
系统分配的接收人 ID
Name选填string
姓名（必填）
Email选填string
邮箱（脱敏展示，如 z***@example.com）
SigningOrder选填integer
签署顺序（SigningOrderType=parallel 时统一为 0）
SigningUrl选填string
签署链接
ExpiresAt选填string(date-time)
链接过期时间，RFC3339 格式，示例：2024-01-15T11:00:00Z
响应示例
{
"Response": {
"RequestId": "req-abc123",
"Error": null,
"Data": {
"EnvelopeId": "SGEV1234567890",
"EnvelopeStatus": "sent",
"SignerInfos": [
{
"RecipientId": "r1",
"Name": "Alice",
"Email": "a***@example.com",
"SigningOrder": 1,
"SigningUrl": "https://sign.example.com/signing/eyJhbGciOi...",
"ExpiresAt": "2024-01-15T11:00:00Z"
}
]
}
}
}错误码
| 错误码 | 说明 |
|---|---|
INVALID_REQUEST | 请求参数错误（EnvelopeId 为空等） |
NOT_FOUND | 信封不存在 |
RECIPIENT.NOT_RECIPIENT | 指定的 RecipientId / Email 不是该信封的签署人 |
ENVELOPE.INVALID_STATUS | 信封状态不允许签署（已完成、已作废、草稿等） |
SIGNING.RECIPIENT_ALREADY_SIGNED | 该签署人已完成签署 |
SIGNING.RECIPIENT_DECLINED | 该签署人已拒签 |
INTERNAL_ERROR | 服务内部错误 |