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

接口行为

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

调用接口

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

接口限制

QPS 不得超过 100。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名	类型	必填	示例值	描述
Action	String	是	`IsInBlackList`	接口名称，本接口取值：`IsInBlackList`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`

Body

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

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "UserId":10001,
    "InboxType":0,
    "BlackListUserIds":[10002,10003,10004]
}
json

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名	类型	描述
IsInBlackListInfos	Map-key(string)-value(bool)	校验结果。 value 为 `true`：在黑名单中。 value 为 `false`：不在黑名单中

正常返回示例

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