实时音视频
实时音视频
文档指南
请输入
实时音视频
快速入门
场景方案
开发指南
Token 鉴权
音频管理
视频管理
屏幕共享
SDK 升级指南
客户端 API 参考
服务端 API 参考
房间管理
转推直播
输入在线媒体流
WTN 流（原公共流）
实时数据监控
历史数据查询
业务标识管理
实时消息通信
历史版本（文档停止维护）
2023-08-01
2023-06-01
转推直播
2022-06-01
2020-12-01
转推直播
输入在线媒体流
获取数据指标
常见问题
集成相关
质量相关
AI 音视频互动方案
开发指南
配置 ASR/LLM/TTS 服务
API 参考
硬件对话智能体
用户指南
服务端 API
智能体
实时信令
互动白板
客户端 API 参考
服务端 API 参考
- 文档首页
实时音视频即时通讯 IM（文档隐藏发布-停止维护）服务端 API 参考服务端 OpenAPI用户相关黑名单管理更新黑名单 UpdateBlackList
复制全文
下载 pdf更新黑名单 UpdateBlackList
文档反馈
问问助手你可以使用此接口更新黑名单中的用户信息。
接口行为
你可以调用 UpdateBlackList 接口，指定你所属的 AppId、用户 ID 和黑名单中用户的 ID，更新黑名单用户的扩展信息。 一次最多支持更新 10 个好友。
调用接口
接口限制
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 | 是 | / | 黑名单用户 ID 及需要更新的扩展字段。一次最多更新 10 个黑名单用户的扩展字段。 |
BlackListUserInfo
参数名 | 类型 | 必填 | 示例值 | 描述 |
参数名 | 类型 | 必填 | 示例值 | 描述 |
BlackListUserId | Int | 是 | 100002 | 黑名单用户 ID |
BlackListUserExt | Map-key(string)-value(string) | 是 | {"key":"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
Body
{
"AppId":000000,
"UserId":10001,
"BlackListInfos":[
{
"BlackListUserId":10003,
"BlackListUserExt":{
"key1":"value2"
}
},
{
"BlackListUserId":10004,
"BlackListUserExt":{
"key1":"value2"
}
},
{
"BlackListUserId":10005,
"BlackListUserExt":{
"key2":"value2"
}
}
],
"InboxType":0
}
返回调用结果
返回参数说明
其中 Result 的结构如下：
参数名 | 类型 | 描述 |
参数名 | 类型 | 描述 |
FailedInfos | 更新失败的黑名单用户信息 |
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"
}
]
}
}
最近更新时间：2026.07.16 20:09:32
这个页面对您有帮助吗？
有用
有用
无用
无用