检查好友关系

描述

调用此接口，可为一名用户批量检查其与至多 20 名其他用户的好友关系。如需上调（最多可为 50），请联系 ZEGO 技术支持。

ZEGO 支持单边或双边检查好友关系，以检查用户 A 与目标用户 B 的好友关系为例：

单边检查：仅检查用户 A 的好友列表是否有用户 B。
双边检查：同时检查用户 A 和用户 B 的好友列表是否有对方。

检查好友关系的结果可能有：

检查类型	数值	说明
检查类型	数值	A 的好友列表有 B	B 的好友列表有 A
单向	1	✖	无法确认
单向	2	✔️	无法确认
双向	3	✖	✖
	4	✔️	✖
	5	✖	✔️
	6	✔️	✔️

接口原型

请求方法：POST
请求地址：https://zim-api.zego.im/?Action=CheckFriendsRelation
传输协议：HTTPS
调用频率限制：20 次/秒。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

说明

以下 FromUserId 和 UserIds 对应的用户已在客户端调用 login 方法登录 ZIM 服务，或已调用服务端 API 完成注册。

参数	类型	是否必选	描述
FromUserId	String	是	为此 UserId 查询好友关系。
UserIds	Array of String	是	待检查好友关系的目标用户列表。默认数量上限为 20。
CheckType	Number	是	检查类型： 0：双向检查。 1：单向检查。

说明

FromUserId 和 UserIds 仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。

请求示例

请求地址 URL：

https://zim-api.zego.im/?Action=CheckFriendsRelation
&<公共请求参数>

https://zim-api.zego.im/?Action=CheckFriendsRelation
&<公共请求参数>

请求消息体：

{
    "FromUserId": "zego_user",
    "UserIds": [
        "user_id1",
        "user_id2",
        "user_id3",
        "user_id4"
    ],
    "CheckType": 0
}

{
    "FromUserId": "zego_user",
    "UserIds": [
        "user_id1",
        "user_id2",
        "user_id3",
        "user_id4"
    ],
    "CheckType": 0
}

响应参数

参数	类型	描述
Code	Number	返回码。说明当您发起请求同时检查 `FromUserId` 与多名用户的好友关系时：如果成功检查 `FromUserId` 与 1 名或更多用户的好友关系，Code 都会返回 0。此时请参考 Fails 中的具体信息，确认操作结果。如果 `FromUserId` 与全部目标用户的好友关系都检查失败，Code 会返回相关返回码，具体请参考全局返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
Successes	Array of Object	检查成功列表。
└UserId	String	成功检查 `FromUserId` 与此用户 ID 的好友关系。
└Relation	Number	关系类型，详情请参考描述。
Fails	Array of Object	检查失败列表。 Code 为 0： Fails 为空，表示成功检查 `FromUserId` 与全部目标用户的好友关系。 Fails 不为空，表示 `FromUserId` 与部分目标用户的好友关系检查失败，请参考 SubCode 处理。 Code 不为 0： Fails 为空，表示参数错误、接口频率限制、系统错误。 Fails 不为空，表示`FromUserId` 与全部目标用户的好友关系检查失败。
└UserID	String	`FromUserId` 与此用户 ID 的好友关系检查失败。
└SubCode	Number	具体失败返回码。
└Relation	Number	关系类型。仅当请求参数 `CheckType` 为 0 时，此字段有值，为 1 或 2，相关数值详情请参考描述。

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "Successes": [
        {
            "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
        }
    ]
}

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "Successes": [
        {
            "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
        }
    ]
}

返回码

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	描述	处理建议
660000001	业务类通用错误。	请重试，或联系 ZEGO 技术支持。
660000002	输入参数错误。	请检查输入的参数。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试。