Feature Description

The app backend uses this callback to monitor users’ requests to join groups in real time, including blocking these requests.

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

This callback is triggered when an app user submits a request to join a group through the client.

Callback Triggering Time

This callback is triggered before the IM backend adds the requesting user to the group. (If the request needs to be approved by the admin, the callback occurs before the admin is notified.)

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.CallbackBeforeApplyJoinGroup", // Callback command
    "GroupId" : "@TGS#2J4SZEAEL",
    "Type": "Public", // Group type
    "Requestor_Account": "jared" // Requester
}

Request packet fields

Response packet examples

Allowing the processing to proceed

Allows the system to continue to process the user’s request to join a group.

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // Indicates that the system can continue to process the request to join the group.
}

Rejecting the request

Disallows the system to continue to process the user’s request to join a group and returns error code 10016 to the caller.

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 1 // Indicates that the request to join a group is rejected.
}

Response packet fields

References

Third-party callback overview