催办信封
POST/openapi/v1/envelopes/remind
向尚未完成签署的签署人发送催办通知邮件。
入参筛选规则：
- 同时传
RecipientIds与RecipientEmails时，以RecipientIds为准，RecipientEmails被忽略； - 仅传
RecipientEmails时，服务端会根据信封详情将邮箱解析为对应签署人 ID；匹配不到的邮箱（含匹配到抄送人）会作为分项失败返回。
签署顺序语义：
- 有序签署（sequential / mixed）：
RecipientIds与RecipientEmails均为空时，对当前第一顺位的全体签署人催办；命中非第一顺位的接收人会作为分项失败返回。 - 无序签署（parallel）：
RecipientIds与RecipientEmails至少填一个，否则接口直接返回错误。
其他约束：
- 抄送人（carbonCopy）不可被催办，即使传入其 ID 或 Email 也会作为分项失败返回；
- 单个签署人的成功催办次数达到上限后，后续催办会作为分项失败返回；
- 接口整体成功时（
Response.Error为空），分项结果通过Response.Data.RecipientResults返回，含成功与失败明细。
请求参数
Header 参数
Authorization必填string
Bearer <access_token>
X-Operator-User-Id选填string
操作用户 ID。授权码模式下无需传（自动使用授权用户）；客户端凭据模式下可选，不填时使用系统用户 ID。
Body 请求体
application/jsonEnvelopeId必填string
信封 ID（必填）
RecipientIds选填array<string>
指定催办的签署人 ID 列表（可选）。
- 无序签署（parallel）：`RecipientIds` 与 `RecipientEmails` 至少填一个，仅对命中的签署人发送通知；
- 有序签署（sequential / mixed）：可为空。均为空时对「当前第一顺位」全体签署人催办；非空时仅命中「当前第一顺位」的接收人会被催办，其余作为分项失败返回。
抄送人（carbonCopy）不可被催办，即使传入其 ID 也会作为分项失败返回。
RecipientEmails选填array<string>
指定催办的签署人邮箱列表（可选，与 `RecipientIds` 互补）。
合并规则：同时传 `RecipientIds` 与 `RecipientEmails` 时，以 `RecipientIds` 为准，`RecipientEmails` 被忽略；仅当 `RecipientIds` 为空且 `RecipientEmails` 非空时，才会用邮箱解析出对应的签署人。
邮箱与信封内某签署人匹配不上时，该邮箱作为分项失败返回（`FailureReason=recipient_not_found`）。抄送人的邮箱同样会被解析后作为分项失败返回。
请求示例
{
"EnvelopeId": "SGEV1234567890",
"RecipientIds": [
"SGRC0000000001"
]
}响应参数
Response.Data
EnvelopeId选填string
信封 ID
RecipientResults选填array<object>
每个目标签署人的催办结果（分项结果，包含成功与失败明细）
RecipientId选填string
签署人 ID
Name选填string
签署人姓名
Email选填string
签署人邮箱（脱敏，如 z***@example.com）
Status选填string
签署人当前状态
createdsentdeliveredviewedsigneddeclinedvoided
Success选填boolean
是否成功发送催办通知
FailureReason选填string
失败原因（`Success=false` 时有值）。常见值：
- `not_first_batch`：非当前第一顺位；
- `recipient_not_found`：签署人不存在（含邮箱未匹配到）；
- `already_signed`：已完成签署；
- `remind_limit_exceeded`：催办次数达上限；
- `not_signer_type`：非签署人（如抄送人）。
EmailsSent选填integer(int32)
成功发送的通知邮件数
NotificationsFailed选填integer(int32)
未成功发送的通知数（含无效 ID / 非第一顺位 / 已达催办上限 / 邮件失败等）
响应示例
{
"Response": {
"RequestId": "req-abc123",
"Error": null,
"Data": {
"EnvelopeId": "SGEV1234567890",
"RecipientResults": [
{
"RecipientId": "SGRC0000000001",
"Name": "张三",
"Email": "z***@example.com",
"Status": "sent",
"Success": true
}
],
"EmailsSent": 1,
"NotificationsFailed": 0
}
}
}错误码
| 错误码 | 说明 |
|---|---|
INVALID_REQUEST | 请求参数错误（EnvelopeId 为空 / 无序签署未传目标等） |
OPENAPI.OPERATOR_USER_NOT_FOUND | 操作用户不是该空间的成员 |
NOT_FOUND | 信封不存在 |
FORBIDDEN | 操作用户既不是信封创建者，也不是空间管理员 |
INTERNAL_ERROR | 服务内部错误 |