你可以使用此接口更新黑名单中的用户信息。

接口行为

你可以调用 UpdateBlackList 接口，指定你所属的 AppId、用户 ID 和黑名单中用户的 ID，更新黑名单用户的扩展信息。一次最多支持更新 10 个好友。

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

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

BlackListUserInfo

参数名	类型	必填	示例值	描述
BlackListUserId	Int	是	`100002`	黑名单用户 ID
BlackListUserExt	Map-key(string)-value(string)	是	`{"key":"value"}`	黑名单用户的扩展字段，支持新增 key 和更新已有 key。更新已有 key 时，新 value 会覆盖旧 value。参看示例

示例：
假设 ID 为 10002 的黑名单用户原 ext 为 {"key1":"value1"}，

若调用本接口通过 BlackListUserExt 传入 {"key1":"value2"}，此时 10002 用户的 ext 将更新为 {"key1":"value2"}；
若调用本接口通过 BlackListUserExt 传入 {"key2":"value2"}，此时 10002 用户的 ext 将更新为 {"key1":"value1", "key2":"value2"}。

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "UserId":10001,
    "BlackListInfos":[
        {
            "BlackListUserId":10003,
            "BlackListUserExt":{
                "key1":"value2"
            }
        },
        {
            "BlackListUserId":10004,
            "BlackListUserExt":{
                "key1":"value2"
            }
        },
        {
            "BlackListUserId":10005,
            "BlackListUserExt":{
                "key2":"value2"
            }
        }
    ],
    "InboxType":0
}
json

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

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

FailedInfo

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

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "UpdateBlackList",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "FailedInfos": [
            {
                "UserId": 10002,
                "Code": "InvalidParam", // 参数非法
                "Message": "black user ext is empty: invalid param"
            },
            {
                "UserId": 10003,
                "Code": "NotInTheBlackList", // 对方不在黑名单中
                "Message": "user not in the blacklist"
            },
            {
                "UserId": 10005,
                "Code": "NotInTheBlackList", // 对方不在黑名单中
                "Message": "user not in the blacklist"
            }
        ]
    }
}
json