跳到主要内容

费用相关回调

一. 扣费回调通知

1. 回调触发时机

在企业计费套餐扣费或者撤销成功之后进行回调

2. 回调消息类型

BillingUse

3. 其他说明

会出现回调的扣费套餐类型

套餐名称对应QuotaType
企业版合同CloudEnterprise
单方签章SingleSignature
签署报告CloudProve
腾讯会议在线签约CloudOnlineSign
微工卡ChannelWeCard
合同套餐SignFlow
签署意愿(人脸识别)SignFace
签署意愿(密码)SignPassword
签署意愿(短信)SignSMS
签署人实名(腾讯电子签认证)PersonalEssAuth
签署人实名(信任第三方认证)PersonalThirdAuth
签署企业实名OrgEssAuth
短信通知FlowNotify
企业工商信息查询AuthService

4. 回调结构体

MsgData结构体定义

参数名称参数类型参数描述
ApplicationIdString第三方应用的应用编号
ProxyOrganizationOpenIdString第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体
FlowIdString合同流程ID,为32位字符串
FlowNameString合同流程的名称
CreateOrganizationNameString发起扣费的组织机构名称
QuotaTypeString消耗的套餐类型, 具体含义可以参考上述其他说明中的 会出现回调的扣费套餐
UseCountInteger此次扣费行为消耗的份额, 如果为负值则为份额退还
CostTimeInteger消耗的时间戳,格式为Unix标准时间戳(秒)。
QuotaNameString消耗的套餐产品名称
CostTypeInteger消耗类型
  • 1:扣费
  • 2:撤销返还
RemarkString备注

5. 示例

示例一: 合同发起扣费

{
"MsgId": "yDwFdUUckpswdrniUuzcbXw8N43W6Kcz",
"MsgType": "BillingUse",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"FlowId": "yDwFdUUckps******uzcbXwoXbRF6ja3",
"FlowName": "典子谦示例合同",
"CreateOrganizationName": "典子谦示例企业",
"QuotaType": "CloudEnterprise",
"UseCount": 1,
"CostTime": 1695037514,
"QuotaName": "企业版运营礼包",
"CostType": 1,
"Remark": ""
}
}

示例二: 合同撤销返还合同

{
"MsgId": "yDwFdUUckpswdrniUuzcbXw8N43W6Kcz",
"MsgType": "BillingUse",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"FlowId": "yDwFdUUckps******uzcbXwoXbRF6ja3",
"FlowName": "典子谦示例合同",
"CreateOrganizationName": "典子谦示例企业",
"QuotaType": "CloudEnterprise",
"UseCount": -1,
"CostTime": 1695037514,
"QuotaName": "企业版运营礼包",
"CostType": 2,
"Remark": ""
}
}
购买咨询
微信客服
4006-808-062
4006-808-062