OPENIMSDK

Build Modern Instant Messaging with OpenIMSDK

Accelerate your chat product development with cross-platform client SDKs, robust server APIs, production-ready demo applications, and end-to-end guides for 1-on-1 chat, group messaging, conversation management, and real-time calling

Explore SDKs Browse Platform API

CLIENT

SDKs

Choose the right client SDK for your runtime. Every platform offers consistent core capabilities for users, conversations, groups, and messages with native performance optimization

Explore WASM SDK

Swift

iOS

Integrate login, users, conversations, groups, and messages in native iOS apps

View SDKKotlin / Java

Android

Integrate login, users, conversations, groups, and messages in native Android apps

View SDKDart

Flutter

Use one OpenIMClientSDK integration path across mobile and supported desktop targets

View SDKTypeScript / RN

React Native

Integrate OpenIMClientSDK into React Native apps for Android and iOS, including Expo development builds

View SDKArkTS / Enterprise

HarmonyOS

Build native HarmonyOS apps with typed ArkTS APIs for phones, tablets, and 2in1 devices

View SDKUTS / HBuilderX

uni-app / uni-app x

Use one UTS plugin integration across native Android, iOS, and HarmonyOS app targets

View SDKDesktop

Electron

Build Electron desktop apps with WASM in the renderer or FFI in the native runtime

View SDKPure JavaScript

JavaScript SDK

Use the pure JavaScript SDK for mini apps and lightweight web experiences that do not need local message storage

View SDKWebAssembly

JavaScript SDK (WASM)

Build full-featured web messaging apps with local message storage, conversation caching, and local search

View SDK

SERVER

Platform API

Manage users, issue authentication tokens, oversee group lifecycles, and dispatch or migrate messages via robust server-side REST APIs

Explore Platform API

REST API

Manage OpenIMServer from your backend

The Platform API is structured around core resources like users, groups, and messages. Configure your base URL, auth headers, and request conventions to integrate backend capabilities

Start with the API overview

API setup

Configure the API address, headers, admin token, and request conventions

Open docs

Users

Create and query users, update profiles, and issue login tokens

Open docs

Groups

Create or update groups, manage members, and handle invitations

Open docs

Messages

Send messages from trusted services, or migrate historical message data

Open docs

OPEN SOURCE DEMOS

Sample apps

Explore official open-source demo applications and integration examples across mobile, desktop, and web platforms to jumpstart your implementation

GitHub / H5

H5 demo

Browser demo for OpenIMClientSDK login, conversations, and messaging

Open GitHubGitHub / Electron

Electron demo

Desktop demo for Electron packaging and runtime setup

Open GitHubGitHub / iOS

iOS demo

Native iOS demo and its OpenIMClientSDK integration path

Open GitHubGitHub / Flutter

Flutter demo

Flutter demo for a single codebase covering mobile targets

Open GitHubGitHub / Android

Android demo

Native Android demo for login, conversations, messaging, and offline push

Open GitHubGitHub / RN

React Native demo

React Native demo for running OpenIMClientSDK on Android and iOS

Open GitHubGitHub / UTS

uni-app / uni-app x example

UTS plugin repository with an integration example for uni-app and uni-app x projects

Open GitHub

GETTING STARTED

Core integration flow

Follow our step-by-step onboarding flow: prepare your environment, authenticate the client, send your first message, and create a group

SDK

Prepare SDK integration

Set up OpenIMServer, configure application credentials, provision a user, and issue a login token

SDK

Authenticate a client

Initialize the client SDK, complete user login, and handle connection state and token lifecycle events

SDK

Send your first message

Construct and send your first one-to-one or group message using the client SDK

API

Create a group

Provision a chat group from your backend service, specifying group settings, the owner, and initial members

CAPABILITIES

Features

Explore core capabilities across users, conversations, groups, and messages, then jump into the corresponding SDK guides or Platform API references

User identity and access

Create OpenIMServer users, keep profiles up to date, and complete client login

UsersUser provisioning

Create OpenIMServer users from a trusted backend before clients log in

UsersUser directory

Query users already imported into OpenIMServer from the backend

ProfileUser profiles

Update nicknames, avatars, and extension fields from the backend

SDKClient authentication

Initialize and log in the SDK, then handle connection and token events

Conversations and groups

Manage client conversation state, create groups, and handle membership changes

ConversationsManage conversations

Retrieve conversations and maintain draft, unread, and other client state

GroupsCreate a group

Create a group with Platform API and set the owner, admins, and members

MembersList group members

Read group members from the backend for admin tools and sync jobs

MembersJoin a group

Submit a group join request from a trusted backend service

Messaging and history

Send and receive messages, load history, and search conversation records

MessageSend messages

Send messages from a trusted service to one-to-one or group sessions

HistoryMessage history

Page through conversation history from the client SDK

RealtimeReceive realtime messages

Listen for new and offline message events and merge them by message ID

SearchSearch message history

Search locally synced messages by keyword and filters

Message state and UX

Keep unread counts, read receipts, typing indicators, and custom message payloads in sync

UnreadUnread counts

Read the account total unread count for navigation and app badges

ReadRead receipts

Report selected group messages as read from the current client

TypingTyping indicators

Show realtime typing state in the active conversation

CustomCustom messages

Create an application-defined message with a custom payload and description

Moderation and governance

Manage user block lists and mute groups or members when policy requires it

BlockBlock users

Create or remove block relationships that control one-to-one messaging

MuteMute group members

Mute or unmute a member inside a group from the backend

AuditList blocked users

Query block relationships for admin tools and troubleshooting

MuteMute a group

Enable or disable group-wide mute from the client SDK

Advanced messaging

Inspect group message readers, revoke messages, organize conversations, and pin important messages

ReadGroup message readers

Query which group members have or have not read a message

RevokeRevoke a message

Revoke a sent message for participants in the conversation

GroupConversation groups

Organize conversations into user-defined groups and keep changes in sync

PinPinned messages

Pin important messages in a conversation and sync pin changes

Cross-platform SDKs and operations

Choose a client SDK for your stack and prepare the Platform API foundation

WASMWASM SDK

Integrate OpenIMClientSDK into browser apps through WebAssembly

iOSiOS SDK

Integrate OpenIMClientSDK into native iOS apps

FlutterFlutter SDK

Use one OpenIMClientSDK integration path across mobile and supported desktop targets

APIAPI setup

Configure the API address, headers, admin token, and request conventions

ErrorsError codes

Look up Platform API response structure and server error codes