You need to enable JavaScript to run this app.
导航
添加黑名单 AddBlackList
最近更新时间:2023.11.27 20:36:34首次发布时间:2023.09.25 19:45:01

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

接口行为

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

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名类型必填示例值描述
ActionStringAddBlackList接口名称,本接口取值:AddBlackList
VersionString2020-12-01接口版本,本接口取值:2020-12-01

Body

参数名类型必填示例值描述
AppIdInt000000应用的唯一标志
UserIdInt10001用户 ID
InboxTypeInt0信箱,用做逻辑隔离。默认值为 0
BlackListInfosArray of BlackListUserInfo/需要加入黑名单的 UserId 及每个用户对应的扩展信息,一次最多添加 10 个用户至黑名单

BlackListUserInfo

参数名类型必填示例值描述
BlackListUserIdInt10002加入黑名单的用户 ID
BlackListUserExtMap-key(string)-value(string){"key":"value"}黑名单用户扩展字段

请求示例代码

Query

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

Body

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

返回调用结果

返回参数说明

返回结果参看 BaseResponse

其中 Result 的结构如下:

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

FailedInfo

参数名类型描述
UserIdInt添加黑名单失败的用户的 ID
CodeString错误码
MessageString错误描述

正常返回示例

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