OpenIM Server APIs

🚀 REST API

OpenIM Server 提供了 REST API，允许您以超级权限直接从服务端发起请求操作 IM 系统，以增强业务功能。例如：

• 🛠 创建群组
• 📬 推送消息

使用场景，例如，系统自动向新注册用户发送欢迎消息。

协议说明

• 协议：使用标准的 HTTP 协议
• 数据格式：请求和响应均为 JSON 格式

重要说明

API 地址：

请求 URL 中的 {API_ADDRESS} 为 OpenIM Server 对外服务的 API 地址，例如 http://{your_im_server_ip}:10002。

权限要求：

调用 REST API 需要以 APP 管理员 身份进行，此用户具有超级权限。OpenIM Server 内置了一个 APP 管理员，其 userID 为 imAdmin。

参数限制：

API 请求参数中所有的 array 类型的最大长度限制为 1000。

API调用过程

1. 获取APP管理员 Token：

   通过 user_token API 获取管理员 Token。

2. 调用其他 API：

   将获取到的 APP 管理员 Token 添加到 HTTP 请求的 Header 中，然后调用其他 REST API。

使用指南

为安全起见，REST API 只能在服务端使用，客户端使用相应的客户端 SDK 进行操作。