基础介绍
当发起合同签署时,接口可以选择通过e签宝自带的短信/邮件通知告知用户签署,通知中会携带签署链接,用户打开链接即可签署。
注:e签宝自带的短信/邮件通知里的签署链接需要用户登录e签宝,【获取签署页面链接】接口获取的用户签署页面链接可以选择免登录e签宝,但是不带通知方式,需要开发者集成在自己的系统内或者自行通知。
效果展示
短信通知
邮件通知
API接口
API接口(点击直接跳转相关API文档) | API描述 | 是否必需 |
此接口用来发起签署,发起成功后会返回签署流程标识:signFlowId。 | 必需 | |
此接口获取签署方签署页面链接,可用于签署或预览。 | 按需 |
基于文件发起签署接口代码案例
相关参数
- noticeTypes(通知类型,允许多种通知方式,请使用英文逗号分隔:传空 - 不通知(默认值),1 - 短信通知,2 - 邮件通知)
该参数用于指定签署的通知方式,在signFlowConfig(签署流程配置项)和signers(签署方信息)中都存在该参数,这两个参数组合的逻辑规则如下:
外层signFlowConfig中配置的noticeTypes | 内层signers中配置的noticeTypes | 最终结果 |
指定具体通知方式 | 指定具体通知方式(可以和外层指定的通知方式不同) | 取内层signers中的通知方式 |
指定具体通知方式 | 不指定或者指定空值"" | 取外层signFlowConfig中的通知方式 |
不指定或者指定空值"" | 指定具体通知方式 | 取内层signers中的通知方式 |
不指定或者指定空值"" | 不指定或者指定空值"" | 不通知 |
指定通知方式相关代码
(以外层signFlowConfig中配置noticeTypes为例)
"signFlowConfig": { "noticeConfig": { "noticeTypes": "" } }
"signFlowConfig": { "noticeConfig": { "noticeTypes": "1" } }
"signFlowConfig": { "noticeConfig": { "noticeTypes": "2" } }
"signFlowConfig": { "noticeConfig": { "noticeTypes": "1,2" } }