流程签署人催签

更新时间:2024-03-22 11:58:03

接口描述

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

接口

/v1/signflows/{flowId}/signers/rushsign

请求方式

PUT

请求头

提供两种安全接入方式,开发者可选择其中一种方式进行对接,对应参数如何获取,参考文档【请点击】。

方式一:请求签名鉴权

请求头入参示例如下:

参数名称

类型

必选

参数说明

示例值

X-Tsign-Open-App-Id

string

项目ID


Content-Type

string

application/json;charset=UTF-8


X-Tsign-Open-Ca-Timestamp

string

API 调用者传递时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为15分钟,为了防重放攻击


Accept

string

建议统一填写 */*


X-Tsign-Open-Ca-Signature

string

签名字符串


Content-MD5

string

当请求 Body 非 Form 表单时,可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时,加上此请求头。


X-Tsign-Open-Auth-Mode

string

选择请求方式进行鉴权,固定值,Signature


方式二:OAuth2.0鉴权

当安全接入选择OAuth2.0鉴权方式请点击查阅详情,请求头入参示例如下:

参数名称

类型

必选

参数说明

X-Tsign-Open-App-Id

string

项目ID

X-Tsign-Open-Token

string

通过获取鉴权Token接口返回

Content-Type

string

application/json; charset=UTF-8


请求参数

参数名称

类型

必选

参数类型

参数说明

示例值

flowId

string

path

流程id该参数需放在请求地址里面,可以参考【请求示例】


accountId

string

body

催签人账户id


noticeTypes

string

body

通知方式,逗号分割,1-短信,2-邮件,默认按照走流程设置

(请确保开通【身份核验能力】的子服务项 :【短信服务】,否则短信通知收不到)


rushsignAccountId

string

body

被催签人账号id,为空表示:催签当前轮到签署但还未签署的所有签署人


如果body体没有参数, 需要传空json对象:{}

公共响应参数

参数名称

类型

必选

参数说明

示例值

code

int

业务码,0表示成功


message

string

信息


data

object

业务信息


请求示例  

PUT https://openapi.esign.cn/v1/signflows/b2cb74258a634179b0df3cc54791c8b6/signers/rushsign


{
	"accountId": "",
	"noticeTypes": "1,2",
	"rushsignAccountId": "24c93459216945468fdf1d899c521910"
}

响应示例

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

错误码

错误码

错误描述

解决方案

1437126

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

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

1437127

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

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


我要纠错