服务端消息搜索
大约 3 分钟
search
服务端消息搜索
服务端消息搜索是环信即时通讯 IM 的增值服务,支持按关键词检索保存在环信服务器上的历史消息。你可以通过客户端 SDK 或服务端 RESTful API,为应用提供消息搜索入口,帮助用户查找会话中的聊天内容、文件和其他信息。
与搜索本地消息相比,服务端消息搜索从服务端检索消息,不依赖当前设备是否已将消息下载到本地。搜索结果仍受消息保存期限和用户可见范围限制。
适用场景
- 查找聊天内容:通过一个或多个关键词,查找包含相关内容的历史消息。
- 会话内搜索:在指定单聊、群聊或聊天室中查找消息。
- 查找文件和资料:按消息类型筛选结果,结合文件名、合并消息标题或摘要等内容定位资料。
- 按时间查找消息:结合消息发送时间范围缩小搜索范围。
搜索能力
| 能力 | 说明 |
|---|---|
| 关键词搜索 | 支持单关键词和多关键词搜索,可选择匹配任一关键词或全部关键词。 |
| 条件筛选 | 支持按会话、消息类型和消息发送时间范围筛选。具体参数与限制请参见 各平台集成文档。 |
| 消息类型 | 支持文本、图片、视频、文件、位置和合并消息;不支持语音、自定义和透传消息。 |
| 消息内容搜索 | 文本消息匹配文本内容,图片、视频和文件消息匹配文件名,位置消息匹配地址或建筑物名称,合并消息匹配标题或摘要。文本消息还支持匹配自动翻译后的文本内容。 |
| 扩展字段搜索 | 支持搜索消息扩展字段(ext),需联系环信商务单独开通并配置可搜索字段白名单。 |
| 分页与高亮 | 支持分页查询和关键词高亮。排序方式及高亮配置以各平台接口说明为准。 |
搜索范围与限制
搜索结果仅包含指定用户有权访问、且仍在服务端保存期限内的消息。用户已单方删除的消息不会返回。
搜索群聊或聊天室消息时,服务端会校验用户的成员身份;可获取加入时间时,搜索范围还受加入时间限制。定向消息仅对发送者及其指定接收者可见。具体规则请参见 服务端接口文档。
消息扩展字段搜索默认不开启,如需使用,请联系环信商务。
开通与计费
该服务面向国内 1 区、国内 2 区、新加坡集群的应用开放。
使用前,请在环信控制台的 增值服务 > 消息搜索 中开通服务,详见 开通说明。开通后,系统会为应用创建搜索索引资源并开始同步消息数据。
服务按套餐订阅费用和超量使用费用计费。国内与海外的收费标准分别参见 国内计费说明 和 海外计费说明。
集成入口
开通服务后,选择对应平台的集成指南:
| 平台 | 文档 |
|---|---|
| Android | Android 集成指南 |
| iOS | iOS 集成指南 |
| Web/小程序 | Web/小程序集成指南 |
| HarmonyOS | HarmonyOS 集成指南 |
| Flutter | Flutter 集成指南 |
| React Native | React Native 集成指南 |
| 服务端 | 服务端 RESTful API |
