接口描述
用于获取指定签署人名下的待签合同文件列表页面，签署人进行一次意愿认证即可同时完成多个流程签署。
接口地址：https://{host}/v3/sign-flow/batch-sign-url
请求方法：POST
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
operatorId | string | 是 | body | 签署人账号ID（请传入个人账号ID或企业经办人账号ID） |
signFlowIds | array | 是 | body | 待签署流程ID列表（最多支持1000个流程签署）
|
noticeTypes | string | 否 | body | 批量签署通知类型，默认不通知（值为""空字符串），允许多种通知方式，请使用英文逗号分隔 "" - 不通知（默认值） 1 - 短信通知（如果套餐内带“分项”字样，请确保开通【电子签名流量费（分项）认证】中的子项：【短信服务】，否则短信通知收不到） 2 - 邮件通知 补充说明：
|
forcedRead | boolean | 否 | body | 是否强制阅读，默认false true-强制阅读所有文件后才能签署 false-不强制阅读 |
clientType | string | 否 | body | 指定客户端类型，默认ALL ALL - 自动适配移动端或PC端 H5 - 移动端适配 PC - PC端适配 |
redirectUrl | string | 否 | body | 重定向地址，签署完成结果页确认后跳转地址 【注】贵司的重定向域名需要在e签宝提前放行，否则会报错：“您即将访问的页面可能有安全风险”。（点击跳转 重定向域名配置说明） |
appScheme | string | 否 | body | AppScheme，主要用于支付宝人脸认证重定向时跳回开发者自身App。 示例值：esign://demo/signBack |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | ||||
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖message匹配，因为 message 可能会调整。 | ||||
data（点击“+”展开详情） | object | 否 | 业务数据 | ||||
batchSerialId | string | 否 | 批量签署批次号（标识本次批量签署任务） | ||||
batchSignUrl | string | 否 | 需登录批量签长链接（链接有效期2小时） 【注】支持自定义域名，微信小程序H5内嵌场景需要使用长链接 | ||||
batchSignShortUrl | string | 否 | 需登录批量签短链接（链接有效期2小时） | ||||
batchSignUrlWithoutLogin | string | 否 | 免登录批量签长链接（链接有效期2小时） 【注】支持自定义域名，微信小程序H5内嵌场景需要使用长链接 | ||||
batchSignShortUrlWithoutLogin | string | 否 | 免登录批量签短链接（链接有效期2小时） | ||||
请求示例
{
"operatorId":"c7e0029472914ce4a3xxxe7",
"redirectUrl":"xxx",
"signFlowIds":["ba619b6d0***bf8e9xxe4","7b90e0d09***29a67dx53"]
}响应示例
{
"code": 0,
"message": "成功",
"data": {
"batchSerialId": "api-batch-sign-3c3e8efc5*****ad0403a1021c",
"batchSignUrl": "https://h5.esign.cn/mesign/batchsign/guide?context=Xj**fR&batchSerialId=api-batch-51ae2****9a954581db&tsign_source_type=SIGN_LINK_XUANYUAN&tsign_source_detail=1vGqUyZBm8k4aIosrZzTBwWnV2I1g4UB0OAxYE6sa91zI0%2FoJj3R7FKUZEeoKkklf1znfL22PeRUYAl8NCRQ%2BbBGhKB1TP9NSoNklLj%2FPTaARYB%2Bw3PPrphpz72szoc4iwILDHQ95H6OoKl0tNtygNh5kQ5rLc0rmRFzUHMPmGgC3JtO9puMWcqzHsw7GUdJ%2F%2FdA7&appId=511***",
"batchSignShortUrl": "https://t.esign.cn/Rb***x",
"batchSignUrlWithoutLogin": "https://h5.esign.cn/mesign/batchsign/guide?context=TO**IY&batchSerialId=api-batch-51ae2eb9******554581db&tsign_source_type=SIGN_LINK_XUANYUAN&tsign_source_detail=1vGqUyZBm8k4aIosrZzTBwWneRUYAl8NCRQ%2BbBGhKtTDCNc1EfDWAJpgZxx4XY1xs4z7LJqPU7FqA09VjIh6eB1TP9NSoNklLj%2FPTaARYB%2Bw3PPrphpz72zCF06KDLdV2jw59qszoc4iwILDHQ95H6OoKl0tNtygNh5kQ5rLc0rmRFzUHMPmGgC3A7&appId=5111****",
"batchSignShortUrlWithoutLogin": "https://t.esign.cn/qW***HU"
}
}
我要纠错