跳到主要内容

加入聊天室消息白名单

聊天室业务提供聊天室消息白名单功能，可用于保护 App 聊天室业务中的重要消息，例如 App 业务中自定义的红包消息。

App 可以添加一种或多种消息类型到消息类型白名单中。在聊天室消息量较大的情况下，聊天室消息类型白名单的消息优先受到保护。

  • 聊天室消息类型白名单最多支持 20 个消息类型。App 下所有聊天室共享一个消息类型白名单。
  • 聊天室消息白名单与聊天室用户白名单可以同时使用。

开通服务​

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

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

请求方法​

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

频率限制： 每秒钟限 100 次

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

正文参数​

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

参数类型必传说明
objectnamesString是消息标识，最多不超过 20 个，自定义消息类型，长度不超过 32 个字符

请求示例​

POST /chatroom/whitelist/add.json HTTP/1.1
Host: api.rong-api.com
App-Key: c9kqb3rdkbb7j
Nonce: 1167631608
Timestamp: 1408710653491
Signature: c8ef4d25e5684e9fca820140eaf6a36abc4fbc93
Content-Type: application/x-www-form-urlencoded

objectnames=RC:VcMsg&objectnames=RC:ImgTextMsg&objectnames=RC:ImgMsg

返回结果​

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

返回值返回类型说明
codeNumber返回码，200 为正常。

返回结果示例​

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

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