获取签署地址
接口地址 /v1/signflows/{flowId}/executeUrl
请求方式 GET
接口描述 流程开启后,获取指定签署人的签署链接地址,如仅传入签署人账号id,则获取的签署任务链接仅包含本人的签署任务;如同时签署人账号id+机构id,则获取的签署任务链接包含机构与个人的签署任务;organizeId传入0,则返回的任务链接包含签署人“本人+所有代签机构”的签署任务。
请求参数
参数名称 | 说明 | 参数类型 | 必填 | 类型 |
---|---|---|---|---|
flowId | 流程id | path | true | string |
accountId | 签署人账号id, 可指定, 默认用当前登录人账号id | query | true | string |
organizeId | 默认为空,返回的任务链接仅包含签署人本人需要签署的任务; 传入0,则返回的任务链接包含签署人“本人+所有代签机构”的签署任务; 传入指定机构id,则返回的任务链接包含签署人“本人+指定代签机构”的签署任务 | query | false | integer |
urlType | 链接类型: 0-签署链接;1-预览链接;默认0 | query | false | integer |
请求示例
GET https://openapi.esign.cn/v1/signflows/b2cb74258a634179b0df3cc54791c8b6/executeUrl?accountId=24c93459216945468fdf1d899c521910&organizeId=2c7de24aff3340f5b944ebac49545b8e
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
shortUrl | 短链地址(30天有效) | string |
url | 长链地址(永久有效) | string |
响应示例
{
"code": 0,
"message": "成功",
"data": {
"url": "http://testfront.tsign.cn:8821?context=mby8thwTJVcRhE8MbAUeYHiV0CoxNbGaCZz%2BzOIZxwPW8zZEyzddjDvu63OR%2BhpgEUp7Ys4DVub%2BiSQfldmCTC89MbdDHUUZ4yvgRXCjQ6s0Dcznr4daT4v9vR6SSKJsmrRIc%2F3xudxk6DmsqcmQSl0UJGwVCo%2FGFRG6bkjCuCSuVkESLfyf0iqgJqIuy8yYkxdWe%2Fi52IEJwFH%2FclDwS8Vb27mTop5HcuAAWaOUPKw2hTXCeLkx9zWgS4HOW17H8%2F%2BL6NtuWgiglUbedhpsdjgpEoQr63J%2FcXytIoFtDMvXmgZKnrN3QCuNBbS63QGuP5qHESNvyHbsd5qVkzy%2FzUSk7I4boumxkCFcDxXofKJ0SUahJTazovg031vx7uoXZT2kSW%2B9JhDN9rs8mbXCEs01VYiCiUP6hd81lHX%2B9jdFTJqELbE%2BDkBpUcCBJjbhME84qqoZDRTDHzQkxjOk3Ztbp3URjIFqpA9vAN%2FylLwzT0oyf3nirv7I%2BYBr8Qcr&flowId=b2cb74258a634179b0df3cc54791c8b6&organ=true",
"shortUrl": "https://testt.tsign.cn/55vebd3omU7k"
}
}
错误码
错误码 | 错误信息 | 错误原因 |
---|---|---|
1437101 | 流程不存在 | 流程id不存在 |
1437105 | 流程已删除 | 流程已被删除 |
1437103 | 流程尚未启动 | 流程还是草稿状态, 未发起 |
1437114 | XXX不是流程参与人, 无权查看流程 | 当前用户不是流程参与人 |