接口描述
向当前轮到签署但还未签署的签署人发送催签提醒, 支持指定签署人发送催签提醒。 提醒内容如下:
【注意事项】
- 发起签署之后的前半小时不可进行催签;
- 与上一次催签,请至少间隔十分钟再发起下一次催签提醒。
接口地址&请求方法
接口地址:https://{host}/v3/sign-flow/{signFlowId}/urge
请求方法:POST
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 | |
signFlowId | string | 是 | path | 签署流程ID | |
noticeTypes | string | 否 | body | 通知方式(多种方式使用英文逗号分隔) 1- 短信,2 - 邮件 ,默认按照流程设置 (如果套餐内带“分项”字样,请确保开通【电子签名流量费(分项)认证】中的子项:【短信服务】,否则短信通知收不到) | |
urgedOperator(点击“+”展开详情) | object | 否 | body | 指定被催签的签署人
| |
psnAccount | string | 否 | body | 被催签人账号标识(手机号/邮箱) (与psnId二选一传入,根据发起签署时传入方式决定) | |
psnId | string | 否 | body | 被催签人账号ID (与psnAccount二选一传入,根据发起签署时传入方式决定) |
响应参数
参数名称 | 参数类型 | 必选 | 参数说明 | ||||
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。 | ||||
data | object | 否 | 业务数据 |
请求示例
POST https://openapi.esign.cn/v3/sign-flow/b2cb7**3cc54/urge
{
"noticeTypes": "1",
"urgedOperator": {
"psnAccount": "183****0101"
}
}
响应示例
{
"code": 0,
"message": "成功",
"data": null
}