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
聚焦模式
字号
最后更新时间: 2025-03-03 15:24:45

功能描述

通过设置单聊和群聊的消息接收选项,可以实现消息免打扰的功能。
Chat SDK 支持三种类型的消息接收选项:
消息接收选项
功能描述
在线时正常接收消息,离线时接收离线推送通知
SDK 接收消息并通知接入侧(抛出 TencentCloudChat.EVENT.MESSAGE_RECEIVED 事件),接入侧不做提示,一般用于实现“消息免打扰”
SDK 拒收消息
在线接收消息,离线仅接收群 @消息 的推送
SDK 仅接收 @消息(仅适用于话题)

setMessageRemindType

说明:
1. 作为群成员,可设置自己所在群的消息提示类型。
2. “消息免打扰”,一般的实现是在线接收消息,离线不接收消息(在有离线推送的情况下)。
3. “拒收消息”,即在线和离线都不接收消息,对端发送的消息可通过 getMessageList 获取到。
4. 该接口支持设置社群话题的消息提示类型,groupID 传入 topicID 即可,如果话题所属社群设置为 TencentCloudChat.TYPES.MSG_REMIND_DISCARD,则会忽略话题的设置。
5. 支持群会话消息和话题消息的提醒类型多终端、多实例同步。
接口
chat.setMessageRemindType(options);
参数
参数 optionsObject类型,包含的属性值如下:
Name
Type
Description
groupID
String
群 ID 或 话题 ID
userIDList
Array
C2C 会话对端 userID 列表,单次请求的 userID 数不得超过30
messageRemindType
String
群消息提示类型。详细如下:
TencentCloudChat.TYPES.MSG_REMIND_ACPT_AND_NOTE(SDK 接收消息并通知接入侧(抛出 MESSAGE_RECEIVED 事件),接入侧做提示)
TencentCloudChat.TYPES.MSG_REMIND_ACPT_NOT_NOTE(SDK 接收消息并通知接入侧(抛出 MESSAGE_RECEIVED 事件),接入侧不做提示,一般用于实现“消息免打扰”)
TencentCloudChat.TYPES.MSG_REMIND_DISCARD(SDK 拒收消息)
TencentCloudChat.TYPES.NOT_RECEIVE_OFFLINE_PUSH_EXCEPT_AT(在线接收消息,离线仅接收群 @消息 的推送)
TencentCloudChat.TYPES.NOT_RECEIVE_MSG_EXCEPT_AT(SDK 仅接收话题 @消息 并通知接入侧)
返回值
Promise
示例
// 拒收群消息(通过 getMessageList 接口可拉取到其他群成员发送的消息)
let promise = chat.setMessageRemindType({
groupID: 'group1',
messageRemindType: TencentCloudChat.TYPES.MSG_REMIND_DISCARD
});
promise.then(function(imResponse) {
// 设置成功后 SDK 会触发 TencentCloudChat.EVENT.CONVERSATION_LIST_UPDATED 事件
// (遍历列表,并读取 Conversation.messageRemindType)
}).catch(function(imError) {
console.warn('setMessageRemindType error:', imError);
});
// 拒收群消息后,重新开启新消息提醒
let promise = chat.setMessageRemindType({
groupID: 'group1',
messageRemindType: TencentCloudChat.TYPES.MSG_REMIND_ACPT_AND_NOTE
});
promise.then(function(imResponse) {
// 设置成功后 SDK 会触发 TencentCloudChat.EVENT.CONVERSATION_LIST_UPDATED 事件
// (遍历列表,并读取 Conversation.messageRemindType)
}).catch(function(imError) {
console.warn('setMessageRemindType error:', imError);
});
// C2C 消息免打扰,一般的实现是在线接收消息,离线不接收消息(在有离线推送的情况下)
let promise = chat.setMessageRemindType({
userIDList: ['user1', 'user2'],
messageRemindType: TencentCloudChat.TYPES.MSG_REMIND_ACPT_NOT_NOTE
});
promise.then(function(imResponse) {
// 设置成功后 SDK 会触发 TencentCloudChat.EVENT.CONVERSATION_LIST_UPDATED 事件
//(遍历列表,并读取 Conversation.messageRemindType)
const { successUserIDList, failureUserIDList } = imResponse.data;
// 删除成功的 userIDList
successUserIDList.forEach((item) => {
const { userID } = item;
});
// 删除失败的 userIDList
failureUserIDList.forEach((item) => {
const { userID, code, message } = item;
});
}).catch(function(imError) {
console.warn('setMessageRemindType error:', imError);
});
// 群消息免打扰,一般的实现是在线接收消息,离线不接收消息(在有离线推送的情况下)
let promise = chat.setMessageRemindType({
groupID: 'group1',
messageRemindType: TencentCloudChat.TYPES.MSG_REMIND_ACPT_NOT_NOTE
});
promise.then(function(imResponse) {
// 设置消息免打扰成功
}).catch(function(imError) {
// 设置消息免打扰失败
console.warn('setMessageRemindType error:', imError);
});
// 社群话题消息免打扰,一般的实现是在线接收消息,离线不接收消息(在有离线推送的情况下)
let promise = chat.setMessageRemindType({
groupID: 'topicID',
messageRemindType: TencentCloudChat.TYPES.MSG_REMIND_ACPT_NOT_NOTE
});
promise.then(function(imResponse) {
// 设置消息免打扰成功
}).catch(function(imError) {
// 设置消息免打扰失败
console.warn('setMessageRemindType error:', imError);
});
// 设置用户在线时,话题仅接收 @消息(@我和@所有人的消息) let promise = chat.setMessageRemindType({
groupID: 'topicID',
messageRemindType: TencentCloudChat.TYPES.NOT_RECEIVE_MSG_EXCEPT_AT
}); promise.then(function(imResponse) { // 设置成功 }).catch(function(imError) { // 设置失败 console.warn('setMessageRemindType error:', imError); });


帮助和支持

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

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

文档反馈