文档变更
2022年时，获取签署地址变为获取签署链接，以便开发者更容易理解，仅中文名称变更，其功能保持不变。
接口描述
签署流程开启后，可获取指定签署人的签署链接。
注：获取签署链接后，开发者可以在业务系统中加载签署链接或自行发送短信或邮件。
接口地址&请求方式
接口地址：/v3/signflows/{flowId}/executeUrl
请求方式：GET
请求头格式
具体请求头格式结构，请点击查看公共参数说明。
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 |
flowId | string | 是 | path | 签署流程ID |
urlType | int32 | 否 | query | 链接类型（默认值 2） 1 - 预览链接（只能查看，不能签署） 2 - 签署链接 |
clientType | string | 否 | query | 客户端类型，默认值：H5 H5 - 移动端 PC - PC端 ALL - 自动适配移动端或PC端 |
appScheme | string | 否 | query | AppScheme，用于唤起App。 示例： appScheme=xxxdev://cn.demo/signBackPage |
方式1：指定签署账号 （选择方式1或方式2，请与发起签署时的用户账号保持一致） | ||||
signerAccount | string | 否 | query | 签署人账号（手机号/邮箱） 用于获取个人签署链接，需与发起签署时账号一致。 |
authorizedAccount | string | 否 | query | 签署机构账号名称，默认为空。 用于获取机构签署链接，需与发起签署时名称一致。 注： 一个签署流程中某人代多个机构签署时，需要通过此参数分别获取对应机构的签署链接。 |
方式2：指定签署账号ID（选择方式1或方式2，请与发起签署时的用户账号保持一致） | ||||
accountId | string | 否 | query | 签署人账号ID（个人签署账号ID） 用于获取个人签署链接，需与发起签署时账号ID一致。 注：传入e签宝SaaS官网的账号ID，即通过【获取认证链接】操作认证后生成的账号accountId。 |
authorizedAccountId | string | 否 | query | 签署机构账号ID，默认为空。 用于获取机构签署链接，需与发起签署时账号ID一致。 注： （1）一个签署流程中某人代多个机构签署时，需要通过此参数分别获取对应机构的签署链接。 （2）传入e签宝SaaS官网的账号ID，即通过【获取认证链接】操作认证后生成的账号orgId。 |
AppScheme示例说明：
appScheme = xxxdev://cn.demo/signBackPage
xxxdev是要唤起App的Scheme
cn.demo/signBackPage是App中的页面路径
若使用e签宝Demo调试时可设置appScheme=esign://demo/signBack
响应参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 （左右拖动查看完整描述） | |
code | int | 是 | 业务码，0表示成功 | |
message | string | 否 | 信息 | |
data | object | 否 | 业务信息 | |
url | string | 否 | 长链地址(永久有效)，通过此链接访问不需要登录框。 | |
shortUrl | string | 否 | 短链地址（180天有效），通过此链接访问不需要登录框。 | |
请求示例
GET https://openapi.esign.cn/v3/signflows/01cb74258a634179b0df3cc54791c8b6/executeUrl?signerAccount=15300001111&clientType=PC
响应示例
{
"code": 0,
"message": "成功",
"data": {
"url": "https://smlfront.esign.cn:8880/esign?context=PjOSUw90YJFY&flowId=96a3d4f92c5f4b33a205abd6ef8d8a77&organ=true&appId=7438799000&linkSource=1&bizType=1&tsign_source_type=SIGN_LINK_XUANYUAN&tsign_source_detail=16R2mv%2F27h2Y5CkM9bwhboKuo49Def35kchsqmyKbw0O9leTv9lwwoN7iI1irwPJVZixAhgW8%2BvGx0p7Fkx%2BEf9yfvhI13wcC4oYyKZp2HmHCXtjndHA3m9sHSIBy8es9yaKPAcypBgc0h5qiOYTwAs2qQXuSnDi8muypVg4%2FfnC4KW%2BeBcWE5aGTHT4z3TATli1E7xhoot%2FfSr0DJsp567iTMjZ5nwFZhYnbxkq8u08jcszU2all6PXZulXqT3RC",
"shortUrl": "https://smlt.esign.cn/00p3zzyCO8DU"
}
}错误码
错误码 | 报错描述 （左右拖动查看完整描述） |
1435203 | 账号不存在: {0} |
1435203 | 用户账号不存在或已注销 |
1437101 | 流程不存在 |
1437103 | 流程未开启 |
1437105 | 流程已删除 |
1437114 | 当前用户不是流程参与人，无权查看流程 |
1438603 | 请传入参与人手机号或邮箱 |
1438604 | 参与人不能为空 |
我要纠错