合同签署
获取小程序签署链接
API 链接
使用场景
需要主动通知签署方，提供对应签署链接，在电子签小程序签署。
使用方法
| 参数名称 | 必选 | 参数类型 | 参数描述 |
|---|---|---|---|
| EndPoint | 否 | String | 链接类型。 HTTP：跳转电子签小程序的 http_url APP：第三方 App 或小程序跳转电子签小程序的 path 默认为 HTTP 类型 |
| Name | 否 | String | 姓名，最大长度 50 个字符 |
| Mobile | 否 | String | 手机号，大陆手机号 11 位 |
| OrganizationName | 否 | String | 企业名称 |
| FlowId | 否 | String | 签署流程编号（PathType=1 时必传） |
| PathType | 否 | Integer | 跳转页面 1：小程序合同详情 2：小程序合同列表页 0：不传，默认主页 |
- 若参数都不指定，则默认 HTTP 跳转电子签小程序链接，该链接打开直接跳转小程序主页。
- 指定 PathType=1 跳转小程序合同详情页，此时必须指定 FlowId 签署流程编号。
执行结果
获取到跳转链接。
获取 H5 页面签署链接
API 链接
使用场景
腾讯电子签支持可嵌入的 H5 页面，帮助开发者解决实际业务中的移动端集成的场景。H5 页面可以灵活的嵌入到 H5、App 中，在您的应用中完成签署功能闭环。
支持的场景
当前支持通过 API 获取合同签署链接，当前仅支持获取个人签署方的签署链接，且仅支持签名控件。我们会陆续支持更多的签署场景。
操作步骤
最佳实践如下：
第一步：根据合同 ID 获取合同签署链接
开发者需要将个人签署方的信息，作为接口参数传递。在实际的对接场景中，即可使用当前开发者的登录人信息，作为签署方。
第二步：访问签署链接：预览合同
将返回的页面链接，放到页面的 iframe 中。
第三步：签字并进行人脸识别完成签署
撤销签署流程
API 链接
使用场景
如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。
常用于合同发错、内容填错，需要及时撤销的场景。
如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
使用方法
| 参数名称 | 必选 | 参数类型 | 参数描述 |
|---|---|---|---|
| FlowId | 是 | String | 签署流程 ID |
| CancelMessage | 是 | String | 撤销原因，最长 200 个字符 |
指定需要撤销的签署流程 ID。
指定撤销合同的原因。