文档同步

本页由 plugins/adapters/onebot11/README.md 自动生成。请修改包内 README 后运行 pnpm sync:adapter-docs。

@zhin.js/adapter-onebot11

Zhin.js OneBot 11 适配器（Plugin Runtime）。生产路径为正向 WebSocket 客户端（connection: ws）；亦支持反向 WS（connection: wss，经 httpHostToken）。

功能特性

OneBot 11 标准兼容（事件 + 动作）
约定式 defineAdapter / definePlugin（无需 usePlugin）
正向 WebSocket（connection: ws）：应用连 OneBot 实现的 WS 服务器
access_token 鉴权（Bearer + query）
入站经 Endpoint.emit(...)；出站 send({ conversation, payload })

安装

bash

pnpm add @zhin.js/adapter-onebot11

Plugin Runtime

@zhin.js/adapter — 约定式 adapters/onebot11.ts（defineAdapter）
@zhin.js/core — Endpoint.emit(...) 入站、outboundMessageToken 出站
zhin.js — plugin.ts（definePlugin）
配置经插件 schema.json 落到 plugins.<instanceKey>

每个 Endpoint 的 $client 是 @imhelper/onebot-v11 的 OneBotV11Client。业务代码直接调用 $client.call(action, params) 和 Client 的公开平台能力；双工 WS 的 echo 响应由 Endpoint 先行分流，只有事件帧进入 Client 的 ingest() 和公开事件流。

入站：gateway.receive({ conversation, message, content, sender, metadata })（conversation.kind 为 private/group，id 为 uid/gid）
出站：send({ conversation, payload }) → WS send_private_msg / send_group_msg（payload 已由 gateway/core 渲染；无 segment-mapper）

前置条件

启动兼容 OneBot 11 的实现，并选定正向或反向 WebSocket。
正向 WS 需 Zhin 可达实现端；反向 WS 需实现端可达 Zhin HTTP Host。
两端配置相同的 access_token，生产环境不要开放无鉴权连接。

最小配置

yaml

# zhin.config.yml（Plugin Runtime）
plugins:
  onebot11:
    connection: ws
    reconnect_interval: 5000
    heartbeat_interval: 30000
    endpoints:
      - name: ob11-bot
        url: "ws://127.0.0.1:6700"
        access_token: "${ONEBOT11_ACCESS_TOKEN}"

根插件 zhin.plugins（或项目图）需引用 @zhin.js/adapter-onebot11（instanceKey: onebot11）。

连接方式

connection	状态
`ws`	已实现（推荐）
`wss`	已实现：反向 WS（`httpHostToken`）

鉴权

Bearer：Authorization: Bearer <access_token>
正向 WS 在 Upgrade 时附带请求头，并在 URL query 写入 access_token

动作与事件

事件：post_type（message/notice/request/meta_event）、message_type、message 等
动作：send_private_msg、send_group_msg、delete_msg、set_group_special_title 等

AI 工具

类别	路径
Permit 词汇	`agent/PERMITS.md`
平台工具	`agent/tools/set_title.ts` → `onebot11_set_title`
技能说明	`agent/skills/onebot11.md`

迁移说明（Plugin Runtime）

notice / request / meta 侧事件：经 the unified Endpoint.emit(...) ingress 归一后分发到 handlers；消息仍走 outboundMessageToken。
群管工具暂未迁移：旧 Adapter 经 createSceneManagementTools 注册踢人 / 禁言 / 群名片等成套 agent 工具；迁移后仅保留 onebot11_set_title，其余群管能力可通过 $client.call()（如 set_group_kick、set_group_ban）作为逃生舱调用。
平台权限门禁：plugin.ts setup 已注册 registerDefaultScenePlatformPermitChecker('onebot11')，scene_admin / scene_owner 依据入站 metadata 中的 sender role（owner / admin）判定。

文档链接

故障排查

现象	排查
WS 无法建立	核对连接方向、URL、端口与实现端 WS 服务
401 或握手关闭	确认 Header/query token 与实现端一致
能收不能发	检查发送动作支持与账号风控状态
notice/request 不出现	确认实现端上报对应 post type，并查看 Endpoint 请求/通知

许可证

MIT License

@zhin.js/adapter-onebot11 ​

功能特性 ​

安装 ​

Plugin Runtime ​

前置条件 ​

最小配置 ​

连接方式 ​

鉴权 ​

动作与事件 ​

AI 工具 ​

迁移说明（Plugin Runtime） ​

文档链接 ​

故障排查 ​

许可证 ​