Add Message Whitelist for Chatrooms

The chatroom service provides the Chatroom Message Whitelist feature, which can be used to protect important messages in your app's chatroom business, such as custom red packet messages in your app's business.

You can add one or more message types to the message type whitelist. In cases where the chatroom message volume is high, messages of types included in the chatroom message type whitelist are prioritized for protection.

• The chatroom message type whitelist supports up to 20 message types. All chatrooms under the same app share a single message type whitelist.
• The Chatroom Message Whitelist and Chatroom User Whitelist can be used simultaneously.

Enable the Service

Before using the Chatroom Message Whitelist feature, please ensure that the relevant service has been enabled for the current App Key.

If the service is not enabled, the Server API will return a 1009 error. Note that if the service is not enabled and continuous requests cause the API request frequency to exceed the limit, the Server API will return an HTTP 429 Too Many Requests error (error code 1008).

Request Method

POST: https://data center domain/chatroom/whitelist/add.json

Rate Limit: 100 requests per second

Signature Rule: All server-side API requests must be validated according to the signature rules. For details, see API Request Signature.

Body Parameters

The HTTP request body data format is application/x-www-form-urlencoded, and it supports the following HTTP form parameters:

Parameter	Type	Required	Description
objectnames	Array	Yes	Message identifiers, up to 20 custom message types, each no more than 32 characters

Request Example

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

Response

The HTTP response body contains a JSON object with the following structure:

Return Value	Return Type	Description
code	Number	Return code, 200 for success.

Response Example

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

{"code":200}