创建签署流程

POST

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

生态伙伴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	createUserAccountError	创建用户账号异常	创建用户账号异常
400	getUserInfoFail	获取用户信息失败,%s，%s	获取用户信息失败
400	accountNotRealname	发起人账号在e签宝未实名发起人账号在e签宝未实名	发起人账号在e签宝未实名
400	createOrgAccountError	创建企业账号异常	创建企业账号异常
400	corpNotRealname	发起人企业在e签宝未实名	发起人企业在e签宝未实名
400	createFlowError	创建流程失败: %s	创建流程失败
400	getOpenIsvInfoError	获取对接服务商信息异常	获取对接服务商信息异常
400	saveTaskError	保存任务信息异常	保存任务信息异常

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

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

Body 参数application/json

initiatorUserId

string

必需

发起人的userid。

taskName

string

必需

任务名称，不支持特殊字符。

signEndTime

integer

签署截止时间。

可选

redirectUrl

string

重定向跳转地址。

可选

files

array [object {3}]

可选

文件列表，包括合同文件和附件。

fileId

string

文件ID。

必需

fileType

integer

文件类型，取值：

必需

fileName

string

文件名称。

必需

participants

array [object {8}]

参与方列表。

可选

signRequirements

string

必需

签署印章类型，取值：

signOrder

integer

签署顺序。

可选

accountType

string

用户类型，取值：

必需

account

string

可选

邮箱/手机号账号(accountType为OUTER_USER时必填）

userId

string

可选

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

accountName

string

可选

账号对应人姓名。
accountType为OUTER_USER时必填。

orgName

string

可选

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

signPosList

array [object {8}]

可选

参与方签署位置信息列表。

ccs

array [object {5}]

抄送人列表。

可选

accountType

string

用户类型，取值：

必需

account

string

可选

邮箱或手机号账号。
account与userId两者至少填一项，优先取userId。

userId

string

可选

钉钉用户userid。
account与userId两者至少填一项，优先取userId。

accountName

string

账号对应人姓名。

可选

orgName

string

企业名称。

可选

sourceInfo

object

可选

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

showText

string

展示文案

可选

pcUrl

string

PC端签署地址。

可选

mobileUrl

string

移动端签署地址。

可选

示例

{}

示例代码

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/startAtOnce' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功

application/json

Body

taskId

string

任务ID。

可选

示例

{
  "taskId": "string"
}

获取发起签署任务的地址

获取签署人签署地址

创建签署流程

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码