你可以使用此接口添加黑名单用户。

接口行为

你可以调用 AddBlackList 接口，指定你所属的 AppId、用户 ID 和对方的用户 ID，将对方加入黑名单。一次最多支持添加 10 个用户至黑名单。

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
UserId	Int	是	`10001`	用户 ID
InboxType	Int	否	`0`	信箱，用做逻辑隔离。默认值为 `0`
BlackListInfos	Array of BlackListUserInfo	是	/	需要加入黑名单的 UserId 及每个用户对应的扩展信息，一次最多添加 10 个用户至黑名单

BlackListUserInfo

参数名	类型	必填	示例值	描述
BlackListUserId	Int	是	`10002`	加入黑名单的用户 ID
BlackListUserExt	Map-key(string)-value(string)	是	`{"key":"value"}`	黑名单用户扩展字段

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "UserId":10001,
    "InboxType":0,
    "BlackListInfos":[
    {
        "BlackListUserId":10002,
        "BlackListUserExt":{
            "key":"value"
        }
    },
    {
        "BlackListUserId":10003,
        "BlackListUserExt":{
            "key":"value"
        }
    },
    {
        "BlackListUserId":10004,
        "BlackListUserExt":{
            "key":"value"
        }
    }]
}
json

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名	类型	描述
FailedInfos	Array of FailedInfo	添加黑名单失败的用户信息

FailedInfo

参数名	类型	描述
UserId	Int	添加黑名单失败的用户的 ID
Code	String	错误码
Message	String	错误描述

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "AddBlackList",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "FailedInfos": [
            {
                "UserId": 10005,
                "Code": "AddSelfNotAllow", // 无法添加自己到黑名单中
                "Message": "add self not allow"
            },
            {
                "UserId": 10006,
                "Code": "AlreadyOnTheBlackList", // 该用户已经存在黑名单中
                "Message": "user already on the blacklist"
            }
        ]
    }
}
json