流程附件添加

更新时间:2022-06-16 17:09:46

接口描述

为流程添加附件, 附件必须先用文档管理接口创建,附件无需签署,只作为签署过程中的参考,比如录音、视频, 图片, 文档等。

注:因Windows操作系统中文件名称不支持个别特殊字符,现调整attachmentName字段不支持以下9个字符

/ \ : * " < > | ?以及所有emoji表情,详见文件名称特殊字符限制

点击查看具体更新日志

接口

/v1/signflows/{flowId}/attachments

请求方式

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该参数需放在请求地址里面,可以参考【请求示例】

attachments

array

body

附件列表数据



attachmentName

string

body

附件名称,(必须带上文件扩展名,不然会导致后续发起流程校验过不去 示例:合同.pdf );

注意:

(1)该字段的文件后缀名称和真实的文件后缀需要一致。比如上传的文件类型是word文件,那该参数需要传“xxx.docx”,不能是“xxx.pdf”

(2)文件名称不支持以下9个字符:

/ \ : * " < > | ?

fileId

string

body

附件Id

公共响应参数

参数名称

类型

必选

参数说明

code

int

业务码,0表示成功

message

string

信息

data

object

业务信息

请求示例  

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


{
    "attachments":[
        {
            "attachmentName":"第一份附件.pdf",
            "fileId":"97913b341a0142e08aef061c6ccae5da"
        }
    ]
}

响应示例

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

错误码

错误码

错误描述

解决方案

1437402

流程已结束,不允许添加附件

已经完结的流程不能再添加附件

1437403

附件ID重复

添加的附件列表中存在相同的附件id

1437404

流程已添加附件ID:XXX

流程中已存在相同的附件id


我要纠错