IM 即时通讯
Android
动态与公告
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
新手接入指南
产品介绍
简介
主要功能
产品优势
功能介绍
账号集成与登录
多端登录与互踢策略
群组功能
聊天室功能
聊天室标签功能
圈组功能
质量数据监控台
海外数据中心
IM平滑迁移方案
接口及业务限制
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
跑通圈组 Demo 源码
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能概览
快速集成 IM UIKit
组件导入
初始化
界面跳转
自定义用户信息
全局配置
会话列表相关
集成会话列表界面
会话列表事件监听
自定义会话列表界面 UI
会话列表 API 概览
会话消息相关
集成会话界面
会话界面事件监听
实现音视频通话
实现地理位置消息功能(含 UI)
实现自定义消息发送(含 UI)
自定义会话界面 UI
会话消息 API 概览
通讯录相关
集成通讯录界面
自定义通讯录界面 UI
通讯录界面事件监听
通讯录 API 概览
UIKit 功能实现方案
消息回复实现方案
UIKit 版本升级说明
系统兼容相关
IM UIKit 常见问题排查
IM UIKit API 概览
不含 UI 集成
使用说明
集成 SDK
初始化
登录相关
登录 IM
多端登录与互踢
登出 IM
消息相关
消息概述
消息收发
自定义消息收发
消息配置选项
NOS 存储场景
广播消息收发
消息已读回执
消息撤回
消息重发与转发
消息更新
消息过滤
语音消息处理
插入本地消息
历史消息
最近会话
服务端会话服务
用户资料
用户关系
在线状态订阅
系统通知
系统通知概述
内置系统通知管理
内置系统通知未读数
自定义系统通知收发
Android 离线推送
实现离线推送
配置消息的推送属性
设置群消息强制推送
设置推送全局免打扰
设置多端推送策略
集成小米推送
集成华为推送
集成荣耀推送
集成 OPPO 推送
集成 vivo 推送
集成魅族推送
集成谷歌推送(FCM)
消息提醒
实现消息提醒
配置消息提醒功能
设置群消息强制提醒
设置消息提醒文案
定制通知栏显示信息
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
聊天室
圈组功能
圈组概述
登录管理
服务器相关
服务器概述
服务器管理
服务器成员管理
游客功能
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
实时互动频道
频道分组
频道分组黑白名单
频道未读数管理
搜索服务器和频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
用户定制权限
频道分组身份组
自定义权限项
成员权限查询与判定
身份组相关查询
圈组订阅机制
圈组消息相关
图解圈组消息流转
圈组消息收发
消息发送配置项
圈组消息撤回
圈组消息更新
圈组消息删除
消息正在输入
会话消息回复(Thread)
圈组快捷评论
获取频道最后一条消息
查询历史消息
查询@我的消息
圈组消息缓存
圈组消息搜索
圈组系统通知相关
圈组系统通知概述
圈组系统通知收发
圈组系统通知更新
圈组离线推送
圈组内容审核
圈组相关抄送
圈组第三方回调
圈组各端接口命名差异
反垃圾(内容审核)
聊天扩展
接入第三方机器人
其他
最佳实践
IM 登录最佳实践
IM 应用隐私合规
聊天室重要消息投递
API 参考
Android SDK API
Android SDK 状态码/错误码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
配置应用客户端标识
添加推送证书
常见问题
FAQ
错题集
Android 端推送问题排查
第三方推送厂商的限制说明
服务协议

服务端会话服务

更新时间: 2023/03/28 14:54:53

服务端会话服务与本地最近会话不同,其提供了新的会话列表获取服务,需要从云端拉取,不支持同步到本地最近会话列表。

  • 服务器支持存储用户全量的会话历史列表以及保存最近一条消息;

  • 客户端获取会话列表,支持按照需要指定获取的会话数,不与本地会话合并;

  • 不支持未读数;

服务端最近会话对象原型为 RecentSession ,它记录了与用户最近有过会话的联系人信息,包括联系人帐号、最近一条消息的时间、扩展字段、消息内容等信息。

RecentSession接口说明

返回值 RecentSession 接口 说明
String getSessionId() 获取会话的ID(好友帐号,群ID等)
long getUpdateTime() 获取最近一条消息的时间戳
String getExt() 获取扩展字段
String getLastMsg() 获取最后一条消息的Json字符串
RevokeMsgNotification getRevokeNotification() 最后一条消息为撤回通知时,返回不是null
此时,可通过此接口获得一个RevokeMsgNotification实例,里面只有部分内容,或者为空
RecentContact toRecentContact 新建带有RecentSession信息的RecentContact
Pair<SessionTypeEnum, String> parseSessionId 从session中分离出会话id和会话类型
int getLastMsgType 最近一条消息的类型,0或者缺失表示普通消息,1表示消息撤回通知

服务端会话列表 RecentSessionList,记录了一页 RecentSession 数据,和是否有更早消息的提示。

RecentSessionList 接口说明:

返回值 RecentSessionList 接口 说明
boolean hasMore() 是否有更早的消息
List<RecentSession> getSessionList() 拉到的一页会话列表

获取会话列表

  • API 原型
