纸质合同-归档分类

接口描述

该接口支持将开发者平台线下签署的纸质合同上传到e签宝后，归档分类到e签宝SaaS官网进行合同管理。

注意事项：

调用该接口之前必须先调用上传本地文件的两个接口：

1：获取文件上传地址（点击跳转）

先获取到服务端的上传地址fileUploadUrl和文件fileId

2：上传文件流（点击跳转）

再将文件流上传至fileUploadUrl

该接口的文件格式和大小要求：

支持格式pdf、png、jpg、jpeg、doc、docx；单份文件最大30M

接口地址&请求方法

点击下述蓝色字体{host}可跳转至API请求域名说明文档

接口地址：https://{host}/v3/contracts/paper-file-upload

请求方法：POST

请求头格式

具体请求头参数，请查看公共请求头格式。

请求参数

展开全部参数参数名称		参数类型	必选	参数位置	参数说明
fileId		string	是	body	文件ID（已经成功上传至e签宝服务端的fileId）补充说明：调用该接口之前必须先成功调用上传本地文件接口（点击跳转上传本地文件），并确保文件已经上传完成必须是当前企业当前应用appId上传的文件ID 一次调用只能归档分类一份文件，多份文件需要逐一上传获取文件ID，多次调用
contractGroupId		string	是	body	企业合同归档文件夹ID 补充说明：通过e签宝SaaS官网进行设置和复制文件夹ID：登录官网企业空间首页-合同管理-企业合同-已归档合同中新建分类-详情中复制分类ID 归档文件夹ID必须在合同发起方的e签宝官网企业空间下建立
contractName		string	是	body	合同名称（不能超过50个字符）【注】合同名称不允许传入换行、缩进、表情及特殊字符 < > / \\ \| : \ " * ?
contractBizTypeId		string	否	body	合同类型ID 补充说明：通过e签宝SaaS官网进行设置和复制ID：登录官网企业空间首页-合同管理-智能台账-合同类型中设置（点击这里了解更多智能台账功能）合同类型ID必须在合同发起方的e签宝官网企业空间下建立
contractNum		string	否	body	合同编号（不能超过50个字符）【注】只能传入字母、数字、横杠-和下划线_
contractExpiryDate		string	否	body	合同到期时间【注】需要按照yyyy-MM-dd的格式传入
signers		array	否	body	签署方信息
	orgName	string	否	body	企业签署方名称（不能超过100个字符）补充说明：若传入此参数，则认为是企业签署方，不传则认为是个人签署方若传入此参数，则下方企业经办人姓名和联系方式都必须传入
	psnName	string	否	body	个人签署方姓名/企业签署方经办人姓名（不能超过50个字符）【注】如传入此参数，则下方个人联系方式必须传入
	psnAccount	string	否	body	个人签署方联系方式/企业签署方经办人联系方式【注】需符合大陆手机号或邮箱格式

响应参数

展开全部参数参数名称		参数类型	必选	参数说明
code		int32	是	业务码，0表示成功，非0表示异常。
message		string	否	业务信息请根据 code 来判断错误情况，不应该依赖 message 匹配，因为 message 可能会调整。
data（点击“+”展开详情）		object	否	业务数据
	fileId	string	否	文件ID（跟入参里的fileId是同一个文件ID）
	contractBizId	string	否	纸质合同业务ID （每个fileId产生的contractBizId不同）【注】业务ID可以标识本次调用唯一性，无其他业务用途

请求示例

{
    "fileId": "19541dcb71******5364c4f1299",
    "contractGroupId": "2d265008b*******883ee9e",
    "contractName":"合同名称1030",
    "contractNum":"jilin00001",
    "contractBizTypeId":"13997af*****b80eb11"
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "fileId": "19541dc******64c4f1299",
        "contractBizId": "ee50342d******78e284284"
    }
}

错误码

code 错误码	message 错误信息
30802001	当前应用下不存在此fileId
30802002	系统错误，请稍后重试
30802003	该文件未上传完成，请稍后重试
30802004	文件格式不符合要求：%s
30802005	文件大小不能超过%sM
30802006	该文件已经上传过，请勿重复上传
30802007	contractGroupId：%s不属于当前企业
30802008	contractBizTypeId：%s不属于当前企业
10000001	合同类型不存在或已删除
31300001	合同名称不能为空
31300001	归档文件夹id不能为空
31300001	文件id不能为空
31300001	个人签署方名称不能为空
31300001	个人签署方联系方式不能为空
31300001	参数错误：合同名称不能超过50位
31300001	参数错误：合同编号不能超过50位
31300001	参数错误：企业签署方名称不能超过100位
31300001	参数错误：个人签署方名称不能超过50位
31300001	参数错误：contractExpiryDate格式不符合要求
31300001	参数错误：psnAccount需符合大陆手机号和邮箱格式
31300001	参数错误：合同编号只能传入字母、数字、横杠-和下划线_
31300001	参数错误：合同名称不支持特殊字符