签署流程状态示意图
签署流程状态说明
流程状态的参数说明
- 建议调用【查询签署流程详情】接口,查询流程的状态。
状态(signFlowStatus) | 草稿 | 签署中 | 完成 | 撤销 | 过期 | 拒签 |
对应值 | 0 | 1 | 2 | 3 | 5 | 7 |
【草稿】signFlowStatus=0
流程的初始状态,进入草稿状态依据【基于文件发起签署】时设置的自动开启参数autoStart
:
(1)自动开启参数autoStart
(默认值true),传入了true,则流程将直接进入“签署中”状态;
(2)自动开启参数autoStart
,传入了false,此时流程为“草稿”状态。
autoStart
设置为false,适用于发起签署流程时相关需求不明确的场景,允许开发者继续向流程中添加签署文件、签署方等,草稿状态下允许调用以下接口来添加流程内容:
【注】确认添加完毕之后,务必调用【开启签署流程】接口,开启流程进入下一个状态“签署中”。
【签署中】signFlowStatus=1
流程开始按既定配置项流转,“签署中”允许调用以下接口:
- 获取单笔流程的签署链接:【获取合同文件签署链接】
- 获取多笔流程的批量签署链接:【获取批量签页面链接(多流程)】
- 向签署人发送催签提醒:【催签流程中签署人】
- 添加或删除签署方(区):【追加签署区】(仅限非自动完结的流程
autoFinish
=false)、【删除签署区】(未签署状态下允许删除) - 添加流程中的附件:【追加附属材料】
- 添加或删除抄送方:【添加抄送方】(仅限非自动完结的流程
autoFinish
=false)、【删除抄送方】 - 修改流程的截止时间:【延长签署截止时间】
- 撤销已发起的流程:【撤销签署流程】
【已完成】signFlowStatus= 2
当流程中设置的签署方全部完成了签署,依据【基于文件发起签署】时设置的自动完结参数autoFinish
:
(1)自动完结参数autoFinish
,传入了true,全部完成签署后流程自动进入“已完成”状态;
(2)自动完结参数autoFinish
(默认值false),传入了false,务必调用【完结签署流程】,流程状态才会变更为“已完成”。
- 仅限“已完成”状态下,下载流程中的相关文件:【下载已签署文件及附属材料】。
【撤销】signFlowStatus= 3
“签署中”的流程,调用【撤销签署流程】接口成功后触发,流程将变更为“撤销”状态,所有的签署均失效。
【过期】signFlowStatus= 5
“签署中”的流程,如果超过了流程设置的截止时间,流程将自动变更为“过期”状态。
【拒签】signFlowStatus= 7
当流程中的任一签署方拒绝签署文件后,流程将直接变更为“拒签”状态。