API最新动态

发布日期

发布事项

内容简介

2025年2月28日

新增【发起合同解约】接口新增请求参数

新增请求参数：

• signFlowExpireTime（解约流程签署截止时间）

2025年2月28日

新增【基于文件发起签署】、【通过页面发起签署】新增请求参数

新增请求参数：

• uneditableFields（实名时不可修改的信息字段）

2025年2月21日

新增【基于文件发起签署】、【通过页面发起签署】新增请求参数

新增请求参数：

• initialRemarks（合同备注信息）

2025年2月14日

新增【基于文件发起签署】、【追加签署区】新增请求参数

新增请求参数：

• fileOrder （附件展示顺序）

发布日期

发布事项

内容简介

2025年1月17日

新增【获取批量签页面链接（多流程）】接口新增响应参数及功能

新增响应参数：

• batchSerialId （批量签署批次号）

新增功能：

• 一次最多签署流程数从10改成1000，当流程数超过100时走异步签署，新增批量签署结果回调通知

发布日期

发布事项

内容简介

2024年12月23日

新增【基于文件发起签署】、【追加签署区】与【通过页面发起签署】新增请求参数枚举值

新增请求参数枚举值：

• noticeTypes （通知类型）新增枚举值：

6 - 企业微信通知（需要使用e签宝企微版产品）

7 - 飞书通知（需要使用e签宝飞书版产品）

2024年12月6日

新增【基于文件发起签署】与【追加签署区】接口新增请求参数

新增请求参数：

• willingnessAuthModes 新增枚举值：PSN_AUDIO_VIDEO_ESIGN（H5智能视频认证（新版））
• audioVideoActiveField（H5智能视频认证（新版）文案中的动态朗读内容）

发布日期

发布事项

内容简介

2024年10月25日

新增【查询合同模板中控件详情】接口新增响应参数

新增响应参数：

• componentMaxRows（多行文本控件可以填充的行数上限）
• componentTextFormat（控件字符样式）-对象内包含多个字段

发布日期

发布事项

内容简介

2024年8月29日

变更【基于文件发起签署】接口与【追加签署区】接口修改请求参数是否必选

新增请求参数枚举值：

• psnName（个人姓名/经办人姓名）修改为必传项

（传psnAccount（个人账号标识）时，该参数为必传项）

2024年8月2日

新增【基于文件发起签署】接口与【通过页面发起签署】新增请求参数

新增请求参数：

• allowToRescind（该签署流程是否允许发起解约）

发布日期

发布事项

内容简介

2024年7月10日

新增【基于文件发起签署】接口与【追加签署区】与【通过页面发起签署】新增请求参数

新增请求参数枚举值：

• noticeTypes（通知类型）新增枚举值：

3 - 钉钉工作通知（需使用e签宝钉签产品）

5 - 微信通知（用户需关注“e签宝电子签名”微信公众号且使用过e签宝微信小程序）

2024年7月5日

新增【获取拖章定位页面】接口

发起签署接口的辅助定位

2024年7月5日

新增【获取批量签页面链接（多流程）】接口新增请求参数

新增请求参数：

• appScheme（AppScheme，用于唤起App）

2024年7月1日

新增【导出合同模板】接口

在沙箱模拟环境下，导出合同文件模板数据。

2024年7月1日

新增【导入合同模板】接口

导入合同文件模板数据，相当于在当前环境、当前appId下生成新的模板。

发布日期

发布事项

内容简介

2024年6月7日

新增【基于文件发起签署】接口新增请求参数

新增请求参数：

• contractSecrecy（合同保密配置）

发布日期

发布事项

内容简介

2024年5月16日

新增【获取预览合同模板页面】接口

合同模板类API 分组下新增【获取预览合同模板页面】接口

2024年5月9日

新增【复制合同模板】接口新增请求参数

新增请求参数：

• renameDocTemplate（重命名模板名称）

发布日期

发布事项

内容简介

2024年4月25日

新增【查询填写合同模板任务结果】接口

合同模板类API 分组下新增【查询填写合同模板任务结果】接口

2024年4月25日

新增【获取填写合同模板页面】接口新增响应参数

新增响应参数：

• fillTaskId（填写任务ID）

2024年4月25日

新增【发起合同解约】接口新增请求参数

新增请求参数：

• psnSealStyles（页面可选个人印章样式）

