OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse Platform API

Overview

OpenIM Platform API is organized for trusted backend services. Use these REST endpoints to manage users, groups, messages, session tokens, moderation, and operational workflows that are already covered by OpenIM REST documentation.

Prepare to use APIConfirm the base API address, JSON headers, administrator token, and request body conventions.List usersRetrieve registered OpenIM users from a trusted backend service.Create a userRegister OpenIM users and keep business identity rules in your own system.Create a group channelProvision an OpenIM group for channel-style conversations and member management.Send a messageSend server-side text, custom, and notification messages through OpenIM message APIs.Migrate messagesImport historical messages into OpenIM while preserving sender and conversation context.
User lifecycleCreate users, update profiles, query user records, and issue session tokens.Group channelsCreate groups, update group information, invite members, and manage membership changes.ModerationBlock users, list block relationships, and mute or unmute group members.

Resources

PostmanExplore and run OpenIM API requests in the OpenIM Postman workspace.ApifoxBrowse and debug OpenIM API definitions in the OpenIM Apifox project.