- Release Notes
- Product Introduction
- Purchase Guide
- Free Demos
- Get Started
- Console Guide
- SDK Documentation
- SDK Download
- Quick Integration (Including UI Library)
- General Integration (No UI Library)
- Update Logs (Web & Mini Programs)
- Update Log (Native)
- Update Log (Unity)
- Update Log (Electron)
- Legacy API Tutorials
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Recent Contacts
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Recalling Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Getting Custom Group Attributes
- Modifying Custom Group Attributes
- Clearing Custom Group Attributes
- Resetting Custom Group Attributes
- Global Mute Management
- Operations Management
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callback Mutual Authentication Configuration Guide
- Best Practices
- FAQs
- Security Compliance Certification
- Smooth Migration Solutions
- Error Codes
- Contact Us
- Release Notes
- Product Introduction
- Purchase Guide
- Free Demos
- Get Started
- Console Guide
- SDK Documentation
- SDK Download
- Quick Integration (Including UI Library)
- General Integration (No UI Library)
- Update Logs (Web & Mini Programs)
- Update Log (Native)
- Update Log (Unity)
- Update Log (Electron)
- Legacy API Tutorials
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Recent Contacts
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Recalling Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Getting Custom Group Attributes
- Modifying Custom Group Attributes
- Clearing Custom Group Attributes
- Resetting Custom Group Attributes
- Global Mute Management
- Operations Management
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callback Mutual Authentication Configuration Guide
- Best Practices
- FAQs
- Security Compliance Certification
- Smooth Migration Solutions
- Error Codes
- Contact Us
Feature Description
This API is used to delete the standard and custom friend data of a specified user.
API Call Description
Sample request URL
https://xxxxxx/v4/sns/friend_delete_all?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
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.comadminapisgp.im.qcloud.comadminapikr.im.qcloud.comadminapiger.im.qcloud.comadminapiind.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. |
Maximum call frequency
200 calls per second
Sample requests
One-way deletion
{ "From_Account":"id" }Two-way deletion
{ "From_Account":"id", "DeleteType":"Delete_Type_Both" }
Request fields
| 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. |
Sample response
{
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "",
"ErrorDisplay": ""
}
Response fields
| 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 |
Error Codes
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. |
Debugging Tool
Use the RESTful API online debugging tool to debug this API.
References
- Adding Friends (v4/sns/friend_add)
- Importing Friends (v4/sns/friend_import)
- Updating Friends (v4/sns/friend_update)
- Deleting Friends (v4/sns/friend_delete)
- Verifying Friends (v4/sns/friend_check)
- Pulling Friends (v4/sns/friend_get)
- Pulling Specified Friends (v4/sns/friend_get_list)
Yes
No
Was this page helpful?