跳到主要内容

添加用户到聊天室用户白名单

本文介绍如何将一个或多个用户添加到指定聊天室的用户白名单中。您可添加一个或多个用户到指定聊天室的用户白名单，单个聊天室最多可添加 5 个白名单用户。

聊天室用户白名单功能可用于保护指定聊天室中的重要用户，例如具有管理员、主播等重要角色的用户。其具体能力如下：

  • 保护用户不被自动踢出：聊天室业务有离线用户自动退出机制。白名单用户离线后，不会被服务端因不活跃等原因自动踢出聊天室。
  • 保护用户发送的消息：聊天室业务具备消息丢弃机制。为保证聊天室中重要消息正常下发，聊天室业务默认在消息量较大的情况下，会按消息发送的时间顺序丢弃超出消费上限的最新消息，确保服务器稳定。聊天室白名单用户发送的消息在任何情况下会优先受到保护。

开通服务​

使用聊天室用户白名单功能前，请确认已为当前 App Key 开通此服务。

如未开通，调用服务端 API 时将返回 1009 错误码。注意，在未开通服务时，如果连续请求导致 API 请求频率超过限制，服务端 API 将返回 HTTP 429 Too Many Requests 错误（错误码为 1008）。

请求方法​

POST：https://数据中心域名/chatroom/user/whitelist/add.json

频率限制：每秒 100 次

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

正文参数​

HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：

参数类型必传说明
chatroomIdString是聊天室 ID。
userIdString是要加入白名单的用户 ID，可多次传参以批量添加。单个聊天室的用户白名单最多不超过 5 个。

返回结果​

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

返回值返回类型说明
codeNumber返回码，200 代表请求成功。

请求示例​

HTTP
POST /chatroom/user/whitelist/add.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

chatroomId=16&userId=123&userId=456

返回结果示例​

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

{"code":200}
最后于 更新