Start from client SDKs, Platform API, sample apps, or the core integration flow to add users, conversations, groups, messages, and calling.
Pick the client SDK for your runtime. Each entry covers users, conversations, groups, and messages, and documents platform-specific setup.
Integrate login, users, conversations, groups, and messages in native iOS apps.
View SDK→DartUse one OpenIM integration path across mobile and supported desktop targets.
View SDK→DesktopBuild Electron desktop apps with WASM in the renderer or FFI in the native runtime.
View SDK→Pure JavaScriptUse the pure JavaScript SDK for mini apps and lightweight web experiences that do not need local message storage.
View SDK→WebAssemblyBuild full-featured web messaging apps with local message storage, conversation caching, and local search.
View SDK→Call Platform API from trusted backends to create users, issue login tokens, manage groups and members, and send or migrate messages.
Platform API is organized by users, groups, and messages. Configure the base URL, auth, and request conventions first, then wire each server capability.
Start with the API overview→Configure the API address, headers, admin token, and request conventions.
Open docs→Create and query users, update profiles, and issue login tokens.
Open docs→Create or update groups, manage members, and handle invitations.
Open docs→Send messages from trusted services, or migrate historical message data.
Open docs→Browse demos maintained by the openimsdk GitHub organization to see how each platform integrates OpenIM.
Browser demo for OpenIM login, conversations, and messaging.
Open GitHub→GitHub / ElectronDesktop demo for Electron packaging and runtime setup.
Open GitHub→GitHub / iOSNative iOS demo and its OpenIM SDK integration path.
Open GitHub→GitHub / FlutterFlutter demo for a single codebase covering mobile targets.
Open GitHub→Follow prepare, client login, first message, and group creation guides to complete the core integration path.
Prepare the OpenIM server, app credentials, user account, and login token.
Initialize the SDK, log in, and handle token expiry and kick-off events.
After prepare and login, create and send the first message from the client SDK.
Create a group from a trusted service and set the owner and initial members.
Browse capabilities by users, conversations, groups, and messages, then open the matching SDK or Platform API guide.
Create OpenIM users, keep profiles up to date, and complete client login.
Create OpenIM users from a trusted backend before clients log in.
UsersUser directoryQuery users already imported into OpenIM from the backend.
ProfileUser profilesUpdate nicknames, avatars, and extension fields from the backend.
SDKClient authenticationInitialize and log in the SDK, then handle connection and token events.
Manage client conversation state, create groups, and handle membership changes.
Retrieve conversations and maintain draft, unread, and other client state.
GroupsCreate a groupCreate a group with Platform API and set the owner, admins, and members.
MembersList group membersRead group members from the backend for admin tools and sync jobs.
MembersJoin a groupSubmit a group join request from a trusted backend service.
Send and receive messages, load history, and search conversation records.
Send messages from a trusted service to one-to-one or group sessions.
HistoryMessage historyPage through conversation history from the client SDK.
RealtimeReceive realtime messagesListen for new and offline message events and merge them by message ID.
SearchSearch message historySearch locally synced messages by keyword and filters.
Keep unread counts, read receipts, typing indicators, and custom message payloads in sync.
Read the account total unread count for navigation and app badges.
ReadRead receiptsReport selected group messages as read from the current client.
TypingTyping indicatorsShow realtime typing state in the active conversation.
CustomCustom messagesCreate an application-defined message with a custom payload and description.
Manage user block lists and mute groups or members when policy requires it.
Create or remove block relationships that control one-to-one messaging.
MuteMute group membersMute or unmute a member inside a group from the backend.
AuditList blocked usersQuery block relationships for admin tools and troubleshooting.
MuteMute a groupEnable or disable group-wide mute from the client SDK.
Inspect group message readers, revoke messages, organize conversations, and pin important messages.
Query which group members have or have not read a message.
RevokeRevoke a messageRevoke a sent message for participants in the conversation.
GroupConversation groupsOrganize conversations into user-defined groups and keep changes in sync.
PinPinned messagesPin important messages in a conversation and sync pin changes.
Choose a client SDK for your stack and prepare the Platform API foundation.
Integrate OpenIM into browser apps through WebAssembly.
iOSiOS SDKIntegrate OpenIM into native iOS apps.
FlutterFlutter SDKUse one OpenIM integration path across mobile and supported desktop targets.
APIAPI setupConfigure the API address, headers, admin token, and request conventions.
ErrorsError codesLook up Platform API response structure and server error codes.