The app backend can use this callback to view information about deleting friends by users in real time.
The callback will be performed after the IM backend receives a friend deletion request and successfully deletes the friend.
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
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. |
{
"CallbackCommand": "Sns.CallbackFriendDelete",
"PairList": [
{
"From_Account": "id",
"To_Account": "id1"
},
{
"From_Account": "id",
"To_Account": "id2"
},
{
"From_Account": "id",
"To_Account": "id3"
}
]
}
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 |
{
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": ""
}
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. |
Was this page helpful?