Feature Description

This API is used by the app backend to:

• Monitor friend requests in real time.
• Block malicious friend requests.

Notes

• To enable this callback, you must configure a callback URL and enable the corresponding switch for this callback. For more information on the configuration method, see Callback Configuration.
• During this callback, 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 the SDKAppID of the app.
• For more security considerations, see the Security Considerations section in Third-Party Callback Overview.

Callback Trigger Scenarios

• An app user initiates a friend request on the client.

Callback Trigger Timing

The IM backend receives a friend request from the app.

Note：

Friend requests initiated via RESTful API calls will not trigger the callback.

API Calling Description

Sample request URL

In the following sample, the callback URL configured in the app is https://www.example.com.
Sample:

https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

Request parameters

Sample request

{
"CallbackCommand": "Sns.CallbackPrevFriendAdd",
"Requester_Account": "id",
"From_Account": "id",
"FriendItem": [
  {
    "To_Account": "id1",
    "Remark": "remark1",
    "GroupName": "group1",
    "AddSource": "AddSource_Type_Android",
    "AddWording": "this is id1!"
  },
  {
    "To_Account": "id2",
    "Remark": "remark2",
    "GroupName": "group1",
    "AddSource": "AddSource_Type_Android",
    "AddWording": "this is id2!"
  }
],
"AddType": "Add_Type_Both",
"ForceAddFlags": 0,
"EventTime": 1631777344870
}

Request fields

Sample response

{
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "",
"ResultItem": [
  {
    "To_Account": "id1",
    "ResultCode": 0,
    "ResultInfo": ""
  },
  {
    "To_Account": "id2",
    "ResultCode": 0,
    "ResultInfo": ""
  }
]
}

Response fields

References

• Third-Party Callback Overview
• Adding Friends