Docs Overview/
Chat/
Server APIs/
RESTful APIs/
User Management/
Friend Lists/
Deleting Lists/

Deleting Lists

Feature Overview

This API is used to delete specified friend lists.

API Calling Description

Sample request URL

https://xxxxxx/v4/sns/group_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
v4/sns/group_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

{
    "From_Account":"id",
    "GroupName":["group1","group2","group3"]
}

Request fields

Field
Type
Required
Description
From_Account
String
Yes
UserID of the account for which to delete lists.
GroupName
Array
Yes
The list of groups to be deleted.
Note：
Since the maximum number of groups is 32, the number of groups in a single request must not exceed 32.

Sample response

{
    "CurrentSequence": 4,
    "ActionStatus":"OK",
    "ErrorCode":0,
    "ErrorInfo":"0",
    "ErrorDisplay":""
}

Response fields

Field
Type
Description
CurrentSequence
Integer
The current sequence of the lists.
ActionStatus
String
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 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.

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.

Reference

Adding Lists (v4/sns/group_add)