please select
Docs Overview/
Chat/
Server APIs/
Webhooks/
Relationship Chain Webhooks/
After a Friend Is Deleted/

After a Friend Is Deleted

Feature Description

The app backend can use this callback to view information about deleting friends 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 Chat 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 a client to initiate a friend deletion request.
The app backend initiates a friend deletion request through the RESTful API.

Callback Triggering Time

The callback will be performed after the Chat backend receives a friend deletion request and successfully deletes the 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

Parameter
Description
https
The request protocol is HTTPS, and the request method is POST.
www.example.com
The callback URL.
SdkAppid
The SDKAppID assigned by the IM console when an app is created.
CallbackCommand
The value is fixed to Sns.CallbackFriendDelete.
contenttype
The value is fixed to JSON.
ClientIP
The client IP address, whose format is similar to: 127.0.0.1.
OptPlatform
The client platform. For details on the values, see the OptPlatform parameter in Third-Party Callback Overview: Callback Protocols.

Request packet example

{
    "CallbackCommand": "Sns.CallbackFriendDelete", 
    "PairList": [
        {
            "From_Account": "id", 
            "To_Account": "id1"
        }, 
        {
            "From_Account": "id", 
            "To_Account": "id2"
        }, 
        {
            "From_Account": "id", 
            "To_Account": "id3"
        }
    ]
}

Request packet fields

Field
Type
Description
CallbackCommand
String
Callback command
PairList
Array
Friends that were successfully deleted
From_Account
String
To_Account is deleted from the friend list of From_Account
To_Account
String
To_Account is deleted from the friend list of From_Account

Response packet example

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

Response packet fields

Field
Type
Attribute
Description
ActionStatus
String
Required
The request processing result. OK: succeeded. FAIL: failed.
ErrorCode
Integer
Required
The error code. 0: the app backend processing succeeded. 1: the app backend processing failed.
ErrorInfo
String
Required
Error information.

References

Third-party callback overview
RESTful APIs: Deleting a friend