2024年4月12日

新增【创建控件组】、【编辑控件组】接口新增请求参数，【查询控件组列表】接口新增响应参数

新增请求/响应参数：

• componentGroupOrder（控件组展示顺序）

2024年4月12日

新增【基于文件发起签署】与【追加签署区】接口新增请求参数

新增请求参数：

• docsViewLimited（是否开启签署方的文件查看范围限制）
• docsViewType（签署方可见文件类型）
• viewableFileIds（指定签署方允许查看的文件id列表）

发布日期

发布事项

内容简介

2024年3月29日

新增【创建自定义业务控件】、【编辑自定义业务控件】、【查询自定义业务控件列表】接口新增请求参数

新增请求参数：

• customBizNum（自定义业务编码）

2024年3月29日

新增【获取文件上传地址】、【基于文件发起签署】、【查询签署流程详情】

新增请求/响应参数：

• dedicatedCloudId（专属云项目ID）

2024年3月14日

新增【基于文件发起签署】与【追加签署区】接口新增请求参数

新增请求参数：

• agreeSkipWillingness（签署人是否需要免意愿快捷签署，默认false）

2024年3月5日

新增【创建自定义业务控件】与【查询自定义业务控件列表】接口新增请求参数枚举值

新增请求参数枚举值：

• numberFormat（数字格式（数字控件））：ANY（通用数字）

2024年3月1日

新增【基于文件发起签署】与【追加待签文件】接口新增请求参数

新增请求参数：

• order（文件在签署页面的展示顺序）

发布日期

发布事项

内容简介

2024年2月2日

新增【基于文件发起签署】与【追加签署区】接口新增请求参数

新增请求参数：

• signMode（签署模式：NORMAL - 中国大陆签，GLOBAL - 海外签）
• authConfig（签署方纬度认证配置项）对象内6个参数

2024年2月2日

新增【下载已签署文件及附属材料】接口新增响应参数

新增响应参数：

• certificateDownloadUrl（海外签证书报告下载地址）

2024年2月2日

新增【查询签署流程详情】接口响应参数

新增响应参数：

• signMode（签署模式：NORMAL - 中国大陆签，GLOBAL - 海外签）

2024年2月1日

新增【查询签署流程详情】接口响应参数

新增响应参数：

• sealApprovalFlowId（关联的用印审批流程ID）

2024年2月1日

新增【获取用印审批页面链接】、【查询审批流程详情】、【查询审批流程列表】3个接口

新增签署流程-审批类分组，和分组内3个新接口

2024年2月1日

新增【回调通知服务】新增审批类5个回调通知

新增5个审批类通知事件

发布日期

发布事项

内容简介

2024年1月19日

新增【重命名控件组】接口

自定义模板业务控件API-新增接口

2024年1月19日

新增【基于文件发起签署】接口与【追加签署区】新增参数枚举值

新增请求参数枚举值：

• dateSignFieldConfig（独立签署日期配置项）新增dateFormat（日期格式）：yyyy年M月d日、yyyy年M月、yyyy/M/d、yy-MM-dd

2024年1月19日

新增【基于文件发起签署】接口与【追加签署区】与【通过页面发起签署】新增请求参数

新增请求参数枚举值：

• signerType（签署方类型）新增枚举值：3 - 经办人签

2024年1月19日

新增【查询签署流程详情】接口响应参数

新增响应参数：

• signFieldSealType（签署区用印类型）

2024年1月4日

新增【基于文件发起签署】接口与【追加签署区】新增参数

新增请求参数：

• autoSign（是否是后台自动落章关联的独立签署日期，默认值 false）

发布日期

发布事项

内容简介

2023年12月22日

优化【查询签署流程列表】、【查询集成方企业流程列表】优化逻辑

优化逻辑：

• 查询时间段从90天提升到1年

2023年12月11日

新增【基于文件发起签署】、【追加签署区】与【通过页面发起签署】新增请求参数

新增请求参数：

• signFieldWidth（签署区宽度（矩形的左右边距距离，单位为px））
• signFieldHeight（签署区高度（矩形的上下边距距离，单位为px））

2023年12月11日

新增【查询合同模板中控件详情】接口新增响应参数

新增响应参数：

• sealSpecs（落章规则）

发布日期

发布事项

内容简介

2023年11月27日

