Skip to content

正向 WebSocket ​

框架监听 WebSocket 端口,插件作为独立客户端连接。

配置与认证 ​

在管理后台的“插件”中创建正向 WebSocket 服务,填写服务名称、监听端口与服务令牌并启用。

text
ws://框架地址:服务监听端口/

连接建立后 10 秒内发送认证帧,包含 type: "auth"、token、name、version、author,并通过 permissions 声明要接收的事件。收到 auth_ok 后再发起接口请求。完整认证帧和原生 JavaScript 示例见通信协议。

调用与事件 ​

接口请求使用 action 帧,以 id 配对 action_result。账号操作必须显式提供 self_id 与 protocol_id,且账号属于当前框架。事件权限不授予额外的账号或业务权限。

连接需正确处理 Ping/Pong。断线后由插件自行重新连接和认证;不要自动重放已经提交的写操作。接口及消息段见 API 文档和消息段。

跨主机时确保服务端口可达;需要加密连接时使用支持 WebSocket 的 HTTPS 反向代理。旧本地托管插件和 client_type SDK 的连接示例不适用于本版本。

萌卡 · 自托管 QQ 机器人框架