Invoke a Callback After a Group Member Drops Out

Feature Description

The app backend can use this callback to monitor users who quit groups in real time, including recording users’ quitting information (for example, recording a log or synchronizing the quitting information to other systems).

Precautions

• To enable this callback, you must configure the callback URL and toggle on the corresponding protocol. For details on the configuration method, see Third-Party Callback Configuration.
• Callback direction: 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 consistent with its own SDKAppID.
• For other security-related issues, see Third-Party Callback Overview: Security Considerations.

Callback Triggering Scenarios

• An app user quits a group through the client.
• An app user removes a member from a group through the client.
• The app admin removes a member from a group through a RESTful API.

Callback Triggering Time

The callback is triggered after a user quits a group or is removed from the group by the group owner or admin.

API Description

Request URL example

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

Request parameters

Request packet example

{
    "CallbackCommand": "Group.CallbackAfterMemberExit", // The callback command.
    "GroupId": "@TGS#2J4SZEAEL", // The group ID.
    "Type": "Public", // The group type.
    "ExitType": "Kicked", // The member quitting method. Possible values are Kicked and Quit.
    "Operator_Account": "leckie", // The operator.
    "ExitMemberList": [ // The list of quit members.
        {
            "Member_Account": "jared"
        },
        {
            "Member_Account": "tommy"
        }
    ]
}

Request packet fields

Response packet example

The app backend returns the response packet after synchronizing data.

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // The result in the response is ignored.
}

Response packet fields

References

• Third-party callback overview
• RESTful APIs: Deleting a group member