获取发起签署任务的地址

说明

调用本接口获取发起签署任务的地址。
服务地址：api.dingtalk.com

权限

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

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

错误码

HttpCode	错误码	错误信息	说明
400	requestParamError	%s	请求参数错误
400	serviceError	服务错误	服务错误
400	saveOrgTaskError	保存任务信息异常,盖企业印章,请传入企业名称	保存任务信息异常盖企业印章,请传入企业名称
400	saveTaskError	保存任务信息异常	保存任务信息异常

请求参数

Header 参数

serviceGroup

string

可选

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

x-acs-dingtalk-access-token

string

必需

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

Body 参数application/json

autoStart

string

可选

是否跳过发起签署页直接发起。

initiatorUserId

string

必需

任务发起方的userid。

taskName

string

可选

任务名称，默认为文件名。

redirectUrl

string

重定向跳转地址

可选

files

array [object {2}]

文件列表。

必需

fileId

string

文件ID。

必需

fileName

string

文件名称。

必需

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

可选

外部企业名称。
OUTER_USER需要盖企业章必填，如果不传，默认会赋值当前企业名称。

ccs

array [object {5}]

抄送人列表。

可选

accountType

string

用户类型，取值：

必需

userId

string

可选

钉钉用户userid。
当accountType为DING_USER时必填。

account

string

可选

外部用户账号、手机号或邮箱。
当accountType为OUTER_USER时必填。

accountName

string

可选

外部用户姓名。
当accountType为OUTER_USER时必填。

orgName

string

可选

外部企业名称，发给企业方必填。

sourceInfo

object

可选

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

showText

string

展示文案。

可选

pcUrl

string

pc端跳转地址。

可选

mobileUrl

string

移动端跳转地址。

可选

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

taskId

string

任务ID。

可选

pcUrl

string

可选

PC端发起签署任务地址。

mobileUrl

string

可选

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

示例

{
  "taskId": "string",
  "pcUrl": "string",
  "mobileUrl": "string"
}

获取发起签署任务的地址

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码