IM 即时通讯(增强版)
Web
新手接入指南
产品介绍
简介
产品优势
主要功能
功能介绍
账号集成与登录
基础消息功能
群组功能
聊天室功能
圈组功能
多端登录与互踢策略
海外数据中心
IM 平滑迁移方案
接口及业务限制
更新日志
IM UIKit 更新日志
NIM SDK 更新日志
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能列表
快速集成 IM UIKit
非React框架集成 IM UIKit
组件导入
初始化
全局上下文
登录相关
实现消息收发及界面自定义
集成会话列表界面
集成会话消息界面
集成用户资料组件
集成通讯录界面
集成搜索组件
非 React 框架自定义示渲染
主题样式设置
语言设置
初始化(兼容 NIM SDK)
不含 UI 集成
SDK 集成概述
小程序环境集成声明
初始化与登录
消息收发
历史消息
消息扩展
最近会话
用户资料托管
好友关系托管
在线状态订阅
系统通知
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
超大群概述
超大群管理
超大群成员管理
超大群消息管理
反垃圾
聊天室功能
聊天室概述
聊天室标签功能
快速实现聊天室登录
聊天室消息管理
聊天室成员管理
聊天室信息管理
聊天室队列服务
圈组功能
圈组概述
初始化与登录
通用接口校验说明
服务器相关
服务器概述
服务器管理
服务器成员管理
游客功能
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
频道分组
频道分组黑白名单
频道未读数管理
实时互动频道
搜索服务器与频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
频道用户定制权限
频道分组身份组
自定义权限项
成员权限查询与判定
身份组相关查询
圈组订阅机制
圈组消息相关
圈组消息收发
圈组消息撤回
圈组消息更新
圈组消息删除
消息正在输入
获取频道最后一条消息
会话消息回复(Thread)
圈组快捷评论
圈组消息搜索
查询历史消息
查询@我的消息
圈组系统通知相关
圈组系统通知概述
圈组系统通知收发
圈组系统通知更新
圈组内容审核
圈组第三方回调
圈组相关抄送
圈组各端接口命名差异
融合存储方案
uniapp 推送相关
最佳实践
聊天室重要消息投递
API 参考
NIM SDK API 参考
状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
服务协议

搜索服务器与频道

更新时间: 2023/03/14 15:17:02

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

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

在开通圈组功能后,圈组搜索相关能力还需再单独开通才可调用,您可通过云信官网提供的联系方式咨询商务经理开通。

应用场景

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

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

技术原理

搜索数据来源

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

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

圈组搜索原理.png

与服务器信息的关联逻辑

定义服务器的serverInfo结构体,包含searchEnablesearchType

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

前提条件

在进行圈组搜索功能集成前,请确保您已:

  • 开通圈组搜索功能。如尚未开通,您可通过云信官网首页提供的在线咨询、微信或电话等方式联系商务经理开通该功能。
  • 创建圈组服务器。
  • 创建频道。

搜索服务器

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

入参 必传 类型 说明
keyword string 目标检索服务器名称的关键字,最大长度 100 字符,支持模糊搜索。关键字必须为连续字符串,? 和 * 会被忽略。
例子:假设服务器的名称为“网易云信专属服务器”,用户使用如下三个关键字进行搜索,keyword1=“网易云信”,keyword2=“专属服”,keyword3=“网专属”,keyword4=“网易 云信”,那么只有 keyword1 和 keyword2 能搜索到该服务器
searchType TSearchType 搜索场景:
  • square-广场,即全局搜索服务器
  • person-搜索个人已加入的服务器
startTime number 查询时间范围的开始时间
endTime number 查询时间范围的结束时间,必须比开始时间晚
order TQChatSearchOrder 排序规则:ASC-升序,DESC-倒序
limit number 每页数据条数,最大和默认都是 100
serverType number 自定义,搜索的服务器类型
sort TSortType
  • 服务器的排序条件,默认为按创建时间倒序排序,即最新创建的服务器排在最前
  • 如需实现搜索结果自定义排序,请参照下文的搜索结果自定义排序中的说明进行配置
cursor string 游标, 搜索的起始位置

全局搜索服务器

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

  • 示例代码

    const qchat = new QChat({...})
    qchat.qchatServer.serverSearchByPage({
        keyword:"",
        order:"DESC",
        searchType:"square"
    })
    

搜索已加入的服务器

  • 示例代码

    const qchat = new QChat({...})
    qchat.qchatServer.serverSearchByPage({
        keyword:"",
        order:"DESC",
        searchType:"person"
    })
    

搜索服务器成员

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

入参说明

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

示例代码

const qchat = new QChat({...})
qchat.qchatServer.serverMemberSearchByPage({
    serverId:"",
    keyword:""
}})

搜索频道

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

入参说明

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

示例代码

const qchat = new QChat({...})
qchat.qchatChannel.getChannelSearchByPage({
    serverId:"",
    keyword:"",
    order:"ASC"
}})

搜索频道成员

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

入参说明

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

示例代码

const qchat = new QChat({...})
qchat.qchatChannel.channelMemberSearch({
    serverId:"",
    channelId:"",
    keyword:""
}})

搜索结果自定义排序

定义圈组服务器的serverInfo结构体包含服务器的自定义排序权重(reorderWeight),默认为 0。同样的,定义频道的ChannelInfo结构体包含频道的自定义排序权重(reorderWeight),默认为 0。自定义排序权重值,目前仅支持通过服务器端 API 修改。

服务器自定义排序

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

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

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

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

    结果

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

频道自定义排序

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

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

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

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

    结果

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

API 参考

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