Group Creation Daily Net Increase Threshold Alarm Callback
功能说明
App 后台可以通过该回调接收群组日净增上限阈值告警。
注意事项
要启用回调,必须配置回调 URL,并打开本条回调协议对应的开关,配置方法详见 第三方回调配置 文档。
回调的方向是即时通信 Chat 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
其他安全相关事宜请参考 第三方回调简介:安全考虑 文档。
可能触发该回调的场景
App 用户通过客户端创建群组,并且当天群组增量(创建减去解散的数量)超过限额的70%。
App 管理员通过 REST API 创建群组,并且当天群组增量(创建减去解散的数量)超过限额的70%。
回调发生时机
群组创建之后。
接口说明
请求 URL 示例
以下示例中 App 配置的回调 URL 为
https://www.example.com
。
示例:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
请求参数说明
参数 | 说明 |
https | 请求协议为 HTTPS,请求方式为 POST |
www.example.com | 回调 URL |
SdkAppid | 创建应用时在即时通信 Chat 控制台分配的 SDKAppID |
CallbackCommand | 固定为:Group.CallbackOnDailyGroupQuotaAlarm |
contenttype | 固定值为 JSON |
ClientIP | 客户端 IP,格式如:127.0.0.1 |
OptPlatform |
请求包示例
{"CallbackCommand": "Group.CallbackOnDailyGroupQuotaAlarm", // 回调命令"QuotaUsed" : 7321, // 当日群组数量增量"Quota": 10000, // 每日新增群组数量上限"EventTime":"1670574414123"//毫秒级别,事件触发时间戳}
请求包字段说明
字段 | 类型 | 说明 |
CallbackCommand | String | 回调命令 |
QuotaUsed | Integer | 当日群组数量增量 |
Quota | Integer | |
EventTime | Integer | 事件触发的毫秒级别时间戳 |
应答包示例
App 后台记录告警后,发送回调应答包。
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
应答包字段说明
字段 | 类型 | 属性 | 说明 |
ActionStatus | String | 必填 | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 必填 | 错误码,建议设置为0 |
ErrorInfo | String | 必填 | 错误信息 |
参考
第三方回调简介