获取用印审批页面链接

更新时间:2024-12-06 16:20:27

接口描述

当签署流程中有用印审批流程触发后,可以通过审批流程ID获取当前审批人待审批的页面链接(仅能获取当前appId发起的签署流程产生的审批任务)。

接口地址&请求方法

接口地址:https://{host}/v3/approval/approval-url

请求方法:POST

请求头格式

具体请求头参数,请查看公共请求头格式

请求参数

展开全部参数参数名称

参数类型

必选

参数位置

参数说明

approvalFlowId

string

body

审批流程ID(通过【回调通知】或者【查询签署流程详情】接口获取)

补充说明:

需要提前让盖章主体公司对调用方企业应用ID做授权后才可以使用该接口(调用【获取机构认证&授权页面链接】接口,授权添加 org_approval_info manage_org_resource权限范围)。

approverPsnId

string

body

审批人个人用户账号ID(可通过【回调通知】或者【查询审批流程详情】接口获取)

needLogin

boolean

body

链接是否需要登录打开,默认 true

true - 需要登录

false - 不需要登录

clientType

string

body

指定客户端类型,默认 ALL

H5 - 移动端适配

PC - PC端适配

ALL - 自动适配移动端或PC端(默认值)

【注】参数值均为大写的英文

redirectConfig(点击“+”展开详情)

object

body

重定向配置项

redirectUrl

string

body

重定向地址(需符合 https /http 协议地址)

redirectDelayTime

int

body

操作完成重定向跳转延迟时间,单位秒(可选值0、3,默认值为 3)

  • 0时,签署完成直接跳转重定向地址;
  • 3时,展示签署完成结果页,倒计时3秒后,自动跳转重定向地址。

【注】当redirectUrl不传的情况下,该字段无需传入,审批完成不跳转

响应参数

展开全部参数参数名称

参数类型

必选

参数说明

code

int32

业务码,0表示成功,非0表示异常。

message

string

业务信息

请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。

data(点击“+”展开详情)

object

业务数据

approvalTaskId

string

审批任务ID

approvalShortUrl

string

审批短链接(有效期180天)

approvalUrl

string

审批长链接(永久有效)

【注】支持自定义域名,微信小程序H5内嵌场景需要使用长链接

请求示例

{
  "approvalFlowId":"AF-2cb6a1118080ebb",
  "approverPsnId":"7ffcaed8c11116c3aaca1d8f0ef0a8f6",
  "clientType": "ALL",
  "needLogin": false,
   "redirectConfig": {
        "redirectUrl": "https://open.esign.cn"
    }
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "approvalShortUrl": "https://smlt.esign.cn/FLQ2zkK",
        "approvalUrl": "https://smlh5.esign.cn/contract-flow/approval/seals?context=RMJ7pD2&approvalId=AF-2cb6a111180ebb&tsign_source_type=SIGN_LINK_WUKONG&tsign_source_detail=16R2mv%2F27h2Y5CkM9bwhboJI1J3vlJRfZSWcIsoCQiZlor%2FBjDAHDYjqRou4NZ2cLUfzqDWDgY3qEadxIkmYQRtK5oSH1Fean2CIzLt27bfs9kMW%2FCby%2Bxrv4oSFKYdjEi8pJX5Rly74d5dZPp3folV9Fwz78F%2F6b0wDdq%2BOAn9EEG%2BTQ6UFRmUlXzY0Ac4T%2FYX6tF6VYIS0XH7AvzeQiNFQBfTEghDKeYx0%2B9k5amg4%3D",
        "approvalTaskId": "c8003557-c0e3-11ee-8111-fea8a8dd3076"
    }
}

错误码

点击查看错误码

我要纠错