https://xxxxxx/v4/sns/friend_delete?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
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 | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format, which should always be json . |
{"From_Account":"id","To_Account":["id1","id2","id3"],"DeleteType":"Delete_Type_Single"}
{"From_Account":"id","To_Account":["id1","id2","id3"],"DeleteType":"Delete_Type_Both"}
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 |
{"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":""}
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 | |
ErrorInfo | String | Detailed error information |
ErrorDisplay | String | Detailed information displayed on the client |
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. |
Was this page helpful?