接口描述
调用此接口可以向草稿状态的签署流程中追加待签署文件（仅限流程开启之前允许追加）。
注意事项：
（1）已开启或自动开启的签署流程不允许追加待签文件，即发起签署时autoStart参数值为 true（自动开启）。
（2）本地文件需先经过【上传本地文件】至e签宝服务端，或通过【填写模板生成文件】/【获取填写合同模板页面】制作填充的文件才可被添加到签署流程中。
（3）文件名称不可以含有以下9个特殊字符：/ \ : * " < > | ？以及所有emoji表情。
（4）单个签署流程中对签署文件要求如下：
4.1 单个签署流程中所添加的文件大小总和不要超过 500 MB。
4.2 单个签署流程中所添加的文件个数不超过50个。
4.3 单个文件大小不要超过 20 MB。
4.4 单个文件内单页大小不要超过 9 MB。文件内含图片时，需特别关注单页大小。
（5）追加的待签署文件，也将会按计费规则扣除合同份额。
（6）此接口所追加的文件需要签署方签章，若仅需签署方阅读而不签章，建议以附属材料形式添加，详见【追加附属材料】。
接口地址&请求方法
接口地址：https://{host}/v3/sign-flow/{signFlowId}/unsigned-files
请求方法：POST
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 | |
signFlowId | string | 是 | path | 签署流程ID | |
unsignedFiles（点击“+”展开详情） | array | 是 | body | 追加待签署文件列表 | |
fileId | string | 是 | body | 待签署文件ID | |
fileName | string | 否 | body | 待签署文件名称（含扩展名，如合同.pdf） 补充说明： （1）文件名称必须包含文件扩展名，否则后续发起签署时无法通过校验。 （2）文件扩展名必须与实际文件类型一致，否则后续签署会出现异常。例如： 实际文件类型是PDF，请填写XX.pdf而不是xx.docx。 （3）文件名称不支持以下9个字符： / \ : * " < > | ? | |
neededPwd | int32 | 否 | body | 是否需要密码 0 - 不需要，1 - 需要，默认值为0 查看PDF编辑密码描述 （1）设置编辑密码的PDF文件需要输入密码才有权限进行盖章操作。 （2）neededPwd填写1时，同时需要向fileEditPwd参数填写编辑密码。 （3）支持自动盖章场景。 （4）不支持手动盖章场景。 | |
fileEditPwd | string | 否 | body | 文档编辑密码 当neededPwd值为1时, fileEditPwd值必须填写。 当neededPwd值为0时, fileEditPwd值允许为空。 | |
contractBizTypeId | string | 否 | body | 合同类型ID 补充说明： | |
order | int | 否 | body | 文件在签署页面的展示顺序
| |
响应参数
参数名称 | 参数类型 | 必选 | 参数说明 | ||||
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖 message匹配，因为 message 可能会调整。 | ||||
data | object | 否 | 业务数据 | ||||
请求示例
POST https://openapi.esign.cn/v3/sign-flow/0b7e49**dfbc10bb1/unsigned-files
{
"unsignedFiles": [
{
"fileId": "ea3151a8d***a53d3f4c",
"fileName": "入职证明.pdf"
}
]
}响应示例
{
"code": 0,
"message": "成功",
"data": null
}
我要纠错