tencent cloud

Feedback

Getting the List of Banned Group Members

Last updated: 2024-06-11 11:03:38

    Feature Overview

    You can use this API to get the list of banned members of an audio-video group.
    Note
    Audio-video group member banning is supported by SDK Enhanced edition v6.6 or later and web SDK v2.22.0 or later. To use it, you need to purchase the Premium edition, go to the console, choose Feature configuration > Group configuration > Group feature configuration, and enable Audio-video group member banning.

    API Calling Description

    Applicable group types

    Group Type ID
    RESTful API Support
    Private
    No. Same as work groups (Work) in the new version.
    Public
    No
    ChatRoom
    No. Same as meeting groups (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_ban_member?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
    Mumbai: adminapiind.im.qcloud.com
    Silicon Valley: adminapiusa.im.qcloud.com
    Jakarta: adminapiidn.im.qcloud.com
    v4/group_open_http_svc/get_group_ban_member
    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. The value is fixed to json.

    Maximum call frequency

    200 calls per second

    Sample request

    Basic format
    It is used to deliver broadcast messages to all the audio-video groups.
    {
    "GroupId": "@TGS#aJRGC4MH6", // Group ID
    "Limit":20, // Number of banned members to be pulled per page each time. The maximum value allowed is 100.
    "Offset": 0 // Offset. For the first request, set `Offset` to 0. For subsequent requests, set `Offset` to the value of `NextOffset` in the response packet. If `NextOffset` is 0, the entire list of banned members of the audio-video group is obtained.
    }

    Request fields

    Field
    Type
    Required
    Description
    GroupId
    String
    Yes
    ID of the group whose members are to be unbanned
    Limit
    Integer
    No
    Number of unbanned users to be obtained each time. The maximum value allowed is 100.
    Offset
    Integer
    Yes
    Offset. For the first request, set Offset to 0. For subsequent requests, set Offset to the value of NextOffset in the response packet.

    Sample response

    {
    "ActionStatus": "OK",
    "BannedAccountList": [
    {
    "BannedUntil": 1660875916,
    "Member_Account": "brennanli1"
    },
    {
    "BannedUntil": 1660875916,
    "Member_Account": "brennanli12"
    }
    ],
    "ErrorCode": 0,
    "ErrorInfo": "",
    "NextOffset": 2
    }

    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
    BannedAccountList
    Array
    Information of banned members. BannedUntil indicates the banning end time of banned members. Member_Account indicates the account IDs of banned members.
    NextOffset
    Integer
    Offset value of the next request. If this field is 0, the list of banned members of the AVChatRoom group is fully pulled.

    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.
    10003
    Invalid command word.
    10004
    Invalid parameter. Check the error description and troubleshoot the issue.
    10005
    The number of members to be unbanned exceeds the maximum limit of 20 members per request.
    10007
    Insufficient operation permissions. For example, the switch is not enabled in the console, or the operating account is not the root account.

    API Debugging Tool

    Use the RESTful API online debugging tool to debug this API.
    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