tencent cloud

Feedback

Getting Group Counters

Last updated: 2024-07-16 11:20:06

    Feature Overview

    The app admin can use this API to get group counters. To use this feature, you need to purchase the Premium edition.

    API Calling Description

    Applicable group types

    Group Type ID
    RESTful API Support
    Private
    Yes. Same as work groups (Work) in the new version.
    Public
    Yes
    ChatRoom
    Yes. Same as the meeting group (Meeting) in the new version.
    AVChatRoom
    Yes
    Community
    No
    These are the preset group types in Chat. For more information, see Group System.

    Sample request URL

    https://xxxxxx/v4/group_open_http_svc/get_group_counter?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

    Request parameters

    The following table describes only 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/group_open_http_svc/modify_group_attr
    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

    Basic format Get group counters:
    {
    "GroupId": "@TGS#aC5SZEAEF",
    "GroupCounterKeys":[ // List of group counter keys to get. If no value is passed in, all group counter keys will be returned.
    "like",
    "unlike"
    ]
    }

    Request fields

    Field
    Type
    Required
    Description
    GroupId
    String
    Yes
    Group ID
    GroupCounterKeys
    Array
    No
    List of group counter keys to get. If no value is passed in, all group counter keys will be returned.

    Sample response

    {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "GroupCounter":[
    {
    "Key":"like", // Group counter key
    "Value":5 // Latest group counter value
    }
    {
    "Key":"unlike",
    "Value":1
    }
    ]
    }

    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
    GroupCounter
    Array
    List of the latest group counter key-value pairs to get

    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
    10002
    Internal server error. Try again.
    10004
    Invalid parameter. Check the error description and troubleshoot the issue.
    10007
    Insufficient operation permission. For example, the current user is not a group member.
    10010
    The group does not exist or has been deleted.
    10015
    Invalid group ID. Check whether the group ID is entered correctly and whether the group exists.
    10059
    To use this feature, you need to purchase the Premium edition.
    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