Feature Description

This API enables the app backend to promptly monitor (and reject if so configured) group members’ requests to add other users to the group.

Precautions

• To enable this callback, you must configure the callback URL and toggle on the corresponding callback protocol. For details on the configuration method, see Third-Party Callback Configuration.
• The callback route is from the IM backend to the app backend, where the IM backend sends HTTP POST requests.
• After receiving a callback request, the app backend must check whether SDKAppID in the request URL is consistent with its own SDKAppID.
• For other security-related matters, see Third-Party Callback Overview: Security Considerations.

Triggering Scenarios

• An app user sends a request for adding another user to the group through the user’s client.
• The app admin adds the user to the group through this RESTful API.

Callback Triggering Time

The callback is triggered before the IM backend adds the target user to the group. (If relationship chain hosting exists and the app configures friend relationship verification in IM, this callback will be triggered after the friend relationship is verified as successful.)

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.CallbackBeforeInviteJoinGroup",
  "GroupId": "@TGS#2J4SZEAEL",
  "Type": "Public",
  "Operator_Account": "leckie",
  "DestinationMembers": [
      {
          "Member_Account": "jared"
      },
      {
          "Member_Account": "leckie"
      }
  ]
}

Request packet fields

Response packet example

Allowing all users to join a group

The app backend allows all users in requests to join the group.

{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0 // Indicates that the system can continue to process requests for adding users to the group.
}

Rejecting some users to join a group

The app backend rejects some users in requests to join the group and returns these users’ Identifier s in RefusedMembers_Account.

{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "RefusedMembers_Account": [ // List of rejected users
      "jared"
  ]
}

Response packet fields

References

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