流程文档添加

更新时间：2022-12-27 11:36:48

接口描述

向流程中添加待签署文档，已经开启的流程不能再添加签署文档。文档必须先用文档管理接口创建，创建方式请参见文件管理接口文档。

【提示】

1、该文件是否需要签署。如果添加的文件只是给签署人阅读，不做签署，建议将该文件以附件的形式进行添加，参考流程附件添加接口；

2、通过该接口添加的签署文件，将按照正常计费模式扣除合同份额。

3、因Windows操作系统中文件名称不支持个别特殊字符，现调整fileName字段不支持以下9个字符/ \ : * " < > | ？以及所有emoji表情，详见文件名称特殊字符限制

4、单个签署流程所添加的待签署文件大小总和不要超过500M，待签署文件个数不超过50个，单个文件的大小不要超过20M，单个文件的单页大小不要超过9M，单个签署流程所添加的签署区不要超过300个，详见文件大小规则说明

点击查看具体更新日志

接口

/v1/signflows/{flowId}/documents

请求方式

POST

请求头

提供两种安全接入方式，开发者可选择其中一种方式进行对接，对应参数如何获取，参考文档【请点击】。

方式一：请求签名鉴权（优先推荐）

请求头入参示例如下：

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	项目ID
Content-Type	string	是	application/json;charset=UTF-8
X-Tsign-Open-Ca-Timestamp	string	是	API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击
Accept	string	是	建议统一填写 /
X-Tsign-Open-Ca-Signature	string	是	签名字符串
Content-MD5	string	否	当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。
X-Tsign-Open-Auth-Mode	string	是	选择请求方式进行鉴权，固定值，Signature

方式二：OAuth2.0鉴权（不推荐使用）

当安全接入选择OAuth2.0鉴权方式，请点击查阅详情，请求头入参示例如下：

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	项目ID
X-Tsign-Open-Token	string	是	通过获取鉴权Token接口返回
Content-Type	string	是	application/json; charset=UTF-8

请求参数

展开全部参数参数名称		类型	必选	参数类型	参数说明
flowId		string	是	path	流程id
docs		array	是	body	文档列表数据
	fileId	string	是	body	文档id
	fileName	string	否	body	文件名称（必须带上文件扩展名，不然会导致后续发起流程校验过不去示例：合同.pdf ）；注意：（1）该字段的文件后缀名称和真实的文件后缀需要一致。比如上传的文件类型是word文件，那该参数需要传“xxx.docx”，不能是“xxx.pdf” （2）文件名称不可含有以下9个特殊字符：/ \ : * " < > \| ？以及所有emoji表情该参数控制下图所示位置
	encryption	int32	否	body	文档是否设置编辑密码 0-未设置，1-已设置，默认值为0 注：（1）设置编辑密码的PDF文件需要输入密码才有权限进行盖章操作。（2）encryption填写1时，同时需要向filePassword参数填写编辑密码。（3）支持自动盖章场景。（4）不支持手动盖章场景。
	filePassword	string	否	body	文档编辑密码当encryption值为1时, filePassword值必须填写。当encryption值为0时, filePassword值允许为空。

公共响应参数

参数名称	类型	必选	参数说明
code	int	是	业务码，0表示成功
message	string	否	信息
data	object	否	业务信息

请求示例

POST https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d/documents

{
    "docs":[
        {
            "encryption":0,
            "fileId":"01e50a9cedb74493a2d320b4f4732a29",
            "fileName":"第一份合同.pdf",
            "filePassword":""
        }
    ]
}

响应示例

{
    "code":0,
    "message":"成功",
    "data":null
}

错误码

错误码	错误描述	解决方案
1437502	流程非草稿状态，不允许添加文档	只有草稿状态的流程才能新增流程签署文档
1437503	文档ID重复	添加的文档列表中存在相同的文档id, 不能重复添加
1437504	流程已添加文档ID:XXX	流程中已经存在相同的文档id
1437508	文档类型与流程签署类型不匹配	文档的类型是原文但流程指定的签署类型是摘要签或者文档的类型是摘要但流程指定的签署类型是原文签
401		1.token过期了 2.header请求头不正确 3.apiurl和应用ID环境不对应，例如apiurl是模拟环境，应用ID是正式环境的