新增【基于文件发起签署】接口与【追加签署区】新增参数枚举值

新增请求参数枚举值：

• dateSignFieldConfig（独立签署日期配置项）新增dateFormat（日期格式）：yyyy.MM.dd

2023年11月9日

新增【通过页面发起签署】接口新增请求参数

新增请求参数：

• signTipsTitle（签署前提示弹框自定义签署声明--文案标题）
• signTipsContent（签署前提示弹框自定义签署声明--文案内容）

发布日期

发布事项

内容简介

2023年10月31日

新增【查询签署流程详情】接口响应参数

新增响应参数：

• contractBizTypeId（合同类型ID）
• contractGroupIds（企业合同归档文件夹ID）
• dateSignFieldConfig（独立签署日期配置项）
• signFieldType 新增新的枚举类型：2 - 独立签署日期（添加单独的签署日期）

2023年10月31日

新增【基于文件发起签署】接口新增请求参数

新增请求参数：

• contractBizTypeId（合同类型ID）
• contractGroupIds（企业合同归档文件夹ID）

2023年10月31日

新增【追加待签文件】接口新增请求

新增请求参数：

• contractBizTypeId（合同类型ID）

2023年10月27日

新增【下载签署中文件】接口

新增接口：

通过该接口可以下载流程正在签署中的文件进行预览查看

2023年10月27日

新增【查询集成方企业流程列表】接口新增请求参数

新增请求参数：

• signFlowFinishTimeFrom（开始时间（完结签署流程时间））
• signFlowFinishTimeTo（ 结束时间（完结签署流程时间））

2023年10月27日

新增【查询签署流程列表】接口新增请求和响应参数

新增请求参数：

• signFlowFinishTimeFrom（开始时间（完结签署流程时间））
• signFlowFinishTimeTo（ 结束时间（完结签署流程时间））
• signStatus（ 签署人的签署状态）

新增响应参数：

• signOrder（签署顺序）
• signStatus（签署人的签署状态）

2023年10月16日

新增【基于文件发起签署】接口与【追加签署区】新增请求参数

新增请求参数：

• dateSignFieldConfig（独立签署日期配置项）
• signFieldType 新增新的枚举类型：2 - 独立签署日期（添加单独的签署日期）

2023年10月16日

新增【获取编辑合同模板页面】接口新增签署方角色标识字段

新增请求参数：

• signerRoles（签署方角色标识）

发布日期

发布事项

内容简介

2023年9月26日

新增【基于文件发起签署】接口与【追加签署区】新增请求参数

新增请求参数：

• uploadFiles（允许签署方在签署时上传的附件列表配置）

2023年9月25日

新增【通过页面发起签署】接口新增请求参数

新增请求参数：

• orgSealType（页面中新增企业签署方时展示哪些企业签章类型）

发布日期

发布事项

内容简介

2023年8月28日

新增文件类API和合同模板类API模块

将原本导航栏中 文件和模板服务API 3.0 中的文件类API和合同模板类API挪到当前 合同文件签署服务API 3.0 模块

2023年8月28日

新增【获取制作合同模板页面】、【查询合同模板中控件详情】接口新增签署方角色标识字段

【获取制作合同模板页面】新增请求参数：

• signerRoles（签署方角色标识）

【查询合同模板中控件详情】新增响应参数：

• signerRole（签署方角色标识）

2023年8月28日

新增【申请出证】接口新增报告类型

新增请求参数：

• reportType（出证报告类型 ）

2023年8月11日

新增【通过页面发起签署】接口新增请求参数

新增请求参数：

• signerRole（签署方角色标识）

2023年8月11日

新增【发起合同解约】接口新增请求参数

新增请求参数：

signConfig（签署配置项）

• availableSignClientTypes（签署终端类型）

2023年8月3日

新增【获取制作合同模板页面】、【获取编辑合同模板页面】接口新增是否展示替换底稿按钮参数

新增请求入参：

• showReplaceFraft（是否展示替换底稿按钮，默认值 false）

发布日期

发布事项

内容简介

2023年7月31日

新增【发起合同解约】接口新增请求参数

新增请求参数：

• autoSignOrg（指定本次解约使用自动签署的机构签署方）

2023年7月17日

新增【查询签署流程详情】接口新增响应参数

新增响应参数：

