获取签署人签署地址

POST

http://127.0.0.1/v2.0/esign/process/executeUrls

生态伙伴API/e签宝/e签宝2.0/签署流程

最后修改时间：2022-08-30 09:19:24

责任人：未设置

说明

调用本接口获取到签署地址，isv应用内用户可点击进入签署页面进行签署，区分钉钉容器内的地址和钉钉容器外的地址（浏览器）。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	E签宝数据管理权限	API Explorer
第三方企业应用	支持	E签宝数据管理权限	API Explorer
第三方个人应用	暂不支持	E签宝数据管理权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	requestParamError	%s	请求参数错误
400	getFlowInfoError	获取流程信息失败	获取流程信息失败
400	queryFlowError	查询流程详情异常	查询流程详情异常
400	getUserInfoFail	获取用户信息失败,%s，%s	获取用户信息失败
400	getSignUrlError	获取签署链接失败: %s	获取签署链接失败

请求参数

Header 参数

serviceGroup

string

可选

预留参数，此版本无需此参数。

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

taskId

string

任务ID。

必需

signContainer

integer

可选

签署链接允许在哪个容器打开，取值：默认值：1。

account

string

可选

签署人账号ID。
signContainer为2时，此参数必填，其他情况不用填。

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/v2.0/esign/process/executeUrls' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功

application/json

Body

mobileUrl

string

可选

移动端钉钉容器内流程地址。
signContainer为1时，返回该地址。

pcUrl

string

可选

PC端钉钉容器内流程的地址。
signContainer为1时，返回该地址。

longUrl

string

可选

流程地址，用于在浏览器内打开，长链地址永久有效, 不区分移动端或PC端，UI会自适应。
signContainer为2时，返回该地址。

shortUrl

string

可选

流程地址，用于在浏览器内打开，短链地址30天有效, 不区分移动端或PC端，UI会自适应。
signContainer为2时，返回该地址。

示例

{
  "mobileUrl": "string",
  "pcUrl": "string",
  "longUrl": "string",
  "shortUrl": "string"
}

创建签署流程

获取流程的签署详情

获取签署人签署地址

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码