基础介绍
开发者在发起签署时，可通过指定签署声明参数，在用户的签署页面展示自定义提示弹框。该功能适用于向签署方呈现重要提示、协议条款或操作说明等场景。
注：签署声明内容将在签署方进入签署页时主动弹出，需用户确认后方可继续签署操作。
效果展示
效果一
其中声明文案标题、声明文案内容字样为开发者发起签署时入参可以自定义的内容，点击“我已知悉上述内容”按钮后关闭弹框，进入签署合同页。
效果二
如果发起的入参指定的是signTipsFileId上传的是文件，则声明弹框中展示的是文件内容，效果如下：
效果三
发起签署时如果signers签署方维度和signFlowConfig流程维度同时配置了声明，则声明内容会并排都展示出来效果如下：
三者效果的区别
在signFlowConfig（签署流程配置项）和signers（签署方信息）中都存在签署声明的配置，组合的逻辑规则如下
配置场景 | 触发对象 | 展示效果 | 描述 |
仅配置签署方维度（signers） | 仅限配置了声明内容的特定签署方 | 效果一 或 效果二 | 只对需要额外告知或约束的特定签署方展示声明。 |
仅配置流程维度（signFlowConfig） | 所有签署方 | 效果一 | 流程中的所有签署方在签署前都必须阅读同一份声明。 |
两个维度都配置（signFlowConfig和signers） | 所有签署方（但展示内容不同） | 效果三（内容并排展示） | 所有签署方都会看到弹框，其中既包含流程通用声明，也包含针对某一方的特定声明。 |
API接口
API接口（点击直接跳转相关API文档） | API描述 | 是否必需 |
此接口用来发起签署，发起成功后会返回签署流程标识：signFlowId。 | 必需 | |
此接口获取签署方签署页面链接，可用于签署或预览。 | 按需 |
基于文件发起签署接口代码案例
相关参数
- signTipsTitle 用户进入签署页提示弹框自定义签署声明--文案标题（最多20字）
- signTipsContent 用户进入签署页提示弹框自定义签署声明--文案内容（最多500字）
- signTipsFileId 用户进入签署页提示弹框自定义签署声明--文案的文件ID（通过【上传本地文件】接口获取，必须转成PDF格式）
【注】：signTipsContent与signTipsFileId字段二选一传入，不可同时传入。
代码示例
传signTipsContent文案内容代码示例：
"signConfig": {
"signTipsTitle":"声明文案标题",
"signTipsContent":"声明文案内容"
}传signTipsFileId文件内容代码示例：
【注】：signTipsFileId配置声明文件仅支持在signers签署方维度配置。
"signConfig": {
"signTipsTitle":"声明文案标题",
"signTipsFileId":"ba8ffb4bf63e4c67bb777861d3f7b078"
}
我要纠错