其他功能回调
一. 一码多签签署码发起合同失败通知
1. 回调触发时机
用户通过扫描一码多签签署码发起合同时,企业额度不足导致失败
2. 回调消息类型
CreateFlowByQrCode
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
TemplateId | String | 触发回调的模板ID,为32位字符串 |
QrCodeId | String | 触发回调的二维码ID,为32位字符串 |
FlowName | String | 签署二维码生成的合同名称 |
CreateResult | bool | 创建结果,固定为失败-false |
Reason | String | 失败原因,一般是 合同份额为0 |
5. 示例
{
"MsgId": "yDwFdUUckpswdrniUuzcbXw8N43W6Kcz",
"MsgType": "CreateFlowByQrCode",
"MsgVersion": "CustomApp",
"MsgData": {
"TemplateId": "yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR",
"QrCodeId": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS",
"FlowName": "合同名称",
"CreateResult": false,
"Reason": "合同份额为0"
}
}
二. 一码多签签署码发起合同消费通知
1. 回调触发时机
用户通过扫描一码多签签署码成功发起合同时
2. 回调消息类型
MultiFlowSignQrCodeCost
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OrganizationId | String | 企业ID,为32位字符串 |
QrCodeId | String | 触发回调的二维码ID,为32位字符串 |
TemplateId | String | 触发回调的模板ID,为32位字符串 |
Cost | Integer | 此次消耗的二维码额度 |
FlowIds | Array of String | 此次消耗所生成合同的合同编号 |
RemainingQuota | Integer | 此二维码剩余可发合同的额度 |
5. 示例
{
"MsgId":"yASLfUUckptgrp65UuePjukYIZKjWzxG",
"MsgType":"MultiFlowSignQrCodeCost",
"MsgVersion":"CustomApp",
"MsgData":{
"OrganizationId":"yDsjOUUgydjf9zv0UuO4zjED0AKihrfi",
"TemplateId":"yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR",
"QrCodeId":"yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS",
"Cost":1,
"FlowIds":[
"yDSLfUUckptqtbk6UyoABiGuirV05bsO"
],
"RemainingQuota":3
}
}
三. 他方静默签授权通知
1. 回调触发时机
分别在授权待审核、授权通过、授权取消、授权驳回时进行回调通知,模板授权和印章授权都会触发 注:
- 该事件会回调给 授权企业 和 被授权企业
- 如果是集团子企业,会同步回调给集团主企业
2. 回调消息类型
PartnerServerSignAuthorization
3. 其他说明
AuthorizedStatus 枚举:
- 待审核:Reviewing
- 审核通过:Authorized
- 授权取消:Cancel
- 授权驳回:Deny
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
AuthorizationOrganizationId | String | 授权企业的企业ID, 此ID为电子签内部企业标识ID |
AuthorizedOrganizationId | String | 被授权企业的企业ID, 此ID为电子签内部企业标识ID |
AuthorizedStatus | String | 授权状态, 可参考其他说明中的枚举 |
OperateTime | Integer | 授权状态变更时间戳,格式为Unix标准时间戳(秒) |
TemplateId | String | 授权模板ID,如果是授权模板给他方企业,该字段不为空 |
SealIds | Array of String | 授权的印章id数组 |
5. 示例
{
"MsgId": "yDwFxxxxxxxxxxxxxxxxxW6Kcz",
"MsgType": "PartnerServerSignAuthorization",
"MsgVersion": "CustomApp",
"MsgData": {
"AuthorizationOrganizationId": "yDwFdUUckxxxxxxxxxxxxxXw8N43W6Kcz",
"AuthorizedOrganizationId": "yDwFdUUckxxxxxxxxxxxxxXbsvN43W6Kax",
"AuthorizedStatus": "Authorized",
"OperateTime": 1666263716,
"TemplateId":"yDwfsxxxxxxxxxxxxxxxxxxxxvMDW2x",
"SealIds":["yDwfsxxxxxxxxxxxxxxxxxxxxvMs2xb"]
}
}