获取发起签署任务地址

说明

当ISV侧企业有文件需签署时，调用本接口，获取发起签署的地址。

权限

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

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

错误码

HttpCode	错误码	错误信息	说明
400	invalidRequest.invalidAguemnts	invalid arguments	参数错误

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

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

Body 参数application/json

files

array [object {2}]

文件列表。

可选

fileId

string

文件Id。

可选

fileName

string

文件名称。

可选

initiatorUserId

string

可选

发起方userId。

participants

array [object {6}]

参与方列表。

可选

accountType

string

用户类型。

可选

signRequirements

string

签署印章类型。

可选

userId

string

可选

用户userId。
当accountType为DING_USER时，该参数必填。

account

string

可选

账户。
当accountType为OUTER_USER时，该参数必填。

accountName

string

可选

账户名称（默认当前企业）。
当accountType为OUTER_USER时该参数必填，如果不传，默认会赋值当前企业名称。

orgName

string

可选

企业名称（默认当前企业）。
当accountType为OUTER_USER时该参数必填，如果不传，默认会赋值当前企业名称。

redirectUrl

string

回跳地址。

可选

sourceInfo

object

可选

来源信息。
目前支持传入审批信息和跳转地址。

mobileUrl

string

移动端跳转地址。

可选

pcUrl

string

pc端跳转地址。

可选

showText

string

展示文案。

可选

taskName

string

可选

任务名称（默认文件名）。

ccs

array [object {5}]

抄送人列表。

可选

accountType

string

用户类型。

可选

userId

string

可选

用户的userId。
当accountType为DING_USER时，该参数必填。

account

string

可选

账户。
当accountType为OUTER_USER时，该参数必填。

accountName

string

可选

账户名称。
当accountType为OUTER_USER时，该参数必填。

orgName

string

可选

企业名称。
发给企业方必填。

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

message

string

返回码描述。

可选

code

integer

返回码。

可选

data

object

返回结果。

可选

taskId

string

任务Id。

可选

pcUrl

string

可选

PC端发起签署任务地址。

mobileUrl

string

可选

移动端发起签署任务地址。

示例

{
  "message": "string",
  "code": 0,
  "data": {
    "taskId": "string",
    "pcUrl": "string",
    "mobileUrl": "string"
  }
}

获取发起签署任务地址

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码