Blocklist Management

After adding a user to the blocklist, you will no longer receive any one-to-one chat messages from that user.

• Adding to the blocklist is a one-way operation. For example, if User A blocks User B, it means B cannot send messages to A (error code 405). However, A can still send messages to B, and B will receive them normally.
• There is an upper limit to the total number of users a single user can block, which depends on the pricing plan. The limit is 3000 users for the Chat Premium Plan and Chat Ultimate Plan. For other plans, please 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 blocklist by default. To enable this restriction, set verifyBlacklist to 1 when calling the API.

Add to Blocklist

Add the specified user (userId) to the current user's blocklist. After successful operation, the current user can still send messages to the blocked user, but the blocked user cannot send one-to-one chat messages to the current user.

RongIMClient.getInstance().addToBlacklist(userId, callback);

Parameter	Type	Description
userId	String	User ID
callback	OperationCallback	Callback interface

Remove from Blocklist

Remove the specified user (userId) from the current user's blocklist.

RongIMClient.getInstance().removeFromBlacklist(userId, callback);

Parameter	Type	Description
userId	String	User ID
callback	OperationCallback	Callback interface

Check if User is in Blocklist

Check if the specified user is in the current user's blocklist based on the user ID (userId).

RongIMClient.getInstance().getBlacklistStatus(userId,
        new ResultCallback<BlacklistStatus>() {
            @Override
            public void onSuccess(BlacklistStatus blacklistStatus) {
            }

            @Override
            public void onError(ErrorCode e) {
            }
        });

BlacklistStatus enumeration values:

• In blocklist: IN_BLACK_LIST(0)
• Not in blocklist: NOT_IN_BLACK_LIST(1)

Get Blocklist

Retrieve the current user's blocklist.

RongIMClient.getInstance()
        .getBlacklist(
                new GetBlacklistCallback() {
                    @Override
                    public void onSuccess(String[] strings) {
                    }

                    @Override
                    public void onError(ErrorCode e) {
                    }
                });