获取批量签署链接

更新时间:2022-06-13 19:25:27

接口描述

流程开启后,用于获取指定签署人名下的待签合同文件列表页面,签署人进行一次意愿认证即可同时完成多个流程签署。

签署须知

请传入状态为签署中的流程ID,接口中并未对签署状态有强校验,若传入签署中和已完成状态的流程ID,批量签署链接中会对签署任务进行归类,展示可批量签署的任务与不可批量签署的任务。

(不可批量签署任务,请参考下方文末《不可批量签原因》)。

接口地址

/v3/sign-flow/batch-sign-url

请求方式

POST

请求头

方式一:请求签名鉴权(优先推荐)

当接口调用选择请求签名鉴权方式点击查看详细说明

参数名称

类型

必选

参数说明

X-Tsign-Open-Auth-Mode

string

接口鉴权方式,请填写固定值Signature

X-Tsign-Open-App-Id

string

应用ID

X-Tsign-Open-Ca-Signature

string

请求签名值,查看请求签名值计算说明

X-Tsign-Open-Ca-Timestamp

string

接口调用时的Unix时间戳,单位毫秒。

防重放攻击,时间戳有效期为15分钟。

Content-MD5

string

当请求Body体为非Form格式时,需要对Body体计算ContentMD5并传给网关进行校验。

application/json格式的Body体时此项必选。

Content-Type

string

application/json; charset=UTF-8

Accept

string

建议统一填写 */*

方式二:OAuth2.0鉴权(不推荐使用)

当接口调用选择OAuth2.0鉴权方式请点击查看具体请求头

请求参数

参数名称

类型

必选

参数类型

参数说明

operatorId

string

body

操作人账号ID

signFlowIds

array

body

待签署流程ID列表(最多支持10个流程)

redirectUrl

string

body

重定向地址,签署完成结果页确认后跳转地址

响应参数

展开全部参数参数名称

类型

必选

参数说明

code

int

业务码,0表示成功

message

string

信息

data

object

业务信息

batchSignUrl

string

批量签链接(需登录签署)

链接有效期2小时

batchSignShortUrl

string

批量签短链接(需登录签署)

链接有效期2小时

batchSignUrlWithoutLogin

string

免登录批量签链接

链接有效期2小时

batchSignShortUrlWithoutLogin

string

免登录批量签短链接

链接有效期2小时

请求示例  

POST https://openapi.esign.cn/v3/sign-flow/batch-sign-url
{
    "operatorId":"c7e0029472914ce4a3xxxe7",
    "redirectUrl":"xxx",
    "signFlowIds":[
        "ba619b6d03b64107952373bf8e9xxe4",
        "7b90e0d09ab14213ae41b29a67dxx553"
    ]
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "batchSignUrl": "https://smlfront.esign.cn:8880/esign/batchsign/list?context=xx&batchSerialId=api-batch-be62b55f12eb420fa9ea5ab78f63022c&tsign_source_type=SIGN_LINK_WUKONG&tsign_source_detail=16R2mv%2F27h2Y5CkM9bwhboD%2BX2sLbduld2RHYsE8Th5i7x9OMhdo60RXANIQGQEmEVAiwGysGBt9PRDbTnLtzezs8ffn87%2FYPYHc%2BjjziB9S2thQUEJD9elz3xYd67NCxUhUyVUvfrJtV1J0VfnyczUL53CB5yNpWKrTLgFn0AuqG%2BOEnnTQkNoTrtN2gwa1uvNTc%2BSaUqH5PF%%2B5pj%2B",
        "batchSignShortUrl": "https://smlt.esign.cn/xxxx",
        "batchSignUrlWithoutLogin": "https://smlfront.esign.cn:8880/esign/batchsign/list?context=5HOcvQ7qjEIV&batchSerialId=api-batch-xx&tsign_source_type=SIGN_LINK_WUKONG&tsign_source_detail=16R2mv%2F27h2Y5CkM9bwhboD%2BX2sLbduld2RHYsE8Th5i7x9OMhdo60RXANIQGQEmEVAiwGysGBt9PRDbTnLtzezs8ffn87%2FYPYHc%2BjjziB9S2thQUEJD9elz3xYd67NCxUhUyVUvfrJtV1J0VfnyczUL53CB5yNpWKrTLgFn0AuqG%2BOEnnTQkNoTrtN2gwa1uvNTc%2BSaUqH5PF%%2B5pj%2B",
        "batchSignShortUrlWithoutLogin": "https://smlt.esign.cn/xxxx"
    }
}

不可批量签原因

(1)批量签署仅允许指定一个印章,发起签署流程时若指定了印章类型 sealBizTypes ,将不支持批量签署。

(2)自由移动签署区位置的流程不支持批量签署,发起签署流程时 assignedPosbean固定签署区位置)参数需传 true,固定签署区位置且无法移动。

我要纠错