Skip to content

@koishijs/plugin-adapter-onebot

OneBot 是一个聊天机器人应用接口标准,目前可用于 QQ 等平台。

接入方式

请自行参考 OneBot 实现侧的文档进行搭建,随后填写下面的配置项。

配置项

config.protocol

  • 可选值: http, ws, ws-reverse

要使用的协议类型。

config.token

  • 类型:string

发送信息时用于验证的字段。

config.endpoint

  • 类型:string

如果使用了 HTTP,则该配置将作为发送信息的服务端;如果使用了 WebSocket,则该配置将作为监听事件和发送信息的服务端。

config.proxyAgent

请求时默认使用的网络代理。

config.path

  • 类型:string
  • 默认值:'/onebot'

服务器监听的路径。仅用于 HTTP 或 WS Reverse 通信方式。

config.secret

  • 类型:string

接收信息时用于验证的字段,应与 OneBot 的 secret 配置保持一致。

内部 API

你可以通过 bot.internalsession.onebot 访问内部 API,参见 访问内部接口

OneBot v11 标准 API

go-cqhttp 扩展 API

频道 API