SDKsMini Program
OpenIM 小程序 SDK 概览
说明小程序 SDK 的适用场景、运行时差异，以及不可用的本地搜索与清理 API。
OpenIM 小程序 SDK 适用于小程序和轻量 Web 场景。用户、会话、消息、群组和事件的方法级模型与其他 OpenIMClientSDK 保持一致，但不提供本地消息存储，也不提供若干依赖本地库的搜索与清理 API。共享能力请直接阅读 WASM SDK 文档；本页只说明运行时差异和不可用清单。
与 WASM 的关系
- 方法语义、事件和数据模型：以对应 WASM 指南为准。
- 差异集中在：初始化入口、域名白名单、文件选择与上传、平台生命周期，以及下表列出的不可用 API。
- 需要完整本地消息库、会话缓存和历史持久化的 Web 客户端，应优先使用 WASM SDK。
不可用 API（相对 WASM）
小程序 SDK 当前不提供下列方法。本地全文搜索或本地清空会话历史可由业务后端能力替代，或使用仍可用的分页查询后在应用内过滤。
| 不可用 API | WASM 参考 | 建议替代 |
|---|---|---|
clearConversationAndDeleteAllMsg | 清空会话消息 | 由服务端策略或业务接口处理历史清理；客户端只刷新当前会话视图 |
searchLocalMessages | 搜索消息 | 使用后端消息索引，再按返回的 conversationID / clientMsgID 打开会话 |
searchFriends | 搜索好友 | 分页拉取好友后在应用内过滤，或由业务通讯录搜索 |
searchGroupMembers | 搜索群成员 | 使用分页查询群成员后过滤，或由后端服务检索 |
searchGroups | 搜索群组 | 使用已加入群组分页接口后过滤，或后端群发现 |
findMessageList | 按 ID 查找消息 | 保留服务端或会话态中的消息 ID，再通过可用的历史查询接口加载上下文 |
核心通用能力（参考 WASM 文档）
运行环境注意事项
- 在对应小程序管理后台配置好合法域名白名单（涵盖 request、WebSocket 及文件上传域名）。
- 本 SDK 专为无本地数据库环境优化，业务层无需处理本地离线存储；当小程序切回前台或页面恢复时，按需拉取最新的会话与消息快照即可。
- 发送文件或媒体消息时，需结合目标小程序平台的文件选择器、临时文件路径及包大小限制进行适配。
- 登录 Token 必须由业务后台安全签发，并与传入的
userID严格对应。 - 在标准 Web 浏览器中，纯 JavaScript SDK 仅建议用于轻量嵌入或临时客服场景；构建功能完整、支持离线体验的 Web IM 客户端时，推荐使用 WASM SDK。
这个页面有帮助吗？