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/get_group_ban_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/get_group_ban_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", // 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.}
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. |
{"ActionStatus": "OK","BannedAccountList": [{"BannedUntil": 1660875916,"Member_Account": "brennanli1"},{"BannedUntil": 1660875916,"Member_Account": "brennanli12"}],"ErrorCode": 0,"ErrorInfo": "","NextOffset": 2}
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. |
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. |
Was this page helpful?