Feature Description

The app backend uses this callback to monitor information about users added to the blocklist in real time.

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 uses the client to initiate a request for adding a user to the blocklist.
• The app backend initiates a request for adding a user to the blocklist through the RESTful API.

Callback Triggering Time

The callback is triggered when the IM backend receives a request for adding a user to the blocklist and successfully adds the user to the blocklist.

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": "Sns.CallbackBlackListAdd",
    "PairList": [
        {
            "From_Account": "id",
            "To_Account": "id1"
        },
        {
            "From_Account": "id",
            "To_Account": "id2"
        },
        {
            "From_Account": "id",
            "To_Account": "id3"
        }
    ]
}

Request packet fields

Response packet example

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": ""
}

Response packet fields

References

• Third-Party callback overview
• RESTful APIs: Adding users to the blocklist