发送催签通知提醒

更新时间:2024-03-22 11:57:20

接口描述

向当前轮到签署但还未签署的签署人发送催签提醒, 支持指定签署人发送催签提醒。 被催签人账号/账号ID是非必填的,该参数为空时,系统将向所有待签的签署人发送签署通知,提醒内容:

【注意】发起催签的半小时后每十分钟可催办一次

接口地址&请求方式

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

请求方式:POST

请求头格式

具体请求头格式结构,请点击查看公共参数说明

请求参数

参数名称

类型

必选

参数类型

参数说明

signFlowId

string

path

签署流程ID

对应发起签署流程时返回的flowId

noticeTypes

string

body

通知方式,逗号分割,

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

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

按被催签人的账号或账号ID方式(两者选其一,根据发起签署时传入方式决定)

urgedSignerAccount

string

body

被催签人账号(手机号/邮箱),

若传空:催签当前轮到签署但还未签署的所有签署人

urgedSignerId

string

body

被催签人账号ID,

若传空:催签当前轮到签署但还未签署的所有签署人

按催签人的账号或账号ID方式(两者选其一,根据发起签署时传入方式决定)

urgerAccount

string

body

催签人账号(手机号/邮箱),

若传空:默认为平台方催签(应用APPID归属企业)。

若发起签署时传了发起方为个人,此字段可传入发起方的手机号/邮箱。

urgerId

string

body

催签人账号ID,

若传空:默认为平台方催签(应用APPID归属企业)。

若发起签署时传了发起方账号,此字段需传入发起方账号id。

响应参数

参数名称

类型

必选

参数说明

code

int

业务码,0表示成功

message

string

业务信息

data

object

业务数据

请求示例  

POST https://openapi.esign.cn/v3/sign-flow/b2cb74258a634179b0df3cc54xxx/signers/urge
{
	"noticeTypes": "1,2",
	"urgedSignerAccount": "183xxxx0010"
}

响应示例

{
    "code":0,
    "message":"成功",
    "data":null
}

错误码

错误码

错误描述

排查方法

1437126

流程未发起或已完结, 不能执行催签操作

只有签署中的流程才能催签

1437127

当前用户非流程发起人, 不能执行催签操作

目前支持发起人催签, 非发起人不能执行催签操作


我要纠错