You can call this operation to batch check the friendships between a user and up to 20 users. If you need a higher limit (50 at maximum), please contact the ZEGOCLOUD technical support team.
ZEGOCLOUD allows one-way or two-way check of friendships. In this example, the friendship between users A and B is checked.
Below are possible results.
Check Type | Value | Description | |
---|---|---|---|
B in the Friend List of A | A in the Friend List of B | ||
One-way |
1 |
✖ |
Uncertain |
2 |
✔️ |
Uncertain |
|
Two-way |
3 |
✖ |
✖ |
4 |
✔️ |
✖ |
|
5 |
✖ |
✔️ |
|
6 |
✔️ |
✔️ |
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 friendships are to be checked. |
UserIds |
Array of String |
Yes |
The list of users to be checked. Up to 20 user IDs can be included. |
CheckType |
Number |
Yes |
The check type. Valid values:
|
The FromUserId
and UserIds
parameters can contain only digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ' ', '{', '}', '|', '~'.
Request URL:
https://zim-api.zego.im/?Action=CheckFriendsRelation
&<Common request parameters>
Request body:
{
"FromUserId": "zego_user",
"UserIds": [
"user_id1",
"user_id2",
"user_id3",
"user_id4"
],
"CheckType": 0
}
Parameter | Type | Description |
---|---|---|
Code |
Number |
The return code. When you request to check the friendships between FromUserId and multiple users, take note of the following items:
|
Message |
String |
The description of the request result. |
RequestId |
String |
The request ID. |
Successes |
Array of Object |
The list of successful results. |
UserId |
String |
The ID of the user whose friendship with FromUserId is successfully checked. |
Relation |
Number |
The relationship type. For more information, see Overview. |
Fails |
Array of Object |
The list of failed results.
|
UserID |
String |
The ID of the user whose friendship with FromUserId fails to be checked. |
SubCode |
Number |
The code returned when the request fails. |
Relation |
Number |
The relationship type. This parameter is valid only if CheckType is set to 0 . Valid values: 1 and 2 . For more information, see Overview. |
{
"Code": 0,
"Message": "success",
"RequestId": "343649807833778782",
"Succ": [
{
"UserId": "user_id1",
"Relation": 4
},
{
"UserId": "user_id2",
"Relation": 4
}
],
"Fails": [
{
"UserId": "user_id3",
"SubCode": 660000001,
"Relation": 1
},
{
"UserId": "user_id4",
"SubCode": 660000001,
"Relation": 2
}
]
}
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 |
---|---|---|
660000001 |
A common service error occurred. |
Please try again, or contact ZEGOCLOUD technical support team. |
660000002 |
Invalid parameter. |
Check the input parameter. |
660300005 |
The QPS limit specified in AppID is exceeded. |
Please try again later. |