IM 即时通讯
Web
产品介绍
简介
主要功能
产品优势
海外数据中心
IM平滑迁移方案
接口及业务限制
功能介绍
帐号集成与登录
基础消息功能
群组功能
聊天室功能
聊天室标签功能
多端登录与互踢策略
质量数据监控台
体验 Demo
下载 SDK 与 Demo 源码
更新日志
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
快速开始
跑通 IM Demo 源码
实现 IM 文本消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能概览
快速集成 IM UIKit
非React框架集成 IM UIKit
组件导入
初始化
全局上下文
登录相关
实现消息收发及界面自定义
集成会话列表界面
集成会话消息界面
集成用户资料组件
集成通讯录界面
集成搜索组件
非 React 框架自定义渲染
主题样式设置
语言设置
初始化(兼容 NIM SDK)
不含 UI 集成
集成 SDK
浏览器环境集成
Node.js集成
初始化与登录相关
初始化与登录 IM
IM 连接相关
多端登录与互踢
消息相关
消息概述
消息收发
消息配置选项
广播消息收发
消息已读回执
消息撤回
消息重发与转发
本地消息
通知消息
群通知消息
超大群通知消息
历史消息
最近会话
用户资料托管
好友关系托管
用户关系托管
在线状态订阅
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
系统通知
系统通知概述
内置系统通知管理
内置系统通知未读数
自定义系统通知收发
开通聊天室功能
聊天室
反垃圾(内容审核)
域名高可用
融合存储方案
扩展功能
工具方法
最佳实践
聊天室重要消息投递
API参考
SDK API (Web)
IM UIKit Store API
状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
配置应用客户端标识
常见问题
FAQ
服务协议

扩展功能

更新时间: 2022/05/17 17:47:12

扩展功能提供了一些IM相关的扩展功能,比如:消息回复、消息快捷评论、会话置顶、收藏夹、会话消息PIN等等

消息回复(thread)

消息回复指可以对一条已有的消息进行回复。如下图,消息 B 是对消息 A 的回复,消息 C 是对消息 B1 的回复。则消息 B 是消息 A 的子消息,消息 C 是消息 B1 的子消息,消息 A 是消息 B 和消息 C 的根消息,我们称消息 A、B、C 为 thread 消息

消息回复

一条IM消息可以有0或者一条父消息,可以有0或者n条子消息。当一条消息既没有父消息,也没有子消息时,称之为普通消息,反之有超过0条的父消息或子消息时称之为thread消息,没有特殊说明的消息是普通消息。

除了thread消息的根消息外(如上图中的A),所有的thread消息对象都有threadMsgFromAccountthreadMsgToAccountthreadMsgTimethreadMsgIdServerthreadMsgIdClientreplyMsgFromAccountreplyMsgToAccountreplyMsgTimereplyMsgIdServerreplyMsgIdClient十个属性,代表thread根消息和父消息的fromtotimeidServeridClient

若未开通回复功能,回复时系统会自动将所发消息转换为一条普通消息。若需要 thread 回复能力,请联系商务经理开通。

回复一条消息

发送消息时添加replyMsg参数

var msgA = {
  scene: 'p2p',
  from: 'cs2',
  to: 'cs1',
  time: 1589179595804,
  type: 'text',
  sessionId: 'p2p-cs2',
  target: 'cs2',
  flow: 'in',
  status: 'success',
  text: 'hello world!',
  idClient: '1296612f2562e916be8fc4fdbc9e938e',
  idServer: '2798262',
}
nim.sendText({
  scene: 'p2p',
  to: 'cs2',
  text: 'reply hello world',
  replyMsg: msgA,
  done: (e, r) => console.log(e ? '发送消息失败' : '发送消息成功')
})

获取thread消息列表getThreadMsgs

API文档:getThreadMsgs

根据idServer批量查询服务器消息

API文档:getMsgsByIdServer

消息快捷评论

不同于消息,评论只有几个简单的字段,可以删除,不计入未读数。快捷评论模型

注:如需开通该功能,请联系商务经理

添加评论

对一条消息进行快捷评论,对于同一个添加者,同一条消息的同一类型只能添加一次,前面的会被后添加的评论覆盖。

API文档:addQuickComment

删除评论

只能删除自己添加的快捷评论

API文档:deleteQuickComment

查询消息的快捷评论列表

可批量查询,即同时查询多个消息的评论列表

API文档:getQuickComments

收藏功能

收藏的模型对象

增加一个收藏

API文档:addCollect

批量删除收藏

API文档:deleteCollects

查询收藏列表

API文档:getCollects

会话置顶功能

被置顶会话对象isTop属性为true,会话是置顶状态时,也可设置或更新其置顶扩展字段topCustom

除了实现会话置顶外,该功能配合其扩展字段也可用来实现会话盒子、会话分类等多种花样功能

新增置顶会话

API文档:addStickTopSession

更新置顶会话的扩展字段

API文档:updateStickTopSession

取消会话置顶

API文档:deleteStickTopSession

获取置顶会话列表

API文档:getStickTopSessions

会话消息PIN标记

可以给消息添加PIN标记,称之为PIN消息。之后可以根据会话ID查询会话下的所有PIN消息,每个会话的PIN消息有上限

注:如需开通该功能,请联系商务经理

新增PIN一条消息

API文档:addMsgPin

更新PIN消息的扩展字段

API文档:updateMsgPin

取消PIN一条消息,即unPin

API文档:deleteMsgPin

获取会话的PIN消息列表

API文档:getMsgPins

此文档是否对你有帮助?
有帮助
我要吐槽
  • 消息回复(thread)
  • 回复一条消息
  • 获取thread消息列表getThreadMsgs
  • 根据idServer批量查询服务器消息
  • 消息快捷评论
  • 添加评论
  • 删除评论
  • 查询消息的快捷评论列表
  • 收藏功能
  • 增加一个收藏
  • 批量删除收藏
  • 查询收藏列表
  • 会话置顶功能
  • 新增置顶会话
  • 更新置顶会话的扩展字段
  • 取消会话置顶
  • 获取置顶会话列表
  • 会话消息PIN标记
  • 新增PIN一条消息
  • 更新PIN消息的扩展字段
  • 取消PIN一条消息,即unPin
  • 获取会话的PIN消息列表