Add Users to Allowlist
Set the allowlist for a specified user. After setting, the user can only receive messages from users in their allowlist. Before using this API, ensure that the allowlist service is enabled. For more details, refer to the Allowlist Service Overview.
- The total number of users in the allowlist for a single user is subject to a limit, which depends on the pricing plan. For the Chat Premium Plan and Chat Ultimate Plan, the limit is 3,000 users. For other plans, refer to the Service Limits section in the Feature Comparison Table.
- Sending one-to-one chat messages via the Server API is not restricted by the allowlist by default. To enable this restriction, set
verifyBlacklistto1when calling the API.
Request Method
POST: https://Data Center Domain/user/whitelist/add.json
Signature Rule: All Server API requests require signature verification. For more details, refer to API Request Signature.
Rate Limit: 100 requests per second
Body Parameters
The HTTP request body data format is application/x-www-form-urlencoded, and supports the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | String | Yes | User ID. |
| whiteUserId | String | Yes | The user ID to be added to the allowlist. You can add up to 20 whiteUserId entries at a time. The total number of users in the allowlist for a single user is subject to a limit, which depends on the pricing plan. For the Chat Premium Plan and Chat Ultimate Plan, the limit is 3,000 users. For other plans, refer to the Service Limits section in the Feature Comparison Table. |
Request Example
POST /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
userId=7&whiteUserId=123&whiteUserId=1456
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}