This API is used to delete the standard and custom friend data of a specified user.
https://xxxxxx/v4/sns/friend_delete_all?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
The following table only describes the modified parameters when this API is called. For more information on other parameters, please see RESTful API Overview.
Parameter | Description |
---|---|
https | The request protocol is HTTPS, and the request method is POST. |
xxxxxx | The country/region where your SDKAppID is located.console.tim.qq.com adminapisgp.im.qcloud.com adminapikr.im.qcloud.com adminapiger.im.qcloud.com adminapiind.im.qcloud.com |
v4/sns/friend_delete_all | Request API |
sdkappid | The SDKAppID assigned by the IM console when the application is created |
identifier | The administrator account of the app. For more information, please see App Administrator. |
usersig | The signature generated in the app administrator account. For details on how to generate the signature, please see Generating UserSig. |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
contenttype | Request format. The value is always json . |
200 calls per second
One-way deletion
{
"From_Account":"id"
}
Two-way deletion
{
"From_Account":"id",
"DeleteType":"Delete_Type_Both"
}
Field | Type | Required | Description |
---|---|---|---|
From_Account | String | Yes | The UserID of the account that requests to delete friends |
DeleteType | String | No | Deletion mode. One-way deletion is the default mode. For details, see Deleting Friends. |
{
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "",
"ErrorDisplay": ""
}
Field | Type | Description |
---|---|---|
ActionStatus | String | The request result. OK : successful. FAIL : failed. |
ErrorCode | Integer | Error code. 0 : successful. Other values: failed. For details on non-zero results, see Error Codes. |
ErrorInfo | String | Detailed error information |
ErrorDisplay | String | Detailed information displayed on the client |
The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode
and ErrorInfo
respectively.
For public error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API:
Error Code | Description |
---|---|
30001 | Incorrect request parameter. Check your request according to the error description. |
30003 | The requested user account does not exist. |
30004 | The request requires app administrator permissions. |
30006 | Internal server error. Please try again. |
30007 | Network timeout. Please try again later. |
30008 | A write conflict occurred due to concurrent write operations. You are advised to use bulk processing. |
Use the RESTful API online debugging tool to debug this API.
Was this page helpful?