OPENIMSDK

使用 OpenIMSDK 构建即时通讯应用

从 OpenIMClientSDK、OpenIMServer Platform API、示例应用和核心接入流程开始，接入用户、会话、群组、消息与音视频通话

查看 SDK 查看 Platform API

客户端

SDK

按应用运行平台选择客户端 SDK。各平台文档覆盖同一套用户、会话、群组和消息能力，并说明各自的运行环境与集成差异

查看 WASM SDK

Swift

iOS

在 iOS 原生应用中接入登录、用户、会话、群组和消息

查看 SDKDart

Flutter

用同一套 OpenIMClientSDK 接入路径覆盖移动端和支持的桌面平台

查看 SDKDesktop

Electron

面向 Electron 桌面应用，渲染层可复用 WASM，原生运行层可通过 FFI 接入

查看 SDK纯 JavaScript

JavaScript SDK

纯 JavaScript 实现，适用于小程序、客服入口、活动页和无需本地消息存储的轻量 Web 场景

查看 SDKWebAssembly

JavaScript SDK (WASM)

基于 WebAssembly，提供本地消息存储、会话缓存和本地搜索，适用于完整 Web IM 和 Electron 渲染层

查看 SDK

服务端

Platform API

通过 Platform API，在可信服务端创建用户、签发登录 Token、管理群组和成员，并发送或迁移消息

查看 API 概览

REST API

从业务后端管理 OpenIMServer

Platform API 按用户、群组和消息等资源组织。先完成地址、鉴权和请求约定配置，再接入具体服务端能力

从 API 概览开始

API

API 接入准备

配置 API 地址、公共请求头、管理员 Token 和请求体约定

打开文档

用户

创建和查询用户、更新资料，并为客户端登录签发 Token

打开文档

群组

创建或更新群组、管理群成员，并处理邀请和加入流程

打开文档

消息

从可信服务端发送消息，或导入其他系统的历史消息

打开文档

开源 Demo

示例应用

查看 OpenIMSDK GitHub 组织维护的 Demo，对照各平台接入 OpenIMClientSDK 的实际方式

GitHub / H5

H5 Demo

查看浏览器端 Demo 的登录、会话和消息接入方式

打开 GitHubGitHub / Electron

Electron Demo

查看 Electron 桌面端 Demo 的打包和运行环境配置

打开 GitHubGitHub / iOS

iOS Demo

查看 iOS 原生 Demo 及其 OpenIMClientSDK 接入路径

打开 GitHubGitHub / Flutter

Flutter Demo

查看 Flutter Demo，用同一工程覆盖移动端接入

打开 GitHub

接入指南

核心接入流程

按接入准备、客户端登录、发送第一条消息和创建群组的顺序，进入对应操作指南

SDK

完成接入准备

准备 OpenIMServer、应用凭证、用户账号和登录 Token

SDK

初始化并登录客户端

初始化 SDK、完成登录，并处理 Token 过期和被踢下线等事件

SDK

发送第一条消息

完成接入准备和登录后，创建并发送第一条消息

API

创建群组

通过 Platform API 创建群组，并设置群主和初始成员

能力导航

功能特性

按用户、会话、群组和消息等领域查找能力，并进入对应的 SDK 或 Platform API 文档

用户与登录

创建 OpenIMServer 用户、维护用户资料，并完成 OpenIMClientSDK 登录

用户创建用户

在客户端登录前，由可信业务服务端创建 OpenIMServer 用户

用户查询用户

从服务端查询已导入 OpenIMServer 的用户资料

资料用户资料

从服务端更新用户昵称、头像和扩展字段

SDK登录与会话管理

初始化并登录 OpenIMClientSDK，处理连接、Token 过期和被踢下线事件

会话与群组

管理客户端会话状态，并创建群组、查询成员和处理成员进退群

会话管理会话

通过 SDK 获取会话，并维护草稿、未读数和其他客户端会话状态

API创建群组

通过 Platform API 创建群组，并设置群主和初始成员

成员查询群组成员

从服务端读取群成员列表，用于后台管理和数据同步

成员加入群组

从可信服务端提交用户入群请求

消息与历史

发送和接收消息、读取历史消息，并按关键词搜索会话记录

消息发送消息

从可信服务端向单聊用户或群组发送消息

历史历史消息

通过 SDK 分页读取会话历史消息

实时接收实时消息

监听新消息和离线消息事件，并按消息 ID 合并到消息列表

搜索搜索消息历史

按关键词和筛选条件搜索 SDK 已同步到本地的消息

消息状态与体验

同步未读数、已读回执和输入状态，并承载自定义消息载荷

未读未读数

读取账号总未读数，更新导航和应用角标

已读已读回执

从当前客户端上报指定群消息已读

输入中输入状态

在当前活跃会话中显示实时输入状态

自定义自定义消息

创建包含自定义载荷和描述的业务消息

关系与群组管控

管理用户黑名单，并对群组或群成员设置禁言

屏蔽屏蔽用户

建立或解除用户黑名单关系，控制单聊消息发送

禁言禁言群组成员

从服务端禁言或解除禁言指定群成员

审计查询屏蔽关系

查询指定用户的黑名单关系，用于后台管理和问题排查

禁言群组全员禁言

通过客户端开启或关闭群组全员禁言

高级功能

查询群消息已读成员、撤回消息、管理会话分组，并置顶重要消息

已读群消息已读成员

查询已读或未读指定群消息的成员

撤回撤回消息

撤回已经发送的消息，并同步给会话参与者

分组会话分组

创建和管理当前用户的会话分组，并同步分组及成员会话的变化

置顶置顶消息

置顶会话中的重要消息，并通过事件同步变更

跨平台 SDK 与服务端接入

选择适合应用技术栈的客户端 SDK，并完成 Platform API 接入准备

WASMWASM SDK

通过 WebAssembly 在浏览器应用中接入 OpenIMClientSDK

iOSiOS SDK

在 iOS 原生应用中接入 OpenIMClientSDK

FlutterFlutter SDK

用同一套 OpenIMClientSDK 接入路径覆盖移动端和支持的桌面平台

APIAPI 接入准备

配置 API 地址、公共请求头、管理员 Token 和请求体约定

错误错误码

查询 Platform API 的响应结构和服务端错误码