Docs Overview/
Chat/
Server APIs/
RESTful APIs/
Group Related/
Group Member Management/
Banning Group Members/

Banning Group Members

Feature Overview

This API is used to ban a member of an audio-video group. A banned member cannot receive messages nor rejoin the audio-video group during the ban duration.
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 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/ban_group_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
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/group_open_http_svc/ban_group_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
Banning members of an audio-vid eo group
{
    "GroupId": "@TGS#aJRGC4MH6",  // ID of the group whose members are to be banned
    "Members_Account":[brennanli3", "brennanli12], // Account IDs of the members to be banned. Up to 20 account IDs are supported per request.
    "Duration":3600, // Ban duration, in seconds
    "Description": "you are banned because of irregularities" // Ban information, which can be up to 1,000 bytes in length
}

Request fields

Field
Type
Required
Description
GroupId
String
Yes
ID of the group whose members are to be banned
Members_Account
Array
Yes
Account IDs of the members to be banned. Up to 20 account IDs are supported per request.
Duration
Integer
Yes
Ban duration, in seconds. It is a 32-bit unsigned integer.
Description
String
No
Ban information, which can be up to 1,000 bytes in length

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 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 banned exceeds the upper 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.