Server
Handles connections, messages, conversations, groups, files, and management capabilities.
- Message routing
- Sessions and groups
- Permissions and config
Open Source and Developers
Open IM Foundations for Engineering Teams
OpenIMX provides clear server, client, and SDK modules for teams that need to audit, extend, integrate, and evolve messaging capabilities. The GitHub entry is configured through environment variables for consistent deployment.
const client = new OpenIMX({
endpoint: "/api",
websocket: "/ws"
});
await client.connect();
client.on("message", render);
await client.send({
conversationId,
content
});Server
1Handles connections, messages, conversations, groups, files, and management capabilities.
Web Client
2For desktop web, admin workflows, and support reception scenarios.
App Client
3Supports iOS, Android, and H5 reach while keeping multi-device UX consistent.
SDK
4Integrates messaging into existing products and internal systems.
Modules
Web Client
For desktop web, admin workflows, and support reception scenarios.
- Conversation list
- Group chat
- File preview
App Client
Supports iOS, Android, and H5 reach while keeping multi-device UX consistent.
- Mobile sessions
- Push entry
- Theme adaptation
SDK
Integrates messaging into existing products and internal systems.
- Unified API
- Event subscription
- Example integration
Open Capabilities
Bring your platform, user scenario, and existing systems. We can map the integration path and delivery boundary together.
API
Server-side capabilities for users, sessions, groups, files, configuration, and admin workflows.
WebSocket
Real-time events for messages, presence, typing state, receipts, and live conversation flows.
Webhook
Sync message, lead, notification, or business events into external systems.
Fast Integration Flow
Confirm Scenario
Choose complete product delivery, SDK integration, or white-label customization.
Configure Environment
Prepare server config, database, domain, HTTPS, and public environment variables.
Integrate SDK
Pick Web, App, or server APIs and complete login, sessions, and messaging paths.
Validate Launch
Verify messages, files, permissions, notifications, and operations before staged rollout.
Roadmap
- Improve SDK examples
- Strengthen admin operations
- Expand Webhook scenarios
- Complete deployment and observability docs
License
Open-source licensing and commercial delivery boundaries follow the project repository and formal agreements.
View GitHub ProjectContribution Guide
- Read module docs
- Open issues or discussions
- Follow code conventions
- Contribute through pull requests
Need SDK Integration or Technical Evaluation?
Bring your platform, user scenario, and existing systems. We can map the integration path and delivery boundary together.