催签流程中签署人

更新时间:2024-07-02 15:15:34

接口描述

向当前轮到签署但还未签署的签署人发送催签提醒, 支持指定签署人发送催签提醒。 提醒内容如下:

【注意事项】

  • 发起签署之后的前半小时不可进行催签;
  • 与上一次催签,请至少间隔十分钟再发起下一次催签提醒。

接口地址&请求方法

接口地址:https://{host}/v3/sign-flow/{signFlowId}/urge

请求方法:POST

请求头格式

具体请求头参数,请查看公共请求头格式

请求参数

展开全部参数参数名称

参数类型

必选

参数位置

参数说明

signFlowId

string

path

签署流程ID

noticeTypes

string

body

通知方式(多种方式使用英文逗号分隔)

1- 短信,2 - 邮件 ,默认按照流程设置

(如果套餐内带“分项”字样,请确保开通【电子签名流量费(分项)认证】中的子项:【短信服务】,否则短信通知收不到)

urgedOperator(点击“+”展开详情)

object

body

指定被催签的签署人

  • 为空表示:催签当前轮到签署但还未签署的所有签署人
  • 按被催签人的账号标识或账号ID方式(二选一,根据发起签署时传入方式决定)

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
}

错误码

点击查看错误码

我要纠错