Deleting Friends

Feature Overview
This API is used to delete friends. Both one-way deletion and two-way deletion are supported.
API Calling Description
Sample request URL
https://xxxxxx/v4/sns/friend_delete?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter
Description
xxxxxx
Domain name corresponding to the country/region where your SDKAppID is located.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/sns/friend_delete
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format, which should always be json.
Maximum call frequency
200 calls per second
Sample request
One-way deletion
{
  "From_Account":"id",
  "To_Account":["id1","id2","id3"],
  "DeleteType":"Delete_Type_Single"
}
Two-way deletion
{
  "From_Account":"id",
  "To_Account":["id1","id2","id3"],
  "DeleteType":"Delete_Type_Both"
}
Request fields
Field
Type
Required
Description
From_Account
String
Yes
The UserID of the account that requests to delete friends
To_Account
Array
Yes
The list of UserIDs of the friends to be deleted. Each request cannot contain more than 1000 UserIDs.
DeleteType
String
No
Deletion mode. For details, see Deleting Friends.
Sample response
{
    "ResultItem":
    [
        {
            "To_Account":"id1",
            "ResultCode":0,
            "ResultInfo":""
        },
        {
            "To_Account":"id2",
            "ResultCode":0,
            "ResultInfo":""
        },
        {
            "To_Account":"id3",
            "ResultCode":0,
            "ResultInfo":""
        }
    ],
    "ActionStatus":"OK",
    "ErrorCode":0,
    "ErrorInfo":"0",
    "ErrorDisplay":""
}
Response fields
Field
Type
Description
ResultItem
Array
The result object array of deleting friends in batch
To_Account
String
The UserID you requested to delete
ResultCode
Integer
The process result of To_Account. 0: Successful. Other values: Failed. For details on non-zero results, see Error Codes.
ResultInfo
String
The error description of To_Account. This field is empty if the request succeeds.
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 ResultCode, ResultInfo, ErrorCode, and ErrorInfo.
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.
30002
The SDKAppID does not match.
30003
The requested account does not exist.
30004
The request requires app admin permissions.
30006
Internal server error. Try again.
30007
Network timeout. Try again later.
30008
A write conflict occurred due to concurrent write operations. You are advised to use bulk processing.
31704
The account you requested to delete is not your friend.
31707
The friend deletion request was filtered by the security policy. Do not initiate friend deletion requests too frequently.
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.
Reference
﻿Adding Friends﻿
﻿Importing Friends 
﻿Updating Friends 
﻿Deleting All Friends﻿
﻿Verifying Friends﻿
﻿Pulling Friends﻿
﻿Pulling Specified Friends 
Possible Webhooks
﻿After a Friend Is Deleted﻿

Feature Overview
API Calling Description
Error Codes
API Debugging Tool
Reference
Possible Webhooks

Parameter	Description
xxxxxx	Domain name corresponding to the country/region where your SDKAppID is located. China: `console.tim.qq.com` Singapore: `adminapisgp.im.qcloud.com` Seoul: `adminapikr.im.qcloud.com` Frankfurt: `adminapiger.im.qcloud.com` Silicon Valley: `adminapiusa.im.qcloud.com` Jakarta: `adminapiidn.im.qcloud.com`
v4/sns/friend_delete	Request API
sdkappid	SDKAppID assigned by the Chat console when an app is created
identifier	App admin account. For more information, see the App Admin section in Login Authentication.
usersig	Signature generated by the app admin account. For details, see Generating UserSig.
random	A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype	Request format, which should always be `json`.

Field	Type	Required	Description
From_Account	String	Yes	The UserID of the account that requests to delete friends
To_Account	Array	Yes	The list of UserIDs of the friends to be deleted. Each request cannot contain more than 1000 UserIDs.
DeleteType	String	No	Deletion mode. For details, see Deleting Friends.

Error Code	Description
30001	Incorrect request parameter. Check your request according to the error description.
30002	The SDKAppID does not match.
30003	The requested account does not exist.
30004	The request requires app admin permissions.
30006	Internal server error. Try again.
30007	Network timeout. Try again later.
30008	A write conflict occurred due to concurrent write operations. You are advised to use bulk processing.
31704	The account you requested to delete is not your friend.
31707	The friend deletion request was filtered by the security policy. Do not initiate friend deletion requests too frequently.