Enable Allowlist Service
Enable the allowlist service for one or more specified users. Once the allowlist service is enabled, the blocklist feature will no longer take effect.
After enabling the service, you can use the "Add Allowlist" interface function to set the allowlist for users who have the service enabled.
tip
- This interface only enables the allowlist service for specified users. If you need all users under the App Key to enable the allowlist service, you can go to the RC Console, navigate to Configuration > Chat settings > Basic features > One-to-One and Group Chat > One-to-One Chat User Allowlist, and enable the One-to-One Chat User Allowlist for all users under the App Key. Note: If the allowlist service is enabled for all users under the App Key, the blocklist service will be disabled for all users.
- If the One-to-One Chat User Allowlist service is enabled for the App Key, you cannot switch specified users back to the blocklist service using this interface.
- There is a limit to the number of users that can be added to the allowlist. For details, refer to the Chat Ultimate Plan and Chat Premium Plan Feature Comparison.
Request Method
POST: https://Data Center Domain/user/whitesetting/set.json
Signature Rule: All server API requests require signature verification. For 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, up to 20 can be set. |
| whiteSetting | Int | Yes | Status, 1 to enable allowlist, 0 to enable blocklist, default is blocklist. |
Request Example
POST /user/whitesetting/set.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=98&userId=99&whiteSetting=0
Response
The HTTP response body contains a JSON object with the following structure:
| Return Value | Type | Description |
|---|---|---|
| code | Number | Return code, 200 indicates success. |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}