跳转至

DraARL Server API 文档(客户端对接版)

随 DraARL Server 源码发布,版本以仓库根目录 VERSION 为准,基于当前代码实现整理 (internal/server/server.go + internal/handler/* + pkg/websocket/*)。

文档目录

  1. 00-约定与鉴权
  2. 01-认证与SSO
  3. 02-用户与资料
  4. 03-设备与配置
  5. 04-群组与互联
  6. 05-无线电与实时通信
  7. 06-通联记录与日志
  8. 07-资源上传与站点配置
  9. 08-运维与管理接口
  10. 09-完整路由索引
  11. 10-WebSocket协议详解
  12. 11-错误码与状态码
  13. 12-客户端资源分发
  14. 13-群组自动播报

说明

  • 本文档优先使用“推荐新路径”,同时标注兼容旧路径。
  • 接口统一返回 code/message/data,但少量历史接口(AT 控制)返回业务码 20000/20001。
  • WebSocket 鉴权使用 HttpOnly Cookie(ws_token),不支持 URL 透传 token。
  • 收发控制(disable_send/disable_recv)是设备级状态,由 devices 表统一维护;设备所有者/管理员使用 PUT /api/devices/:id,当前群主/管理员可使用群组设备收发控制接口。
  • 群组不提供设备准入白名单或永久封禁;群主的临时收发控制在设备切换群组后仍然生效,设备所有者可自行恢复。
  • 频道历史使用 /api/groups/:id/messages 的不透明游标;/api/comm-records 是本人发信/审计视图,不能替代频道历史。
  • 完整路由索引按当前 setupRoutes() 登记,公开、JWT、Approved、Admin 和群主权限不会因路径前缀相似而互相替代。