其他功能回调
一. 签署二维码发起合同失败通知
1. 回调触发时机
用户通过签署二维码发起合同时,企业额度不足导致失败
2. 回调消息类型
CreateFlowByQrCode
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
ApplicationId | String | 第三方应用的应用编号 |
ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
ProxyOperatorOpenId | String | 如果第三方子企业员工签署, 此字段为第三方子企业员工的唯一标识 |
TemplateId | String | 触发回调的模板ID,为32位字符串 |
QrCodeId | String | 触发回调的模板ID,为32位字符串 |
FlowName | String | 签署二维码生成的合同名称 |
CreateResult | bool | 创建结果,固定为失败-false |
Reason | String | 失败原因,一般是 合同份额为0 |
5. 示例
{
"MsgId": "yDwFdUUckpswdrniUuzcbXw8N43W6Kcz",
"MsgType": "CreateFlowByQrCode",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "c17bdf9c2a7bdcb32611f4d0200fef3d",
"ProxyOrganizationOpenId": "00498cc8500be9cxxxxxxx3aff766cac",
"ProxyOperatorOpenId": "d7c13a8b81340cce9e3968c0ee248f04",
"TemplateId": "yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR",
"QrCodeId": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS",
"FlowName": "合同名称",
"CreateResult": false,
"Reason": "合同份额为0"
}
}
二. 签署二维码发起合同消费通知
1. 回调触发时机
用户通过扫描签署二维码发起合同
2. 回调消息类型
MultiFlowSignQrCodeCost
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
ApplicationId | String | 第三方应用的应用编号 |
ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
QrCodeId | String | 触发回调的二维码ID,为32位字符串 |
TemplateId | String | 触发回调的模板ID,为32位字符串 |
Cost | Integer | 此次消耗的二维码额度 |
FlowIds | Array of String | 此次消耗所生成合同的合同编号 |
RemainingQuota | Integer | 此二维码剩余可发合同的额度 |
5. 示例
{
"MsgId":"yDSLfUUckptgrp16UuePjuk1s58WpHmC",
"MsgType":"MultiFlowSignQrCodeCost",
"MsgVersion":"ThirdPartyApp",
"MsgData":{
"ApplicationId": "yDwFUckpstzjhfUugNAWf1KibXqS96",
"ProxyOrganizationOpenId": "org_dianziqian",
"TemplateId":"yFRvzUUgygqj45ouUuO4zjEueBrK5MeV",
"QrCodeId":"yDQLfUUckptgtd55UDllrES1idtv1RHB",
"Cost":1,
"FlowIds":[
"yDSLfUUckptgtbbfUyoABiGw6mK22tFm"
],
"RemainingQuota":3
}
}
三. 他方自动签授权/子客授权平台通知
1. 回调触发时机
分别在授权待审核、授权通过、授权取消、授权驳回时进行回调通知
2. 回调消息类型
PartnerServerSignAuthorization
3. 其他说明
AuthorizedStatus 枚举:
- 待审核:Reviewing
- 审核通过:Authorized
- 授权取消:Cancel
- 授权驳回:Deny
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
AuthorizationApplicationId | String | 第三方应用的应用编号 |
AuthorizationOrganizationId | String | 授权子客企业的企业ID, 此ID为电子签内部企业标识ID |
AuthorizationOrganizationOpenId | String | 授权子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
AuthorizedOrganizationId | String | 被授权子客企业的企业ID, 此ID为电子签内部企业标识ID |
AuthorizedOrganizationOpenId | String | 被授权子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样;如果是子客授权给平台,该参数为平台企业的Uin |
AuthorizedStatus | String | 授权状态, 可参考其他说明中的枚举 |
OperateTime | Integer | 授权状态变更时间戳,格式为Unix标准时间戳(秒) |
TemplateId | String | 暂未使用 |
SealIds | Array of String | 授权的印章id数组 |
5. 示例
{
"MsgId": "yDwFdUUckpswdrniUuzcbXw8N43W6Kcz",
"MsgType": "PartnerServerSignAuthorization",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"AuthorizationApplicationId": "c17bdf9c2a7bdcb32611f4d0200fef3d",
"AuthorizationOrganizationId": "yDwFdUUckxxxxxxxxxxxxxXw8N43W6Kcz",
"AuthorizationOrganizationOpenId": "00498cc8500be9cxxxxxxx3aff766cac",
"AuthorizedOrganizationId": "yDwFdUUckxxxxxxxxxxxxxXbsvN43W6Kax",
"AuthorizedOrganizationOpenId": "0049xxxxxxxxxcxxxxxxx3aff766cac",
"AuthorizedStatus": "Reviewing",
"SealIds":["yDwFdU*********43W6Kcz"],
"OperateTime": 1666263716
}
}