tencent cloud

Feedback

Deleting Group Custom Attributes

Last updated: 2024-07-16 11:15:59

    Feature Overview

    This API allows app admins to delete custom attributes of groups.

    API Call Description

    Applicable Group Types

    Group Type ID
    RESTful API Support
    Private
    Yes. Same as the Work group in the new version.
    Public
    Yes.
    ChatRoom
    Yes. Same as the Meeting group in the new version.
    AVChatRoom
    Yes.
    Community
    Yes.
    These are built-in group types of Instant Messaging (IM). For more information, see Group System.

    Sample Request URL

    https://console.tim.qq.com/v4/group_open_http_svc/delete_group_attr?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

    Request Parameters

    The following table only lists parameters that can be modified when this API is called. For more information about the parameters, see RESTful API Overview.
    Parameter
    Description
    v4/group_open_http_svc/delete_group_attr
    Request API.
    sdkappid
    SDKAppID assigned by the IM console when an app is created.
    identifier
    App admin account. For more information, see App Admin.
    usersig
    Signature generated by the app admin account. For more information, see Generating UserSig.
    random
    A random 32-bit unsigned integer ranging from 0 to 4294967295.
    contenttype
    Request format, which is fixed at json.

    Maximum Call Frequency

    200 calls per second

    Sample Request

    Basic Request This example shows how to delete custom attributes of a group.
    {
    "GroupId": "@TGS#aC5SZEAEF",
    "GroupAttr":[
    {
    "key":"attr_key" // Attribute key
    },
    {
    "key":"attr_key1"
    }
    ]
    }

    Request Fields

    Field
    Type
    Required
    Description
    GroupId
    String
    Yes
    ID of the group of which custom attributes are to be deleted.
    GroupAttr
    Array
    Yes
    List of custom attributes to be deleted, with the keys of the custom attributes.

    Sample Response

    {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
    }

    Response Fields

    Field
    Type
    Description
    ActionStatus
    String
    Request result.- OK: Successful- FAIL: Failed
    ErrorCode
    Integer
    Error code.- 0: Successful- Other values: Failed
    ErrorInfo
    String
    Error information.

    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 error information are indicated by ErrorCode and ErrorInfo respectively in the response. For public error codes (60000 to 79999), see Error Codes . The following table describes the error codes specific to this API:
    Error Code
    Description
    10002
    Internal server error. Try again.
    10004
    Invalid parameter. Check the error description and rectify the fault.
    10007
    No operation permission. For example, a group of this type does not have the operation permission on custom attributes.
    10010
    The group does not exist or has been deleted.
    10015
    Invalid group ID. Use the correct group ID.
    10045
    The size of the custom attribute key exceeds the limit of 32 bytes.
    10049
    The frequency of writing custom attributes to a group exceeds the limit. You can add, delete, or modify the attributes for up to 5 times per second.
    10050
    Failed to delete a non-existent custom attribute.
    
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support