检查好友关系

描述

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

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

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

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

接口原型

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

请求参数

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

请求示例

• 请求地址 URL：

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

• 请求消息体：

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

响应参数

响应示例

{
    "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
        }
    ]
}

返回码

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