跳到主要内容

查询群组全体禁言白名单

获取指定超级群（或频道）的禁言白名单。

请求方法​

POST： https://数据中心域名/ultragroup/banned/whitelist/get.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文中可包含如下 HTTP 表单参数：

参数类型必传说明
groupIdString是超级群 ID。
busChannelString否频道 ID。
pageString否当前页码,默认1。
pageSizeString否每页条数，默认50。 上限 200

请求示例​

POST /ultragroup/banned/whitelist/get.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

groupId=abcdefg

返回结果​

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值返回类型说明
codeNumber返回码，200 为正常。
usersString[]用户 ID。

返回结果示例​

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "code": 200,
    "users": [
        {
            "id": "userId_001"
        },
        {
            "id": "userId_002"
        }
    ]
}

关于超级群禁言服务行为变更的说明​

如果您的应用/环境在 2022.10.13 日前已开通超级群服务，群级别的单人禁言、全体禁言、全体禁言白名单设置仅可控制发送不属于任何频道（指发消息时不携带频道 ID）的超级群消息的行为。

即时通讯服务在 2022.10.13 对超级群禁言服务的行为进行了调整，实现一次调用即可对指定超级群下所有频道进行禁言、白名单设置。如果您的应用/环境在 2022.10.13 日及以后开通超级群服务，超级群业务中会包含一个 ID 为 RCDefault 的默认频道，且群级别的禁言相关服务设置会自动适用于所有频道。

即时通讯服务支持客户调整服务至最新行为。该行为调整将影响客户端、服务端收发消息、获取会话、清除历史消息、禁言等多个功能。如有需要，请提交工单咨询详细方案。

最后于 更新