• contractNum（合同编号）
• signTaskType（签署任务类型）
• signerUpload（是否为签署方上传的附件）
• uploadFiles（签署方在签署时上传的附件列表信息）

2023年7月17日

新增【基于文件发起签署】接口与【追加签署区】新增请求参数

新增请求参数：

• uploadFiles（允许签署方在签署时上传的附件列表配置）

发布日期

发布事项

内容简介

2023年6月30日

新增【基于文件发起签署】接口与【追加签署区】新增请求参数

新增2个请求参数：

• signTaskType（签署任务类型，默认值为 0）

0 - 会签（所有指定的签署方均必须签署）

1 - 或签（多个签署方中，任意一方签署即可完成签署流程）

• mustSign（该签署区是否必须签署，默认值为 true）

true - 是

false - 否

2023年6月30日

新增【查询签署流程详情】接口新增响应参数

新增响应参数：

• sealOwnerId（印章归属方用户账号ID）

2023年6月30日

新增【延长签署截止时间】接口逻辑新增

允许延期已过期的签署流程：

• 支持对已过期的流程进行延期，流程只能延期一次（之前延期过就不能延期了），延期时间的上限是从当前时间开始往后算90天，而不是从原流程的截止时间往后算。

2023年6月16日

变更【通过页面发起合同解约】接口名变更

变更接口名：

由原名“获取合同解约链接”更名为“通过页面发起合同解约”

2023年6月16日

新增【发起合同解约】接口

新增接口：

增加纯接口发起合同解约（无页面发起）

2023年6月16日

新增【获取制作合同模板页面】、【获取编辑合同模板页面】接口新增基础控件展示列表控制参数

新增请求入参：

• basicComponentsType（要展示的基础控件类型列表）

2023年6月2日

新增【撤销签署流程】接口新增请求参数：撤销原因

新增请求参数：

• revokeReason（撤销原因）

2023年6月1日

新增【通过页面发起签署】接口新增请求参数枚举值：禁用签署方在页面追加签署区

新增uneditableFields参数枚举值：

• signFields-追加签署区（禁用签署方在页面追加签署区）

发布日期

发布事项

内容简介

2023年5月19日

新增【查询签署流程详情】接口新增响应参数：发起方和签署人的名字

新增响应参数：

psnName（个人姓名）、orgName（企业名字）

2023年5月19日

新增【通过页面发起签署】接口新增请求参数：重定向跳转延迟时间

新增请求参数：

redirectDelayTime（操作完成重定向跳转延迟时间，单位秒（可选值0、3，默认值为 3））

2023年5月6日

新增【申请出证】接口与【查询出证流程详情】接口

新增接口：

增加两个接口，新增接口来做合同出证服务

发布日期

发布事项

内容简介

2023年4月13日

变更【基于文件发起签署】与【通过页面发起签署】接口认证方式中e签宝刷脸命名变更

变更字段命名：

• willingnessAuthModes 中 PSN_FACE_ESIGN字段 命名从e签宝刷脸命名变更为快捷刷脸

• 2023/04/13-e签宝刷脸服务升级通知

发布日期

发布事项

内容简介

2023年3月31日

新增【基于文件发起签署】接口与【追加签署区】接口新增请求参数新增签署前提示弹框自定义签署声明相关字段

新增参数：

• signTipsTitle（签署前提示弹框自定义签署声明--文案标题）
• signTipsContent（签署前提示弹框自定义签署声明--文案内容）

2023年3月23日

新增【通过页面发起签署】接口新增uneditableFields参数，控制禁止用户在页面上编辑的内容

新增参数：uneditableFields（禁止用户在页面上修改或追加的内容）

• signFlowTitle-签署流程标题（禁用文本框）
• docs-待签文件（隐藏添加签署文件按钮）
• signers-签署方（隐藏签署方区域的添加企业和添加个人按钮）
• signFlowExpireTime-签署截止时间（禁用时间选择框）
• copiers-抄送方（隐藏抄送方区域的添加企业和添加个人按钮）
• attachments-附件（隐藏添加附件按钮）

2023年3月23日

新增【通过页面发起签署】接口新增签署区非必填逻辑

新增逻辑：signFields改为非必填

允许传入签署人signers时不传签署区signFields，用户可以自主在页面拖章，确定签章位置

2023年3月22日

新增【获取填写合同模板页面】接口新增支持PDF模板类型

