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 |
https://xxxxxx/v4/group_open_http_svc/ban_group_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
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 | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format. The value is fixed to json . |
{"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}
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 |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode":0}
Field | Type | Description |
ActionStatus | String | Request result. OK : Successful; FAIL : Failed |
ErrorCode | Integer | Error code. 0 : Successful; other values: Failed |
ErrorInfo | String | Error information |
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. |
Was this page helpful?