获取签署流程签署链接
API 链接
使用场景
需要签署人在自己的 APP、小程序、H5 应用中签署。
使用方法
参数名称 | 必选 | 参数类型 | 参数描述 |
EndPoint | 否 | String | 链接类型。 HTTP：跳转电子签小程序的 。 http_urlAPP：第三方 App 或小程序跳转电子签小程序的 path 默认为 HTTP 类型。 |
Name | 否 | String | 姓名，最大长度50个字符。 |
Mobile | 否 | String | 手机号，大陆手机号11位。 |
OrganizationName | 否 | String | 企业名称。 |
FlowId | 否 | String | 签署流程编号（PathType=1时必传）。 |
PathType | 否 | Integer | 跳转页面。 1：小程序合同详情 2：小程序合同列表页 0：不传，默认主页 |
若参数都不指定，则默认 HTTP 跳转电子签小程序链接，该链接打开直接跳转小程序主页。
指定 PathType=1 跳转小程序合同详情页，此时必须指定 FlowId 签署流程编号。
执行结果
获取到跳转链接。
下载签署流程合同文件
API 链接
使用场景
想要获得配置的电子印章，电子文档，模板 PDF 文件信息。
想要得到签署完成后的签署流程合同 PDF 文件。
使用方法
支持下载 BusinessType：模板，电子文档文件，印章，签署流程文件。
根据下载类型可指定 BusinessIds：模板 ID、电子文档 ID、印章 ID、签署流程 ID。
可指定文件类型 FileType，指定文件类型后获取到下载链接下载文件，可得到指定文件类型的文件。
当文件类型是 ZIP，可指定文件打包压缩之后的文件名 FileName。
执行结果
得到指定业务类型的文件下载链接。
查询合同摘要信息
API 链接
使用场景
用来查询指定签署流程的摘要信息（名称，签署流程状态等）。
客户可主动调用该接口了解签署流程的生命周期。
执行结果
获取到指定签署流程的摘要信息。
撤销签署流程
API 链接
使用场景
如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。
常用于合同发错、内容填错，需要及时撤销的场景。
如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
使用方法
参数名称 | 必选 | 参数类型 | 参数描述 |
FlowId | 是 | String | 签署流程 ID。 |
CancelMessage | 是 | String | 撤销原因，最长200个字符。 |
指定需要撤销的签署流程 ID。
指定撤销合同的原因。