tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

JavaScript

PDF
聚焦模式
字号
最后更新时间: 2024-11-15 11:07:32

功能描述

如果您需屏蔽某人的消息,可以把该用户拉入黑名单。
说明:
1. 黑名单列表上限1000,且不可调整。
2. 如果您需要将好友加入黑名单后仍保留好友关系,请到 Chat 控制台,找到相应 SDKAppID,Chat > Configuration > Friends and Relationship >
Block configuration,选择 Remain Friends

拉黑某人

添加用户到黑名单列表。将用户加入黑名单后可以屏蔽来自 TA 的所有消息,因此该接口可以实现“屏蔽该用户消息”的功能。
如果用户 A 与用户 B 之间存在好友关系,拉黑时会解除双向好友关系。
如果用户 A 与用户 B 之间存在黑名单关系,二者之间无法发起会话。
如果用户 A 与用户 B 之间存在黑名单关系,二者之间无法发起加好友请求。
接口
chat.addToBlacklist(options);
参数
参数 optionsObject 类型,包含的属性值如下:
参数
类型
说明
userIDList
Array
待添加为黑名单的用户 userID 列表,单次请求的 userID 数不得超过1000
返回值
Promise
示例
// 请注意:即使只添加一个用户账号到黑名单,也需要用数组类型,例如:userIDList: ['user1']
let promise = chat.addToBlacklist({userIDList: ['user1', 'user2']});
promise.then(function(imResponse) {
console.log(imResponse.data); // 成功添加到黑名单的账号信息,结构为包含用户 userID 的数组 - [userID]
}).catch(function(imError) {
console.warn('addToBlacklist error:', imError); // 添加用户到黑名单列表失败的相关信息
});

解除拉黑

从黑名单中移除对方后可再次接收对方的消息。
接口
chat.removeFromBlacklist(options);
参数
参数 optionsObject类型,包含的属性值如下:
参数
类型
说明
userIDList
Array
待从黑名单中移除的 userID 列表,单次请求的 userID 数不得超过1000
返回值
Promise
示例
// 请注意:即使只从黑名单中移除一个用户账号,也需要用数组类型,例如:userIDList: ['user1']
let promise = chat.removeFromBlacklist({userIDList: ['user1', 'user2']});
promise.then(function(imResponse) {
console.log(imResponse.data); // 从黑名单中成功移除的账号列表,结构为包含用户 userID 的数组 - [userID]
}).catch(function(imError) {
console.warn('removeFromBlacklist error:', imError); // 将用户从黑名单中移除失败的相关信息
});

获取黑名单列表

获取 SDK 缓存的黑名单。
接口
chat.getBlacklist();
参数
返回值
Promise
示例
let promise = chat.getBlacklist();
promise.then(function(imResponse) {
console.log(imResponse.data); // 我的黑名单列表,结构为包含用户 userID 的数组 - [userID]
}).catch(function(imError) {
console.warn('getBlacklist error:', imError); // 获取黑名单列表失败的相关信息
});

黑订单列表变更通知

当黑名单有更新时,SDK会派发TencentCloudChat.EVENT.BLACKLIST_UPDATED事件。
let onBlacklistUpdated = function(event) {
console.log(event.data);
};
chat.on(TencentCloudChat.EVENT.BLACKLIST_UPDATED, onBlacklistUpdated);


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