Skip to content

连接方式

Waylay 支持 OneBot v11 标准的两种 WebSocket 连接模式。

正向 WebSocket

Bot 框架作为客户端,连接到 Waylay 的 WebSocket 服务器。

ws://host:3001/

配置环境变量:

yaml
ONEBOT_WS_PORT=3001
ONEBOT_WS_HOST=0.0.0.0

鉴权

如果设置了 ONEBOT_TOKEN,连接时需要携带 Token:

方式一:URL 参数

ws://host:3001/?access_token=your_token

方式二:HTTP 头

Authorization: Bearer your_token

反向 WebSocket

Waylay 作为客户端,主动连接到 Bot 框架的 WebSocket 服务器。

yaml
ONEBOT_WS_REVERSE_URLS=["ws://framework:2536/OneBotv11"]

支持同时连接多个框架:

yaml
ONEBOT_WS_REVERSE_URLS=["ws://yunzai:2536/OneBotv11","ws://koishi:5140/onebot"]

反向 WS 断线后自动重连(间隔 5 秒)。

生命周期事件

连接建立后,Waylay 会发送 lifecycle 元事件:

json
{
  "time": 1712640000,
  "self_id": 123456789,
  "post_type": "meta_event",
  "meta_event_type": "lifecycle",
  "sub_type": "connect"
}

心跳

每 30 秒发送一次心跳事件:

json
{
  "time": 1712640030,
  "self_id": 123456789,
  "post_type": "meta_event",
  "meta_event_type": "heartbeat",
  "interval": 30000,
  "status": {
    "online": true,
    "good": true
  }
}

LLOneBot 兼容协议

除 OneBot v11 外,Waylay 还在端口 13000 暴露 LLOneBot 兼容的 Bridge WebSocket:

ws://host:13000/ws

此协议使用不同的消息格式(type/data 而非 action/params),主要用于向后兼容。

Released under the Apache 2.0 License.