tencent cloud

功能说明

App 管理员可以通过该接口获取对应直播群的封禁成员列表。

说明：

直播群封禁相关功能支持需要终端 SDK 6.6 增强版及以上版本、Web SDK v2.22.0及以上版本，需 购买旗舰版 并在 控制台>群功能配置>群功能配置>直播群封禁成员 打开开关后方可使用直播群封禁功能。

接口调用说明

适用的群组类型

即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

200次/秒。

请求包示例

• 基础形式

用来向所有直播群下发广播消息。

{
    "GroupId": "@TGS#aJRGC4MH6",  // 群id
    "Limit":20, //单次分页拉取的数量，最大一次拉100
    "Offset": 0 //offset偏移量，初次为0，后续的请求以响应包的NextOffset为准设置，当NextOffset为0时候表示已获取完毕该直播群的封禁成员列表
}

请求包字段说明

应答包体示例

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

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

通过 REST API 在线调试工具 调试本接口。