tencent cloud

Feature Description

The app backend uses this callback to view information about friends added by users in real time.

Notes

• 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

• The app backend uses the RESTful API to initiate a two-way friend addition request, and the peer’s friend request verification mode is "AllowAny".
• The app backend uses the client to initiate a two-way friend addition request, and the peer’s friend verification mode is "AllowAny".
• The app backend uses the RESTful API to initiate a one-way friend addition request.
• The app backend uses the client to initiate a one-way friend addition request.
• After receiving the friend addition request, the app user permits to add the peer as a friend.
• The app backend uses the RESTful API to forcibly add a friend.

Callback Triggering Time

This callback is triggered when a friend is successfully added.

Note：

This callback will not be triggered if the API for importing friends is invoked to add a friend.

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.CallbackFriendAdd",
    "PairList": [
        {
            "From_Account": "id",
            "To_Account": "id1",
            "Initiator_Account": "id"
        },
        {
            "From_Account": "id",
            "To_Account": "id2",
            "Initiator_Account": "id"
        },
        {
            "From_Account": "id",
            "To_Account": "id3",
            "Initiator_Account": "id"
        }
    ],
    "ClientCmd":"friend_add",
    "Admin_Account":"",
    "ForceFlag":1
}

Request packet fields

Response packet example

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

Response packet fields

References

• Third-party callback overview
• RESTful APIs: Adding a friend