Skip to content

平台适配器

适配器把外部平台接入 Zhin 的统一消息与 Endpoint 模型。先按部署条件选择接入方式,再检查能力和维护档位;不要只按平台名称选包。

先做选择

你的条件优先方向代表适配器
先验证业务,不接真实账号本地 SandboxSandbox
平台提供官方 Bot / App API官方连接QQ 官方、Discord、Telegram、Slack、钉钉、飞书、微信公众号
已部署协议桥或网关网关连接OneBot v11;NapCat、Milky、OneBot v12 等需自行验收
事件天然来自协作系统工作项连接GitHub(Experimental)
入口不是即时聊天非聊天消息源Email(Experimental)

选择前确认五件事:凭据由谁保管、平台如何投递入站事件、是否需要撤回或成员管理、部署环境能否接收回调,以及该档位是否满足你的发布标准。

推荐接入流程

  1. npx zhin setup --adapters 选择并生成适配器配置。
  2. 执行 pnpm installpnpm dev,先让 Sandbox 黄金路径通过。
  3. 在 Console 的“会话与频道”确认入站,在“运行时能力”核对 Endpoint 操作,在“日志”完成故障定位。
  4. 把真实平台加入同一业务链;命令、组件和中间件不应读取平台私有 SDK。

每个 @zhin.js/adapter-* 包都有独立文档页,并与包内 README.md 同步。下方档位与能力表是发布事实,不是推荐榜单。

框架级概念(多平台同跑、消息流、端点生命周期)见 核心概念端点生命周期

档位 SSOTscripts/adapter-meta.mjs(与 docs/snippets/platform-tiers.md 同源)。

档位

档位含义
Stablepnpm check:stableminimal-bot 一致
Platform Stable主流 IM;须满足 ADR 0015 D3 并进入 check:stable Platform 批(当前无
Advancedtest-bot 维护者厨房水槽(非用户模板)常用;有 integration 测试但不在 Stable smoke
Experimental可用性因部署差异大,需自行验证;≠ 无测试,= 无全量 CI/实机承诺

Stable

适配器包名Endpoint 管理能力文档
Sandbox@zhin.js/adapter-sandboxSandbox

Platform Stable

(当前无)

Advanced

适配器包名Endpoint 管理能力文档
钉钉@zhin.js/adapter-dingtalk钉钉
飞书@zhin.js/adapter-lark飞书
微信公众号@zhin.js/adapter-wechat-mp微信公众号
Discord@zhin.js/adapter-discordDiscord
ICQQ (QQ)@zhin.js/adapter-icqqlistFriends, listGroups, listChannels, listGroupMembers, listRequests, approveRequest, rejectRequest, kickGroupMember, muteGroupMember, setGroupAdmin, deleteFriendICQQ (QQ)
KOOK@zhin.js/adapter-kookKOOK
OneBot v11@zhin.js/adapter-onebot11OneBot v11
QQ 官方@zhin.js/adapter-qqlistChannelsQQ 官方
Slack@zhin.js/adapter-slackSlack
Telegram@zhin.js/adapter-telegramTelegram

Experimental

适配器包名Endpoint 管理能力文档
企业微信@zhin.js/adapter-wecom企业微信
微信 iLink@zhin.js/adapter-weixin-ilink微信 iLink
Email@zhin.js/adapter-emailEmail
GitHub@zhin.js/adapter-githubGitHub
LINE@zhin.js/adapter-lineLINE
Milky@zhin.js/adapter-milkyMilky
NapCat@zhin.js/adapter-napcatNapCat
OneBot v12@zhin.js/adapter-onebot12OneBot v12
Satori@zhin.js/adapter-satoriSatori

统一消息操作能力

消息发送由所有声明 outbound 的 Endpoint 支持;消息级扩展操作通过统一 EndpointControl 暴露,并按每个具体 Endpoint 精确声明。Core 不探测平台 SDK 私有方法。

操作已接入平台
recallDiscord、ICQQ、KOOK、飞书、Milky、NapCat、OneBot 11/12、QQ 官方、Satori、Slack、Telegram、企业微信
editSlack
reactionDiscord Gateway、ICQQ、Slack
typing微信 iLink

同一适配器不同接入模式可以具有不同能力。例如 Discord Gateway 支持 reaction, Interactions 模式只声明 recall;Host/Console 可从 Endpoint row 的 operations 字段读取 当前模式的准确能力集。

维护说明

  • 单一来源(档位)scripts/adapter-meta.mjs
  • 单一来源(正文)plugins/adapters/<name>/README.md
  • 同步命令:仓库根目录 pnpm sync:adapter-docs
  • CI 检查pnpm check:adapter-docspnpm check:platform-tiers-ssot

源码索引:plugins/adapters/README.md