/**
 * 【会话服务】增量获取会话列表,增量+翻页
 *
 * @param minTimestamp 最小时间戳,作为请求参数时表示增量获取Session列表,传0表示全量获取
 * @param maxTimestamp 最大时间戳,翻页时使用
 * @param needLastMsg  是否需要lastMsg,0或者1,默认1
 * @param limit        结果集limit,最大100,默认100
 * @param hasMore      没用
 * @return InvocationFuture
 * @deprecated
 * @see MsgService#queryMySessionList(QueryMySessionOption)
 */
InvocationFuture<RecentSessionList> queryMySessionList(long minTimestamp, Long maxTimestamp, Integer needLastMsg, Integer limit, Integer hasMore);

/**
 * 【会话服务】增量获取会话列表,增量+翻页
 *
 * @param option 配置参数
 * @return InvocationFuture
 */
InvocationFuture<RecentSessionList> queryMySessionList(QueryMySessionOption option);
  • 参数说明
参数 说明
minTimestamp 最小时间戳,增量获取Session列表,传0表示全量获取
maxTimestamp 最大时间戳,翻页时使用
needLastMsg 是否需要lastMsg,0或者1,默认1
limit 结果集limit,最大100,默认100
hasMore 没用
  • 示例
NIMClient.getService(MsgService.class).queryMySessionList(startTime, endTime, 1, queryAmount, 1).setCallback(new RequestMySessionListCallback(queryAmount, startTime, this::showSessionList));

获取指定会话

  • API 原型
/**
 * 【会话服务】获取某一个会话
 *
 * @param sessionId 分为p2p/team/superTeam,格式分别是:p2p|accid、team|tid、super_team|tid
 * @return InvocationFuture
 * @see com.netease.nimlib.biz.constant.ITalkService.SessionTag
 */
InvocationFuture<RecentSession> queryMySession(@NonNull String sessionId);
  • 参数说明
参数 说明
sessionId 分为p2p/team/superTeam
  • 示例
NIMClient.getService(MsgService.class).queryMySession(sessionId).setCallback(new RequestCallback<RecentSession>() {
            @Override
            public void onSuccess(RecentSession param) {
                resultTV.setText(sessionToString(param));
            }

            @Override
            public void onFailed(int code) {
                Toast.makeText(SessionActivity2.this, "获取单条会话失败, code=" + code, Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onException(Throwable exception) {
                exception.printStackTrace();
                Toast.makeText(SessionActivity2.this, "获取单条会话出现异常, msg=" + exception.getMessage(), Toast.LENGTH_SHORT).show();
            }
        });

修改服务端会话扩展

  • API 原型
/**
 * 【会话服务】更新某一个会话,主要是设置会话的ext字段,如果会话不存在,则会创建出来,此时会话没有lastMsg
 *
 * @param sessionId 分为p2p/team/superTeam,格式分别是:p2p|accid、team|tid、super_team|tid
 * @param ext       会话的扩展字段,仅自己可见
 * @return InvocationFuture
 * @see com.netease.nimlib.biz.constant.ITalkService.SessionTag
 */
InvocationFuture<Void> updateMySession(@NonNull String sessionId, @NonNull String ext);
  • 参数说明
参数 说明
sessionId 分为p2p/team/superTeam
ext 会话的扩展字段,仅自己可见
  • 示例
NIMClient.getService(MsgService.class).updateMySession(sessionIdET.getText().toString(), extET.getText().toString()).setCallback(new RequestCallback<Void>() {
            @Override
            public void onSuccess(Void param) {
                Toast.makeText(SessionActivity2.this, "更新会话成功", Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onFailed(int code) {
                Toast.makeText(SessionActivity2.this, "更新会话失败, code=" + code, Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onException(Throwable exception) {
                Toast.makeText(SessionActivity2.this, "更新会话出现异常, msg=" + exception.getMessage(), Toast.LENGTH_SHORT).show();
            }
        });

删除服务端会话

  • API 原型
/**
* 【会话服务】删除会话
*
* @param sessionIdArr 每一项的格式:分为p2p/team/superTeam,格式分别是:p2p|accid、team|tid、super_team|tid
* @return InvocationFuture
* @see com.netease.nimlib.biz.constant.ITalkService.SessionTag
*/
InvocationFuture<Void> deleteMySession(@NonNull String[] sessionIdArr);
  • 参数说明
参数 说明
sessionIdArr 每一项:分别为p2p/team/superTeam
  • 示例
NIMClient.getService(MsgService.class).deleteMySession(selectedArr).setCallback(new RequestCallback<Void>() {
            @Override
            public void onSuccess(Void param) {
                Toast.makeText(SessionActivity2.this, "删除会话成功", Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onFailed(int code) {
                Toast.makeText(SessionActivity2.this, "删除会话失败, code=" + code, Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onException(Throwable exception) {
                exception.printStackTrace();
                Toast.makeText(SessionActivity2.this, "删除会话出现异常, msg=" + exception.getMessage(), Toast.LENGTH_SHORT).show();
            }
        });
此文档是否对你有帮助?
有帮助
我要吐槽
  • 获取会话列表
  • 获取指定会话
  • 修改服务端会话扩展
  • 删除服务端会话