WebUI API 路由文档

认证相关 API

登录

• 路由: /api/login
• 方法: POST
• 参数:
  • username: 用户名
  • password: 密码
• 返回: 重定向到 /log 页面

登出

• 路由: /logout
• 方法: GET
• 返回: 重定向到登录页面

验证认证状态

• 路由: /api/check_auth
• 方法: GET
• 返回: {"status": "ok"}

日志相关 API

日志页面

• 路由: /log
• 方法: GET
• 权限: 需要认证
• 返回: 日志页面

WebSocket 日志流

• 路由: /ws/log
• 方法: WebSocket
• 权限: 需要认证
• 功能: 实时推送日志信息

权限管理 API

权限管理页面

• 路由: /permission
• 方法: GET
• 权限: 需要认证
• 返回: 权限管理页面

添加超级管理员

• 路由: /api/permission/add_super_admin
• 方法: POST
• 参数: user_id (QQ号)
• 权限: 需要认证

移除超级管理员

• 路由: /api/permission/remove_super_admin
• 方法: POST
• 参数: user_id (QQ号)
• 权限: 需要认证

添加群管理员

• 路由: /api/permission/add_group_admin
• 方法: POST
• 参数:
  • group_id: 群号
  • user_id: QQ号
• 权限: 需要认证

移除群管理员

• 路由: /api/permission/remove_group_admin
• 方法: POST
• 参数:
  • group_id: 群号
  • user_id: QQ号
• 权限: 需要认证

消息管理 API

消息发送页面

• 路由: /message
• 方法: GET
• 权限: 需要认证
• 返回: 消息发送页面

发送群消息

• 路由: /api/message/send
• 方法: POST
• 参数:
  • group_id: 群号
  • message: 消息内容
• 权限: 需要认证

定时任务 API

定时任务页面

• 路由: /schedule
• 方法: GET
• 权限: 需要认证
• 返回: 定时任务管理页面

添加定时任务

• 路由: /api/schedule/add
• 方法: POST
• 参数:
  • group_id: 群号
  • hour: 小时(0-23)
  • minute: 分钟(0-59)
  • action: 操作(true/false)
• 权限: 需要认证

删除定时任务

• 路由: /api/schedule/delete
• 方法: POST
• 参数:
  • group_id: 群号
  • job_id: 任务ID
• 权限: 需要认证

黑名单管理 API

黑名单页面

• 路由: /blacklist
• 方法: GET
• 权限: 需要认证
• 返回: 黑名单管理页面

添加全局黑名单

• 路由: /api/blacklist/add_global
• 方法: POST
• 参数: user_id (QQ号)
• 权限: 需要认证

移除全局黑名单

• 路由: /api/blacklist/remove_global
• 方法: POST
• 参数: user_id (QQ号)
• 权限: 需要认证

添加群黑名单

• 路由: /api/blacklist/add_group
• 方法: POST
• 参数:
  • group_id: 群号
  • user_id: QQ号
• 权限: 需要认证

移除群黑名单

• 路由: /api/blacklist/remove_group
• 方法: POST
• 参数:
  • group_id: 群号
  • user_id: QQ号
• 权限: 需要认证

注意事项

1. 所有 API 都需要进行身份认证（除登录接口外）
2. 认证方式使用 JWT Token，通过 Cookie 传递
3. Token 有效期为 24 小时
4. 所有返回的错误状态码均为标准 HTTP 状态码
5. WebSocket 连接需要在 Cookie 中携带有效的 Token