The app backend can use this callback to view whether the number of members in a group has reached the limit for the group. This callback can also be used to delete inactive group members to accept new members.
The callback is triggered when the number of group members reaches the limit for the group after a new member is added, or when a new member fails to be added to a group because the number of group members has reached the limit.
In the following example, 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
Parameter | Description |
---|---|
https | The request protocol is HTTPS, and the request method is POST. |
www.example.com | The callback URL. |
SdkAppid | The SDKAppID assigned by the IM console when an app is created. |
CallbackCommand | The value is fixed to Group.CallbackAfterGroupFull. |
contenttype | The value is fixed to JSON. |
ClientIP | The client IP address, whose format is similar to 127.0.0.1. |
OptPlatform | The client platform. For details on the possible values, see the OptPlatform parameter in Third-Party Callback Overview: Callback Protocols. |
{
"CallbackCommand": "Group.CallbackAfterGroupFull", // Callback command
"GroupId": "@TGS#2J4SZEAEL" // Group ID
}
Field | Type | Description |
---|---|---|
CallbackCommand | String | The callback command. |
GroupId | String | The ID of the group that is full. |
After detecting that the number of group members has reached the limit, the app backend sends a callback response packet.
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0 // The result in the response is ignored.
}
Field | Type | Attribute | Description |
---|---|---|---|
ActionStatus | String | Required | The request processing result. OK: succeeded. FAIL: failed. |
ErrorCode | Integer | Required | The error code. 0: ignore the result in the response. |
ErrorInfo | String | Required | Error information. |
Was this page helpful?