校验用户是否在黑名单 IsInBlackList--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

校验用户是否在黑名单 IsInBlackList

最近更新时间：2024.01.25 17:26:24首次发布时间：2023.09.25 19:45:01

你可以使用此接口查看某用户是否在黑名单中。

使用说明

接口行为

你可以调用 IsInBlackList 接口，指定你所属的 AppId、用户 ID 和对方用户 ID，校验对方是否在自己的黑名单中。一次最多支持校验 10 个用户。

调用接口

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

注意事项

QPS 不得超过 100。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=IsInBlackList&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`IsInBlackList`	接口名称。当前 API 的名称为 `IsInBlackList`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
UserId	Long	是	`10001`	用户 ID
InboxType	Integer	否	`0`	信箱，用做逻辑隔离。默认值为 `0`
BlackListUserIds	Array of Long	是	`[10002]`	需要校验的用户的 UserId，一次最多校验 10 个用户

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
IsInBlackListInfos	JSON Map	`-`	校验结果。key 为 uid，value 为 true：在黑名单中。 value 为 false：不在黑名单中

请求示例

POST https://rtc.volcengineapi.com?Action=IsInBlackList&Version=2020-12-01
{
    "AppId": 000000,
    "UserId": 10001,
    "InboxType": 0,
    "BlackListUserIds": [
        10002,
        10003,
        10004
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "IsInBlackList",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "IsInBlackListInfos": {
            "10002": false,
            "10003": false,
            "10004": true
        }
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。