Skip to main content

回调通知服务

回调说明

目的

合同签署流程中发生发送合同、填写提交、签署、撤回、完成签署等事件时,开放签会向应用的“回调地址”推送相应的事件消息,进行数据的同步。

注意事项

须严格遵照基本要求使用异步通知功能
1.回调地址必须支持http或者https格式;
2.请求类型必须为POST,Content-Type =“application/json”;
3.必须是一个完整的URL(如:https://www.yourdomain.com/message/receiveResult),不能是一个相对路径(/message/receiveResult)。
4.如果确认回调成功,则直接返回字符串"success";
5.重推规则:当未收到"success"时,开放签立即尝试重发3次通知,若3次仍不成功,则后续通知的间隔频率为:30m、2h、24h,24h后不再推送;

回调地址配置

开通应用授权凭证时,提供对应的回调地址; 当合同签署流程中触发回调事件时,关联回调地址的逻辑如下:

  • 合同是通过接口的方式进行创建发起的,则使用创建这份合同的对接方的回调地址进行回调通知;
  • 合同是通过开放签平台手工创建发起的,则使用发起方企业的对接回调地址进行回调通知;

回调参数说明

  • 当事件类型为发起签署、撤回合同、删除合同、完成签署、合同过期、修改签署截止时间时,仅返回contractId、contractStatus、callbackType;
  • 当事件类型为填写、拒填时,不返回nodeType;
  • 当事件类型为签署、拒签、签署失败时返回所有参数;

通知参数

字段ID类型备注
contractIdString合同id
contractStatusString合同状态,见contractStatus表
callbackTypeString通知的事件类型,见下表
taskIdString填写、签署任务的id
signerTypeString签署方类型:
PERSONAL-个人
ENTERPRISE-企业
nodeTypeString签署节点类型:
PERSONAL_SIGN-个人签字
AGENT_SIGN-经办人签字
LEGAL_PERSON_SIGN-法人签字
ENTERPRISE_SEAL-企业签章
signerUser办理人

contractStatus描述

合同状态备注
DRAFT草稿
DELETED已删除
WRITING填写中
REFUSAL_WRITE已拒填
SIGNING签署中
REFUSAL_SIGN已拒签
EXPIRED已失效
RECALLED已撤回
COMPLETED已完成

callbackType描述

回调事件类型备注
SEND_SIGNING发起签署
SUBMIT_WRITE填写
REFUSAL_WRITE拒填
SUBMIT_SIGN签署
REFUSAL_SIGN拒签
RECALLED合同撤销
DELETE删除合同
COMPLETE完成签署
EXPIRED合同过期
SIGN_FAILED签署失败
DOCUMENT_DELAY修改签署截止时间
服务热线
15010993257