跳到主要内容

OpenIM Server APIs

🚀 REST API​

OpenIM Server 提供了 REST API 供业务系统使用，以增强业务功能。如：

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

更多功能参考后面的 API 文档

⚠️ 注意: 请求 URL 中的 {API_ADDRESS} 为 OpenIM Server 部署的主机地址，如 http://IP:10002。

调用 REST API ，需要以 APP 管理员 身份进行，此服务由端口 10002 提供。所谓 APP 管理员，即有超级权限的用户。OpenIM Server 内置了一个 APP 管理员，它的 userID 为 imAdmin

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

API 鉴权流程：

  1. 通过 user_token API 获取管理员 token
  2. 使用管理员 token 调用其他 API

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

🔗 Webhooks​

OpenIM Server 还提供了强大的回调功能，以满足更多的业务需求。回调 的定义是，当某事件发生前或后，OpenIM Server 会向业务服务器发出请求。如：

  • 📤 发送消息前的回调
  • 📥 发送消息后的回调

请求 URL 中的 {WEBHOOK_ADDRESS} 为webhook部署的主机地址。