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/23 11:13:11

网易云信即时通讯 NIM SDK 的QChatServerService接口提供搜索圈组的服务器和服务器成员的方法,QChatChannelService接口提供搜索频道和频道成员的方法。

SDK 还支持配置搜索结果的排序规则,如搜索出的服务器列表可按时间和人数等维度排序,也可自定义排序。

应用场景

圈组的搜索能力和配套的搜索结果排序能力,可满足您的应用的特定运营需求,如:

  • 通过按人数排序,将热门社区(对应圈组服务器)展示在用户搜索结果的前列,方便用户加入热门社区。
  • 通过自定义排序,将广告位性质的话题(对应频道)展示在用户搜索结果的前列,增加流量引入。

技术原理

搜索数据来源

下图左侧所示事件发生后,将触发相关消息通过消息队列(Message Queue)通知云信搜索服务器,搜索服务器把相关的事件数据保存或更新到 Elasticsearch。

由于整个数据传送过程都是通过消息队列生产消费,且 Elasticsearch 的数据每秒刷新一次,所以整体的搜索数据存在一定的延迟(正常 3 秒内)。

圈组搜索原理.png

与服务器的关联逻辑

服务器创建、更新、查询等方法(包括createServerupdateServer),入参包含searchEnablesearchType

参数 说明
searchEnable 服务器是否允许被搜索,true-允许,false-不允许,默认允许
searchType 服务器搜索类型,客户自定义,大于等于 0 的整数。 0 代表无类型

前提条件

开始搜索功能集成前,请确保您已:

  • 开通圈组搜索功能。
    可在云信控制台开通该功能在云信控制台选择应用,进入IM 免费版/专业版 > 功能权限开通 > 拓展配置 > 圈组 > 搜索功能即可配置。
  • 创建圈组服务器。
  • 创建频道。

实现方法

搜索服务器

调用 searchServerByPage方法可搜索服务器,返回在startTimeendTime之间的时间段内创建并与keyword匹配的服务器。

该方法的入参如下表所示:

参数
必传 类型 说明
keyword String 目标检索服务器名称的关键字,最大长度 100 字符,支持模糊搜索。关键字必须为连续字符串,? 和 * 会被忽略。
例子:假设服务器的名称为“网易云信专属服务器”,用户使用如下三个关键字进行搜索,keyword1=“网易云信”,keyword2=“专属服”,keyword3=“网专属”,keyword4=“网易 云信”,那么只有 keyword1 和 keyword2 能搜索到该服务器
asc boolean true-升序,false-降序
searchType QChatSearchServerTypeEnum 配置搜索类型:
startTime Long 查询时间范围的开始时间
endTime Long 查询时间范围的结束时间,必须比开始时间晚
limit Integer 每页结果条数,最大和默认都是 100
serverTypes List 服务器类型,对应创建服务器时传入的searchType
sort QChatServerSearchSortEnum
  • 服务器的排序条件,默认为按创建时间倒序排序,即最新创建的服务器排在最前
  • 如需实现搜索结果自定义排序,请参照下文的搜索结果自定义排序中的说明进行配置
cursor String 游标, 搜索的起始位置

全局搜索服务器

全局搜索集成圈组的应用内的所有服务器,包括已加入的和未加入的服务器。

全局搜索仅能搜索到“允许被搜索”的服务器。

  • 示例代码

    QChatSearchServerByPageParam param = new QChatSearchServerByPageParam("keyword", true, QChatSearchServerTypeEnum.Square);
    NIMClient.getService(QChatServerService.class).searchServerByPage(param).setCallback(new RequestCallback<QChatSearchServerByPageResult>() {
        @Override
        public void onSuccess(QChatSearchServerByPageResult result) {
            //成功
        }
    
        @Override
        public void onFailed(int code) {
            // 失败
        }
    
        @Override
        public void onException(Throwable exception) {
            // 出现异常
        }
    });
    

搜索已加入的服务器

  • 示例代码

    QChatSearchServerByPageParam param = new QChatSearchServerByPageParam("keyword", true, QChatSearchServerTypeEnum.Personal);
    NIMClient.getService(QChatServerService.class).searchServerByPage(param).setCallback(new RequestCallback<QChatSearchServerByPageResult>() {
        @Override
        public void onSuccess(QChatSearchServerByPageResult result) {
            //成功
        }
    
        @Override
        public void onFailed(int code) {
            // 失败
        }
    
        @Override
        public void onException(Throwable exception) {
            // 出现异常
        }
    });
    

搜索服务器成员

调用searchServerMemberByPage方法搜索服务器成员。

参数
必传 类型 说明
keyword String 目标成员的昵称或 IM 账号的关键字,最大 100 个字符,支持模糊搜索,模糊搜索的限制同上文提及的搜索服务器的 keyword
serverId long 服务器 ID
limit Integer 每页结果条数,最大和默认都是 100

示例代码

QChatSearchServerMemberByPageParam param = new QChatSearchServerMemberByPageParam("keyword", 123456L);
NIMClient.getService(QChatServerService.class).searchServerMemberByPage(param).setCallback(new RequestCallback<QChatSearchServerMemberByPageResult>() {
    @Override
    public void onSuccess(QChatSearchServerMemberByPageResult result) {
        //成功
    }

    @Override
    public void onFailed(int code) {
        // 失败
    }

    @Override
    public void onException(Throwable exception) {
        // 出现异常
    }
});

