异步通知服务
回调说明
目的
注意事项
须严格遵照基本要求使用异步通知功能:
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 | 类型 | 备注 |
---|---|---|
contractId | String | 合同id |
contractStatus | String | 合同状态,见contractStatus表 |
callbackType | String | 通知的事件类型,见下表 |
taskId | String | 填写、签署任务的id |
signerType | String | 签署方类型: PERSONAL-个人 ENTERPRISE-企业 |
nodeType | String | 签署节点类型: PERSONAL_SIGN-个人签字 AGENT_SIGN-经办人签字 LEGAL_PERSON_SIGN-法人签字 ENTERPRISE_SEAL-企业签章 |
signer | User | 办理人 |
合同状态 | 备注 |
---|---|
DRAFT | 草稿 |
DELETED | 已删除 |
WRITING | 填写中 |
REFUSAL_WRITE | 已拒填 |
SIGNING | 签署中 |
REFUSAL_SIGN | 已拒签 |
EXPIRED | 已失效 |
RECALLED | 已撤回 |
COMPLETED | 已完成 |
回调事件类型 | 备注 |
---|---|
SEND_SIGNING | 发起签署 |
SUBMIT_WRITE | 填写 |
REFUSAL_WRITE | 拒填 |
SUBMIT_SIGN | 签署 |
REFUSAL_SIGN | 拒签 |
RECALLED | 合同撤销 |
DELETE | 删除合同 |
COMPLETE | 完成签署 |
EXPIRED | 合同过期 |
SIGN_FAILED | 签署失败 |
DOCUMENT_DELAY | 修改签署截止时间 |