Deleting Lists

Last updated: 2021-01-26 20:00:02

    Feature Description

    This API is used to delete specified friend lists.

    API Call Description

    Sample request URL

    https://console.tim.qq.com/v4/sns/group_delete?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
    v4/sns/group_delete Request API.
    sdkappid The SDKAppID assigned by the IM console when an application is created.
    identifier The app administrator account. For more information, please see the App Admin section in Login Authentication.
    usersig The signature generated by the app administrator account. For more information on how to generate the signature, please see Generating UserSig.
    random A random 32-bit unsigned integer ranging from 0 to 4294967295.

    Maximum call frequency

    200 calls per second

    Sample request packet

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

    Request packet fields

    Field Type Required Description
    From_Account String Yes UserID of the account for which to delete lists.
    GroupName Array Yes The friend lists to be deleted.

    Sample response packet

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

    Response packet 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, please 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), please 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 has occurred due to concurrent writes. You are advised to use batch processing.

    API Debugging Tool

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

    References

    Adding Lists (v4/sns/group_add)

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help