Batch unblock users

Overview

You can call this operation to batch unblock up to 20 users for a user. If you need a higher limit, contact ZEGOCLOUD technical support.

After users are unblocked, the client of the user receives the notification in the following ZIM SDK callbacks.

iOS	Android	macOS	Windows
blacklistChanged	onBlacklistChanged	blacklistChanged	onBlacklistChanged
Web	Flutter	React Native
blacklistChanged	onBlacklistChanged	blacklistChanged

Operation prototype

Request method: POST
Request URL: https://zim-api.zego.im/?Action=RemoveUsersFromBlacklist
Protocol: HTTPS
QPS limit: 20 calls per second

Request parameters

The following table describes only the operation-specific request parameters and some common request parameters. For the complete list of common request parameters, see the Public request parameters section of the Accessing Server APIs topic.

Parameter	Type	Required	Description
FromUserId	String	Yes	The ID of the registered user for whom users are to be unblocked.
UserIds	Array of String	Yes	The list of users to be unblocked. Up to 20 user IDs can be included, each of which cannot exceed 32 bytes in length.

Note

The FromUserId and UserIds parameters can contain only digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ' ', ', ', '|', '~'.

Sample request

Request URL:

Untitled

https://zim-api.zego.im/?Action=RemoveUsersFromBlacklist
&<Common request parameters>

Copied!

Request body:

Untitled

{
    "FromUserId": "zego_user",
    "UserIds": [
        "user1",
        "user2",
        "user3",
        "user4"
    ]
}

Copied!

Response parameters

Parameter	Type	Description
Code	Number	The return code. Note When you request to unblock multiple users at a time, take note of the following items: If one or more users are successfully unblocked, `0` is returned. For more information, see `ErrList`. If all specified users fail to be unblocked, a corresponding code is returned. For more information, see Return codes.
Message	String	The description of the request result.
RequestId	String	The request ID.
ErrList	Array of Object	The list of failed results. If `Code` is `0`: If `ErrList` is empty, all specified users are successfully unblocked. If `ErrList` is not empty, some specified users fail to be unblocked. In this case, see `SubCode`. If `Code` is not `0`: If `ErrList` is empty, one or more parameters are invalid, the QPS limit is exceeded, or a system error occurs. If `ErrList` is not empty, all specified users fail to be unblocked.
└UserID	String	The ID of the user who fails to be unblocked.
└SubCode	Number	The code returned when the request fails.

Sample response

Untitled

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "ErrList": [
        {
            "UserId": "user1",
            "SubCode": 660000002
        }
    ]
}

Copied!

Return codes

The following table describes only the return codes related to the business logic of the operation. For the complete list of return codes, see Return codes.

Return Code	Description	Solution
660000002	Invalid parameter.	Check the input parameter.
660300005	The QPS limit specified in `AppID` is exceeded.	Try again later.
660500002	`FromUserId` is not registered.	Check whether the user is registered. - If so, contact ZEGOCLOUD technical support. - If not, register the user.
660800001	`FromUserId` is not registered.	Check whether the user is registered. - If so, contact ZEGOCLOUD technical support. - If not, register the user.
660800038	`FromUserId` cannot be blocked or unblocked.	Modify the value of the `UserIds` parameter.
660800039	Too many users are included in the list.	Reduce the number of users.
660800042	Failed to unblock all specified users.	For more information, see `SubCode` of `ErrList`.
660800043	This user has been unblocked.	No handling is required.
660800044	This user is not on the blocklist.	No handling is required.