Documentation Sync

This page is auto-generated from plugins/adapters/onebot12/README.md. Please edit the in-package README and then run pnpm sync:adapter-docs.

@zhin.js/adapter-onebot12

Zhin.js OneBot 12 adapter (Plugin Runtime). Default is forward WebSocket client (connection: ws); also supports HTTP Webhook and reverse WS (routes registered via httpHostToken).

Features

• OneBot 12 Standard compatible (events + actions)
• Convention-based defineAdapter / definePlugin (no usePlugin needed)
• Forward WebSocket (connection: ws): the application connects to the OneBot implementation's WS server
• access_token authentication (Bearer + query)
• Inbound via Endpoint.emit(...); outbound send({ conversation, payload })

Installation

pnpm add @zhin.js/adapter-onebot12

Plugin Runtime

• @zhin.js/adapter — convention-based adapters/onebot12/index.ts (defineAdapter)
• @zhin.js/core — Endpoint.emit(...) inbound, outboundMessageToken outbound
• zhin.js — plugin.ts (definePlugin)
• Configuration goes to plugins.<instanceKey> via the plugin's schema.json

AdapterIndex merges instance defaults with each endpoints[] override. The protocol receives one expanded endpoint configuration and does not inspect nested endpoint rows or infer identity from process environment variables. Webhook endpoints require both path and api_url, so their bidirectional capability is complete before startup.

Inbound: gateway.receive({ conversation, message, content, sender, metadata }) (kind: 'private'|'group'|'channel'; guild containers land in parent) Outbound: send({ conversation, payload }) -> WS send_message (payload is rendered by gateway/core; no segment-mapper)

Prerequisites

1. Start a compatible OneBot 12 implementation that supports the selected WS or Webhook mode.
2. Webhook outbound also requires a reachable api_url; reverse connections require access to the Zhin HTTP Host.
3. Configure the same access_token on both sides and require authentication in production.

Minimal Configuration

# zhin.config.yml (Plugin Runtime)
plugins:
  onebot12:
    connection: ws
    reconnect_interval: 5000
    heartbeat_interval: 30000
    endpoints:
      - id: ob12-bot
        url: "ws://127.0.0.1:6700"
        access_token: "${ONEBOT12_ACCESS_TOKEN}"

The root plugin zhin.plugins (or project graph) must reference @zhin.js/adapter-onebot12 (instanceKey: onebot12).

Connection Modes

connection	Status
ws	Implemented (recommended)
webhook	Implemented: POST inbound + api_url HTTP outbound
wss	Implemented: reverse WS (httpHostToken)

Authentication

• Bearer: Authorization: Bearer <access_token>
• Forward WS attaches request headers during Upgrade and includes access_token in the URL query

Actions and Events

• Events: type (meta/message/notice/request), detail_type, message, etc. See Events.
• Actions: send_message, delete_message, get_status, etc. See Action Requests.

AI Tools

See skills/onebot12/SKILL.md for skill documentation.

Documentation Links

• OneBot 12 Standard
• OneBot Connect WebSocket
• Adapters overview

Troubleshooting

Symptom	Check
WS connection fails	OneBot version, direction, URL, and port
Webhook receives but cannot send	Reachable api_url and send_message support
401 or handshake failure	Matching Header/query token
Event fields are rejected	The implementation must emit OneBot 12, not v11 structures

License

MIT License