Invoke a Callback After Adding a Member to a Group

Feature Description

The app backend system uses this callback to monitor group member addition messages in real time. This callback can notify the app backend system that new members are added to the group so that the app can perform necessary data synchronization.

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 a 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 actively requests to join a group through the client, and the request is approved.
• An app user successfully adds other users to a group through the client.
• An app admin adds users to a group through the RESTful API.

Callback Triggering Times

• A user actively requests to join a group and successfully joins the group.
• A user is invited by another member to join a group and successfully joins the group.
• An app admin adds the user to a group through the RESTful API.

API Description

Request URL example

In the following example, the callback URL configured for 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.CallbackAfterNewMemberJoin", // Callback command
    "GroupId" : "@TGS#2J4SZEAEL",
    "Type": "Public", // Group type
    "JoinType": "Apply", // Method for joining a group: Apply (apply to join the group) or Invited (invited to join the group)
    "Operator_Account": "leckie", // Operator member
    "NewMemberList": [ // New member list
        {
            "Member_Account": "jared"
        },
        {
            "Member_Account": "tommy"
        }
    ]
}

Request packet fields

Response packet example

The app backend system returns the response packet after synchronizing data.

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // Ignore the response result
}

Response packet fields

References

• Third-party callback overview
• RESTful APIs: Adding group members