一步发起签署接口属于聚合接口,可以一次性传入签署过程所需的数据,快速发起签署任务。
一步发起签署接口涵盖了签署流程创建接口、流程文档添加接口、流程附件添加、添加平台自身自动盖章签署区、添加签署方手动盖章签署区、签署流程开启、签署流程归档等接口所需要的数据和功能,可以减少接口的调用数量。
autoInitiate(签署流程自动开启参数)
一步发起签署接口中的 autoInitiate 参数设置true时将在接口调用成功后自动开启签署流程。如果不希望自动开启签署流程,需要将 autoInitiate 参数设置false,并在需要开启签署流程时主动调用签署流程开启接口。
autoArchive(签署流程自动归档参数)
一步发起签署接口中的 autoArchive 参数设置true时将所有签署方签字盖章完成后自动将签署流程进行归档。当签署流程归档后才算一个签署流程完结,不允许再追加签署区。如果不希望自动归档,autoArchive 参数设置false,并在签署文件下载前先调用签署流程归档接口。
signers(签署方列表参数)
signers签署方列表参数设置规则如下:
参数字段\签署场景 | 平台方自动签署 | 用户手动签署(个人) | 用户手动签署(企业) |
platformSign | true | false | false |
signerAccountId | 不传 | 个人签署账号ID | 个人签署账号ID |
authorizedAccountId | 不传 | 不传 | 机构签署账号ID |
autoExecute | true | false | false |
actorIndentityType | 2或不传 | 不传 | 2 |
noticeType(通知方式参数)
该参数用于指定签署的通知方式:短信、邮件或者不通知。在flowInfo(本次签署流程的基本信息)和signers(签署方信息)中都存在该参数,这两个参数组合的逻辑规则如下:
外层flowInfo中配置的noticeType | 内层signers中配置的noticeType | 最终结果 |
指定具体通知方式或者不指定该参数 | 指定具体通知方式(可以和外层指定的通知方式不同) | 取内层signers中的通知方式 |
指定具体通知方式 | 不指定或者指定空值"" | 取外层flowInfo中的通知方式 |
不指定 | 不指定或者指定空值"" | 默认短信通知 |
指定空值"" | 指定具体通知方式 | 取内层signers中的通知方式 |
指定空值"" | 不指定或者指定空值"" | 不通知 |
签署流程状态查看
企业开发者可以根据e签宝消息通知服务来异步接收签署流程状态变动通知,具体查看回调通知说明。
如果长时间未接收到签署流程状态变动的回调通知,企业开发者可以主动调用签署流程查询、流程签署人列表和
查询签署区列表接口来获知签署流程当前进展状态。
签署流程撤销
发起签署任务后,如果因某些原因需要将此签署流程进行撤销,企业开发者可以调用签署流程撤销接口。
如果签署流程已被归档,则无法再撤销签署流程。签署流程撤销成功后,基于此签署流程的所有签署都失效。
签署区删除
发起签署任务后,如果发现某个签署方不需要参与签署时,企业开发者可以调用删除签署区接口将其从此签署流程中删除。
如果签署流程已被归档或某签署方已完成签署操作则无法再进行删除。