You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

校验好友关系 IsFriend

最近更新时间：2023.11.27 20:36:34

首次发布时间：2023.08.16 19:53:36

我的收藏

你可以使用此接口校验两个用户之间的好友关系。

接口行为

你可以调用 IsFriend 接口，指定你所属的 AppId、用户 ID 和 检验用户 ID 判断双方是否为好友。一次最多支持校验 10 个好友。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

接口限制

QPS 不得超过 100。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名类型必填示例值描述
ActionString是IsFriend接口名称，本接口取值：IsFriend
VersionString是2020-12-01接口版本，本接口取值：2020-12-01

Body

参数名类型必填示例值描述
AppIdInt是000000应用的唯一标志
UserIdInt是10001用户 UserId
InboxTypeInt否0信箱，用做逻辑隔离。默认值为 0
FriendUserIdsArray of Int是[10002]需要校验用户的 UserId，一次最多检验 10 个用户

请求示例代码

Query

https://rtc.volcengineapi.com?Action=IsFriend&Version=2020-12-01

Body

{
    "AppId":000000,
    "UserId":10001,
    "InboxType":0,
    "FriendUserIds":[10002,2000]
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名类型描述
InfosIsFriendInfo好友关系详情

IsFriendInfo

参数名类型描述
FriendUserIdInt校验好友的 UserId
IsFriendBool是否是好友。
  • true：是。
  • false：否

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "IsFriend",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Infos": [
            {
                "FriendUserId": 10002,
                "IsFriend": false
            },
            {
                "FriendUserId": 2000,
                "IsFriend": true
            }
        ]
    }
}