文档变更
2022年时，流程文档添加变为追加待签文件，以便开发者更容易理解，仅中文名称变更，其功能保持不变。
接口描述
调用此接口可以向已创建的签署流程中追加待签署文件。
注：
（1）已开启的签署流程不允许追加待签署文件，即发起签署时 autoInitiate 参数值为true（自动开启）时，不允许追加待签署文件。
（2）文件需先通过【上传待签文件】上传获取 fileId 后才可以追加到签署流程中。
（3）文件名称不可以含有以下9个特殊字符：/ \ : * " < > | ？以及所有emoji表情。
（4）单个签署流程中对待签署文件大小要求如下：
4.1 单个签署流程中所添加的文件大小总和不要超过 500 MB。
4.2 单个签署流程中所添加的文件个数不超过50个。
4.3 单个文件大小不要超过 20 MB。
4.4 单个文件内单页大小不要超过 9 MB。文件内含图片时，需特别关注单页大小。
（5）单个签署流程中所添加的签章区总和不要超过 300 个。
（6）追加的待签署文件，也将会按计费规则扣除合同份额。
（7）此接口所追加的文件需要签署方签章，若仅需签署方阅读而不签章，建议以附件形式添加，详见【追加附属材料】。
接口地址&请求方式
接口地址：/v1/signflows/{flowId}/documents
请求方式：POST
请求头格式
具体请求头格式结构，请点击查看公共参数说明。
请求参数
展开全部参数参数名称 | 类型 | 必选 | 参数类型 | 参数说明 （左右拖动查看完整描述） | |
flowId | string | 是 | path | 签署流程ID | |
docs | array | 是 | body | 文档列表数据 | |
fileId | string | 是 | body | 文件ID 可通过【上传本地文件】上传待签署文件获取fileId。 | |
fileName | string | 否 | body | 文件名称（含扩展名，如合同.pdf） 注意： （1）文件名称必须包含文件扩展名，否则后续发起签署时无法通过校验。 （2）文件扩展名必须与实际文件类型一致，否则后续签署会出现异常。例如： 实际文件类型是PDF，请填写XX.pdf而不是xx.docx。 （3）文件名称不支持以下9个字符： / \ : * " < > | ? | |
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是正式环境的 |
我要纠错