搜索频道

调用searchChannelByPage方法搜索对当前用户可见的频道(即当前用户未被加入黑名单的公开频道和已被加入白名单的私密频道)。

参数
必传 类型 说明
keyword String 目标检索的频道名称的关键字,最大长度 100 字符,支持模糊搜索,模糊搜索的限制同上文提及的搜索服务器的 keyword
asc boolean 排序规则 1: ASC 2: DESC
startTime Long 查询时间范围的开始时间
endTime Long 查询时间范围的结束时间,要求比开始时间大
limit Integer 每页结果条数,最大和默认都是 100
serverId Long 不填时查询所有服务器下的频道,填写时查询指定服务器下的频道
sort QChatChannelSearchSortEnum
  • 频道的排序条件,默认为按创建时间倒序排序,即最新创建的频道排在最前
  • 如需实现搜索结果自定义排序,请参照下文的搜索结果自定义排序中的说明进行配置
cursor string 游标, 搜索的起始位置

示例代码

QChatSearchChannelByPageParam param = new QChatSearchChannelByPageParam("keyword", true);
param.setServerId(123456L);
NIMClient.getService(QChatChannelService.class).searchChannelByPage(param).setCallback(new RequestCallback<QChatSearchChannelByPageResult>() {
    @Override
    public void onSuccess(QChatSearchChannelByPageResult result) {
        //成功
    }

    @Override
    public void onFailed(int code) {
        // 失败
    }

    @Override
    public void onException(Throwable exception) {
        // 出现异常
    }
});

搜索频道成员

调用searchChannelMembers方法搜索频道成员。

参数
必传 类型 说明
keyword String 目标成员的昵称或 IM 账号的关键字,最大 100 个字符,支持模糊搜索,模糊搜索的限制同上文提及的搜索服务器的 keyword
serverId long 服务器 ID
channelId long 频道 ID
limit Integer 检索返回的最大记录数,最大和默认都是 100

示例代码

QChatSearchChannelMembersParam param = new QChatSearchChannelMembersParam(123L, 456L, "keyword");
NIMClient.getService(QChatChannelService.class).searchChannelMembers(param).setCallback(
		new RequestCallback<QChatSearchChannelMembersResult>() {
			@Override
			public void onSuccess(QChatSearchChannelMembersResult result) {
				// 成功
			}

			@Override
			public void onFailed(int code) {
				// 失败
			}

			@Override
			public void onException(Throwable exception) {
				// 出现异常
			}
		});

搜索结果自定义排序

创建服务器成功后返回的QChatCreateServerResult中的QChatServer包含服务器的自定义排序权重信息(ReorderWeight),默认为 0。同样的,创建频道成功后返回的QChatCreateChannelResult中的QChatChannel包含频道的自定义排序权重信息(ReorderWeight),默认为 0。自定义排序权重值,目前仅支持通过服务器端 API 修改。

服务器自定义排序

实现服务器搜索结果自定义排序的流程如下:

  1. 调用服务端 API (qchat/batchUpdateServerReorderWeight.action)修改服务器的自定义排序权重值。

    调用该 API 单次可修改权重的服务器的数量上限默认为 10。如需调整该上限,请通过云信官网首页的在线聊天、微信和电话等联系方式咨询商务经理。

  2. 调用searchServerByPage方法搜索服务器。调用时除了必传的入参keywordsearchTypeasc外,还需传入sort,且将其设置为ReorderWeight

    结果

    • asc为默认倒序,则匹配的服务器列表以权重值倒序排列,相同权重的服务器按serverId倒序排列。
    • asc为正序,则按权重值正序排序,相同权重的按serverId倒序排列。

频道自定义排序

实现频道搜索结果自定义排序的流程如下:

  1. 调用服务端 API (qchat/batchUpdateChannelReorderWeight.action)修改频道的自定义排序权重默认值。

    调用该 API 单次可修改权重值的频道的数量上限默认为 10。如需调整该上限,请通过云信官网首页的在线聊天、微信和电话等联系方式咨询商务经理。

  2. 调用searchChannelByPage方法搜索频道。调用时除了必传的入参keywordasc外,还需传入sort,且将其设置为ReorderWeight

    结果

    • asc为默认倒序,则匹配的频道列表以权重值倒序排列,相同权重的频道按channelId倒序排列。
    • asc为正序,则按权重值正序排序,相同权重的按channelId倒序排列。

API 参考

API
说明
searchServerByPage 分页搜索服务器
searchServerMemberByPage 分页搜索服务器成员
searchChannelByPage 分页搜索频道
searchChannelMembers 搜索频道成员
qchat/batchUpdateServerReorderWeight.action 修改服务器的自定义排序权重值
qchat/batchUpdateChannelReorderWeight.action 修改频道的自定义排序权重值
此文档是否对你有帮助?
有帮助
我要吐槽
  • 应用场景
  • 技术原理
  • 搜索数据来源
  • 与服务器的关联逻辑
  • 前提条件
  • 实现方法
  • 搜索服务器
  • 全局搜索服务器
  • 搜索已加入的服务器
  • 搜索服务器成员
  • 搜索频道
  • 搜索频道成员
  • 搜索结果自定义排序
  • 服务器自定义排序
  • 频道自定义排序
  • API 参考