You can call this operation to batch check the blockships of a user between up to 20 users, that is, whether the user blocks them. If you need a higher limit, contact ZEGOCLOUD technical support.
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 whose blockships are to be checked. |
UserIds |
Array of String |
Yes |
The list of users to be checked. Up to 20 user IDs can be included. |
The FromUserId
and UserIds
parameters can contain only digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ' ', '{', '}', '|', '~'.
Request URL:
https://zim-api.zego.im/?Action=CheckUsersIsInBlacklis
&<Common request parameters>
Request body:
{
"FromUserId": "zego_user",
"UserIds": [
"user1",
"user2",
"user3",
"user4"
]
}
Parameter | Type | Description |
---|---|---|
Code |
Number |
The return code. When you request to check the blockships between FromUserId and multiple users, take note of the following items:
|
Message |
String |
The description of the request result. |
RequestId |
String |
The request ID. |
Succ |
Array of Object |
The list of successful results. |
UserId |
String |
The ID of the user whose blockship with FromUserId is successfully checked. |
Result |
Number |
The check result. Valid values:
|
ErrList |
Array of Object |
The list of failed results.
|
UserID |
String |
The ID of the user whose blockship with FromUserId fails to be checked. |
SubCode |
Number |
The code returned when the request fails. |
{
"Code": 0,
"Message": "success",
"RequestId": "343649807833778782",
"Succ": [
{
"UserId": "user1",
"Result": 1
},
{
"UserId": "user2",
"Result": 1
}
],
"ErrList": [
{
"UserId": "user3",
"SubCode": 660000002
},
{
"UserId": "user4",
"SubCode": 660000002
}
]
}
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.
|
660700015 |
The target user is not registered. |
Check whether the user is registered.
|
660800001 |
FromUserId is not registered. |
Check whether the user is registered.
|
660800039 |
Too many users are included in the list. |
Reduce the number of users. |