このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
ドキュメンテーション概要/
Group Creation Daily Net Increase Threshold Alarm Callback/

Group Creation Daily Net Increase Threshold Alarm Callback

Feature Overview

The application backend can receive group daily net increase limit threshold warnings through this callback.

Notes

To enable this callback, you must configure the URL. This callback and the callback after group profile modification use the same switch. For detailed directions, see Webhook Configuration.
During this callback, the IM backend initiates an HTTP POST request to the app backend.
After receiving the callback request, the app backend must check whether the SDKAppID contained in the request URL is the SDKAppID of the app.
For more security considerations, see the Security Considerations section in Third-Party Callback Overview.
You need to enable the topic feature in the console before using it.

Callback Triggering Scenarios

An App user creates a group through the client, and the daily group increment (the number of groups created minus the number of groups dissolved) exceeds 70% of the limit.
An App administrator creates a group through the REST API, and the daily group increment (the number of groups created minus the number of groups dissolved) exceed 70% of the limit.

Callback Triggering Timing

After the creation of the group.

API Calling Description

Sample request URL

In the following sample, the callback URL configured in the app is https://www.example.com. Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

Request parameters

Parameter
Description
https
The request protocol is HTTPS, and the request method is POST.
www.example.com
Callback URL
SdkAppid
The SDKAppID assigned by the IM console when the app is created
CallbackCommand
Fixed value: Group.CallbackOnDailyGroupQuotaAlarm.
contenttype
Fixed value: JSON.
ClientIP
Client IP, such as 127.0.0.1
OptPlatform
Client platform. For valid values, see the description of OptPlatform in the Callback Protocols section of Third-Party Callback Overview.

Sample request

{
    "CallbackCommand": "Group.CallbackOnDailyGroupQuotaAlarm", // Callback command
    "QuotaUsed" : 7321, // daily newly created groups
    "Quota": 10000,     // daily newly created groups limit
    "EventTime":"1670574414123"// timestamp        
}

Request fields

Parameter
Type
Description
CallbackCommand
String
Callback command
QuotaUsed
Integer
Daily newly created groups
Quota
Integer
Daily newly created groups limit
EventTime
Integer
Timestamp

Sample response

The application backend records the alert and sends the callback response packet.
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}

Response fields

Object
Type
Required
Description
ActionStatus
String
Yes
Request result. Valid values: OK (success); FAIL: (failure).
ErrorCode
Integer
Yes
Error code. We recommend you set it to 0.
ErrorInfo
String
Yes
Error information

References

Third-Party Callback Overview