填写合同模板原来只支持 HTML 模板类型，现新增支持 PDF 模板类型。

2023年3月20日

新增【检索文件关键字坐标】接口新增POST请求方式

新增POST请求方式，原有GET请求方式仍然保留

发布日期

发布事项

内容简介

2023年2月23日

新增【获取合同解约链接】接口新增支持原流程发起方发起解约逻辑

新增逻辑：rescissionInitiator（合同解约发起方信息）支持原流程的发起方发起解约流程

原描述：

• 仅原流程中的签署方可以发起解约；

修改后：

• 仅原流程中的签署方或发起方可以发起解约；

2023年2月9日

新增【通过页面发起签署】接口增加发起签署页面长链接返回

新增响应参数：

signFlowInitiateLongUrl（发起签署页面长链接）

2023年2月9日

新增【获取合同解约链接】接口增加指定客户端类型参数

新增请求参数：

clientType（指定客户端类型）

发布日期

发布事项

内容简介

2022年12月22日

新增【查询签署流程列表】接口增加查询的签署流程状态

新增请求参数枚举值：signFlowStatus（流程状态）新增三个查询状态：

• 3 - 撤销
• 5 - 过期（签署截至日期到期后触发）
• 7 - 拒签

2022年12月8日

新增【查询签署流程列表】接口增加根据发起方信息查询

新增请求参数：initiator（签署流程的发起方）

2022年12月8日

新增【核验合同文件签名有效性】接口增加证书信息返回

新增响应参数：certBase64（证书信息（base64编码））

2022年12月8日

新增【获取填写合同模板页面】接口新增模板控件预填内容功能

• 增加请求参数 componentFillingtValues （模板控件预填内容列表）。
• 增加请求参数 editFillingValue （用户填写页面是否可以修改预填内容）

发布日期

发布事项

内容简介

2022年11月22日

新增【基于文件发起签署】接口增加身份校验配置项

新增请求参数：identityVerify（身份校验配置项）

2022年11月11日

新增【查询文件上传状态】接口文件首页的长宽值相关参数。

• 增加请求参数 pageSize （是否返回文件首页的长宽值）；
• 增加响应参数 pageWidth （首页宽度）；
• 增加响应参数 pageHeight （首页高度）。

2022年11月11日

新增【查询合同模板中控件详情】接口返回自定义控件id参数。

增加响应参数 originCustomComponentId （自定义控件id）。

发布日期

发布事项

内容简介

2022年10月12日

新增【获取填写合同模板页面】接口。

新增【通过页面填写模板（仅限HTML模板）】分组，分组下新增【获取填写合同模板页面】接口。

发布日期

发布事项

内容简介

2022年9月28日

新增【基于文件发起签署】接口，签章日期格式支持“时分秒”

dateFormat新增参数值：yyyy-MM-dd HH:mm:ss

2022年9月23日

新增【基于文件发起签署】接口支持传入视频双录模板ID

文档新增参数：audioVideoTemplateId

2022年9月19日

新增【获取制作合同模板页面】、【获取编辑合同模板页面】接口自定义控件相关参数。

• 增加请求参数hiddenOriginComponents（是否隐藏原始控件），制作模板页面允许隐藏e签宝提供的原始控件；
• 增加请求参数customComponentGroups（自定义控件组id列表），用于展示用户自定义的控件组；
• 增加请求参数customComponents（自定义控件id列表），用于展示用户自定义的控件；

使用详情可咨询e签宝交付顾问。

2022年9月15日

新增【基于文件发起签署】接口增加法定代表人签署方式

签署方类型：signerType新增参数值 2，支持签署方式指定为法定代表人。

• 在调用之前需确保企业已创建“法人印章”，请登录e签宝官网创建法人印章；
• 若指定signerType为2，则orgSignerInfo企业信息为必传项；
• orgSignerInfo中经办人信息transactorInfo允许指定企业成员，企业成员在使用法人印章签署时，默认会触发用印审批。

2022年9月7日

新增【通过页面发起签署】新API接口发布

发起签署流程，提供开放页面版功能，支持开发者将此页面集成到业务系统，使用户在可视化的页面中操作发起签署流程。

2022年9月7日

新增回调通知【页面发起签署通知】

用户通过页面发起签署流程成功后，开发者将收到此通知。