构建渠道插件

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

渠道插件的工作方式

• 配置 - 账号解析和设置向导
• 安全 - 私信策略和允许列表
• 配对 - 私信批准流程
• 会话语法 - 提供商特定的对话 ID 如何映射到基础聊天、线程 ID 和父级回退项
• 出站 - 向平台发送文本、媒体和投票
• 线程 - 回复如何串联
• Heartbeat 输入状态 - 针对 Heartbeat 投递目标的可选输入中/忙碌信号

​

批准和渠道能力

• 核心拥有同一聊天中的 /approve、共享审批按钮 payload，以及通用 fallback 递送。
• 当渠道需要审批特定行为时，优先在渠道插件上使用一个 approvalCapability 对象。
• ChannelPlugin.approvals 已移除。将审批递送、native、render、auth 事实放到 approvalCapability 上。
• plugin.auth 仅用于登录/注销；核心不再从该对象读取审批 auth 钩子。
• approvalCapability.authorizeActorAction 和 approvalCapability.getActionAvailabilityState 是规范的审批 auth 接缝。
• 对同一聊天审批 auth 可用性使用 approvalCapability.getActionAvailabilityState。
• 如果你的渠道暴露 native exec 审批，当发起表面/native 客户端状态不同于同一聊天审批 auth 时，使用 approvalCapability.getExecInitiatingSurfaceState。核心使用这个 exec 专用钩子来区分 enabled 与 disabled、决定发起渠道是否支持 native exec 审批，并在 native 客户端 fallback 指引中包含该渠道。createApproverRestrictedNativeApprovalCapability(...) 会为常见情况填充这一点。
• 对于渠道特定的 payload 生命周期行为，例如隐藏重复的本地审批提示，或在递送前发送正在输入指示，使用 outbound.shouldSuppressLocalPayloadPrompt 或 outbound.beforeDeliverPayload。
• 仅将 approvalCapability.delivery 用于 native 审批路由或 fallback 抑制。
• 对渠道拥有的 native 审批事实使用 approvalCapability.nativeRuntime。在热渠道入口点上通过 createLazyChannelApprovalNativeRuntimeAdapter(...) 保持懒加载；它可以按需导入你的运行时模块，同时仍让核心组装审批生命周期。
• 仅当渠道确实需要自定义审批 payload，而不是共享渲染器时，使用 approvalCapability.render。
• 当渠道希望 disabled 路径回复解释启用 native exec 审批所需的确切配置旋钮时，使用 approvalCapability.describeExecApprovalSetup。该钩子接收 { channel, channelLabel, accountId }；命名账号渠道应渲染账号作用域路径，例如 channels.<channel>.accounts.<id>.execApprovals.*，而不是顶层默认值。
• 如果渠道可以从现有配置推断稳定的类似所有者的私信身份，使用来自 openclaw/plugin-sdk/approval-runtime 的 createResolvedApproverActionAuthAdapter 来限制同一聊天中的 /approve，而无需添加审批特定的核心逻辑。
• 如果渠道需要 native 审批递送，请让渠道代码聚焦于目标规范化以及传输/呈现事实。使用来自 openclaw/plugin-sdk/approval-runtime 的 createChannelExecApprovalProfile、createChannelNativeOriginTargetResolver、createChannelApproverDmTargetResolver 和 createApproverRestrictedNativeApprovalCapability。将渠道特定事实放在 approvalCapability.nativeRuntime 后面，理想情况下通过 createChannelApprovalNativeRuntimeAdapter(...) 或 createLazyChannelApprovalNativeRuntimeAdapter(...) 实现，这样核心就能组装处理器，并拥有请求过滤、路由、去重、过期、Gateway 网关订阅，以及已路由到其他位置的通知。nativeRuntime 被拆分为几个更小的接缝：
• createChannelNativeOriginTargetResolver 默认对 { to, accountId, threadId } 目标使用共享渠道路由匹配器。仅当渠道具有提供商特定的等价规则时传入 targetsMatch，例如 Slack 时间戳前缀匹配。
• 当渠道需要在默认路由匹配器或自定义 targetsMatch 回调运行前规范化提供商 ID，同时保留原始目标用于递送时，将 normalizeTargetForMatch 传给 createChannelNativeOriginTargetResolver。仅当已解析的递送目标本身也应被规范化时，才使用 normalizeTarget。
• availability - 账号是否已配置，以及请求是否应被处理
• presentation - 将共享审批视图模型映射为待处理/已解决/已过期的 native payload 或最终操作
• transport - 准备目标，并发送/更新/删除 native 审批消息
• interactions - 用于 native 按钮或 reaction 的可选绑定/解绑/清除操作钩子
• observe - 可选递送诊断钩子
• 如果渠道需要运行时拥有的对象，例如客户端、令牌、Bolt 应用或 webhook 接收器，请通过 openclaw/plugin-sdk/channel-runtime-context 注册它们。通用 runtime-context 注册表让核心可以从渠道启动状态引导 capability 驱动的处理器，而无需添加审批特定的包装 glue。
• 仅当 capability 驱动的接缝表达力还不够时，才使用更底层的 createChannelApprovalHandler 或 createChannelNativeApprovalRuntime。
• Native 审批渠道必须通过这些 helper 路由 accountId 和 approvalKind。accountId 让多账号审批策略限定在正确的机器人账号内，approvalKind 让 exec 与插件审批行为可供渠道使用，而无需在核心中硬编码分支。
• 核心现在也拥有审批重路由通知。渠道插件不应从 createChannelNativeApprovalRuntime 发送自己的“审批已发送到私信 / 另一个渠道”后续消息；而应通过共享审批 capability helper 暴露准确的来源 + 审批人私信路由，并让核心在向发起聊天发布任何通知前聚合实际递送。
• 端到端保留已递送审批 ID 的 kind。Native 客户端不应 根据渠道本地状态猜测或重写 exec 与插件审批路由。
• 不同审批 kind 可以有意暴露不同的 native 表面。 当前内置示例：
  • Slack 为 exec 和插件 ID 都保持 native 审批路由可用。
  • Matrix 为 exec 和插件审批保持相同的 native 私信/渠道路由和 reaction UX， 同时仍允许 auth 按审批 kind 区分。
• createApproverRestrictedNativeApprovalAdapter 仍作为兼容包装器存在，但新代码应优先使用 capability builder，并在插件上暴露 approvalCapability。

• openclaw/plugin-sdk/approval-auth-runtime
• openclaw/plugin-sdk/approval-client-runtime
• openclaw/plugin-sdk/approval-delivery-runtime
• openclaw/plugin-sdk/approval-gateway-runtime
• openclaw/plugin-sdk/approval-handler-adapter-runtime
• openclaw/plugin-sdk/approval-handler-runtime
• openclaw/plugin-sdk/approval-native-runtime
• openclaw/plugin-sdk/approval-reply-runtime
• openclaw/plugin-sdk/channel-runtime-context

• openclaw/plugin-sdk/setup-runtime 覆盖运行时安全的设置 helper： import-safe 设置 patch adapter（createPatchedAccountSetupAdapter、 createEnvPatchedAccountSetupAdapter、 createSetupInputPresenceValidator）、lookup-note 输出、 promptResolvedAllowFrom、splitSetupEntries，以及委托的 setup-proxy builder
• openclaw/plugin-sdk/setup-runtime 包含用于 createEnvPatchedAccountSetupAdapter 的 env 感知 adapter 接缝
• openclaw/plugin-sdk/channel-setup 覆盖 optional-install 设置 builder，以及少量设置安全的 primitive： createOptionalChannelSetupSurface、createOptionalChannelSetupAdapter、

• 仅当你还需要较重的共享设置/配置 helper，例如 moveSingleAccountChannelSectionToDefaultAccount(...) 时，才使用更宽的 openclaw/plugin-sdk/setup 接缝

• 对多账号配置和 默认账号 fallback，使用 openclaw/plugin-sdk/account-core、 openclaw/plugin-sdk/account-id、 openclaw/plugin-sdk/account-resolution 和 openclaw/plugin-sdk/account-helpers
• 对入口路由/envelope 和 记录并分发 wiring，使用 openclaw/plugin-sdk/inbound-envelope 和 openclaw/plugin-sdk/inbound-reply-dispatch
• 对目标解析/匹配，使用 openclaw/plugin-sdk/messaging-targets
• 对媒体加载以及出站 身份/发送 delegate 和 payload 规划，使用 openclaw/plugin-sdk/outbound-media 和 openclaw/plugin-sdk/outbound-runtime
• 当出站路由应保留显式 replyToId/threadId，或在基础会话键仍然匹配后恢复当前 :thread: 会话时，使用来自 openclaw/plugin-sdk/channel-core 的 buildThreadAwareOutboundSessionRoute(...)。当提供商插件的平台 具有 native 线程递送语义时，可以覆盖 优先级、后缀行为和线程 ID 规范化。
• 对 thread-binding 生命周期 和 adapter 注册，使用 openclaw/plugin-sdk/thread-bindings-runtime
• 仅当仍需要旧版 agent/media payload 字段布局时，使用 openclaw/plugin-sdk/agent-media-payload
• 对 Telegram 自定义命令 规范化、重复/冲突验证，以及 fallback 稳定的命令 配置契约，使用 openclaw/plugin-sdk/telegram-command-config

​

入口 mention 策略

• 插件拥有的证据收集
• 共享策略评估

• reply-to-bot 检测
• quoted-bot 检测
• 线程参与检查
• service/system-message 排除
• 证明机器人参与所需的平台 native 缓存

• requireMention
• 显式提及结果
• 隐式提及允许列表
• 命令绕过
• 最终跳过决定

1. 计算本地提及事实。
2. 将这些事实传入 resolveInboundMentionDecision({ facts, policy })。
3. 在你的入站门控中使用 decision.effectiveWasMentioned、decision.shouldBypassMention 和 decision.shouldSkip。

import {
  implicitMentionKindWhen,
  matchesMentionWithExplicit,
  resolveInboundMentionDecision,
} from "openclaw/plugin-sdk/channel-inbound";

const mentionMatch = matchesMentionWithExplicit(text, {
  mentionRegexes,
  mentionPatterns,
});

const facts = {
  canDetectMention: true,
  wasMentioned: mentionMatch.matched,
  hasAnyMention: mentionMatch.hasExplicitMention,
  implicitMentionKinds: [
    ...implicitMentionKindWhen("reply_to_bot", isReplyToBot),
    ...implicitMentionKindWhen("quoted_bot", isQuoteOfBot),
  ],
};

const decision = resolveInboundMentionDecision({
  facts,
  policy: {
    isGroup,
    requireMention,
    allowedImplicitMentionKinds: requireExplicitMention ? [] : ["reply_to_bot", "quoted_bot"],
    allowTextCommands,
    hasControlCommand,
    commandAuthorized,
  },
});

if (decision.shouldSkip) return;

• buildMentionRegexes
• matchesMentionPatterns
• matchesMentionWithExplicit
• implicitMentionKindWhen
• resolveInboundMentionDecision

​

演练

{
  "name": "@myorg/openclaw-acme-chat",
  "version": "1.0.0",
  "type": "module",
  "openclaw": {
    "extensions": ["./index.ts"],
    "setupEntry": "./setup-entry.ts",
    "channel": {
      "id": "acme-chat",
      "label": "Acme Chat",
      "blurb": "Connect OpenClaw to Acme Chat."
    }
  }
}

import {
  createChatChannelPlugin,
  createChannelPluginBase,
} from "openclaw/plugin-sdk/channel-core";
import type { OpenClawConfig } from "openclaw/plugin-sdk/channel-core";
import { acmeChatApi } from "./client.js"; // your platform API client

type ResolvedAccount = {
  accountId: string | null;
  token: string;
  allowFrom: string[];
  dmPolicy: string | undefined;
};

function resolveAccount(
  cfg: OpenClawConfig,
  accountId?: string | null,
): ResolvedAccount {
  const section = (cfg.channels as Record<string, any>)?.["acme-chat"];
  const token = section?.token;
  if (!token) throw new Error("acme-chat: token is required");
  return {
    accountId: accountId ?? null,
    token,
    allowFrom: section?.allowFrom ?? [],
    dmPolicy: section?.dmSecurity,
  };
}

export const acmeChatPlugin = createChatChannelPlugin<ResolvedAccount>({
  base: createChannelPluginBase({
    id: "acme-chat",
    setup: {
      resolveAccount,
      inspectAccount(cfg, accountId) {
        const section =
          (cfg.channels as Record<string, any>)?.["acme-chat"];
        return {
          enabled: Boolean(section?.token),
          configured: Boolean(section?.token),
          tokenStatus: section?.token ? "available" : "missing",
        };
      },
    },
  }),

  // DM security: who can message the bot
  security: {
    dm: {
      channelKey: "acme-chat",
      resolvePolicy: (account) => account.dmPolicy,
      resolveAllowFrom: (account) => account.allowFrom,
      defaultPolicy: "allowlist",
    },
  },

  // Pairing: approval flow for new DM contacts
  pairing: {
    text: {
      idLabel: "Acme Chat username",
      message: "Send this code to verify your identity:",
      notify: async ({ target, code }) => {
        await acmeChatApi.sendDm(target, `Pairing code: ${code}`);
      },
    },
  },

  // Threading: how replies are delivered
  threading: { topLevelReplyToMode: "reply" },

  // Outbound: send messages to the platform
  outbound: {
    attachedResults: {
      sendText: async (params) => {
        const result = await acmeChatApi.sendMessage(
          params.to,
          params.text,
        );
        return { messageId: result.id };
      },
    },
    base: {
      sendMedia: async (params) => {
        await acmeChatApi.sendFile(params.to, params.filePath);
      },
    },
  },
});

import { defineChannelPluginEntry } from "openclaw/plugin-sdk/channel-core";
import { acmeChatPlugin } from "./src/channel.js";

export default defineChannelPluginEntry({
  id: "acme-chat",
  name: "Acme Chat",
  description: "Acme Chat channel plugin",
  plugin: acmeChatPlugin,
  registerCliMetadata(api) {
    api.registerCli(
      ({ program }) => {
        program
          .command("acme-chat")
          .description("Acme Chat management");
      },
      {
        descriptors: [
          {
            name: "acme-chat",
            description: "Acme Chat management",
            hasSubcommands: false,
          },
        ],
      },
    );
  },
  registerFull(api) {
    api.registerGatewayMethod(/* ... */);
  },
});

import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core";
import { acmeChatPlugin } from "./src/channel.js";

export default defineSetupPluginEntry(acmeChatPlugin);

registerFull(api) {
  api.registerHttpRoute({
    path: "/acme-chat/webhook",
    auth: "plugin", // plugin-managed auth (verify signatures yourself)
    handler: async (req, res) => {
      const event = parseWebhookPayload(req);

      // Your inbound handler dispatches the message to OpenClaw.
      // The exact wiring depends on your platform SDK -
      // see a real example in the bundled Microsoft Teams or Google Chat plugin package.
      await handleAcmeChatInbound(api, event);

      res.statusCode = 200;
      res.end("ok");
      return true;
    },
  });
}

import { describe, it, expect } from "vitest";
import { acmeChatPlugin } from "./channel.js";

describe("acme-chat plugin", () => {
  it("resolves account from config", () => {
    const cfg = {
      channels: {
        "acme-chat": { token: "test-token", allowFrom: ["user1"] },
      },
    } as any;
    const account = acmeChatPlugin.setup!.resolveAccount(cfg, undefined);
    expect(account.token).toBe("test-token");
  });

  it("inspects account without materializing secrets", () => {
    const cfg = {
      channels: { "acme-chat": { token: "test-token" } },
    } as any;
    const result = acmeChatPlugin.setup!.inspectAccount!(cfg, undefined);
    expect(result.configured).toBe(true);
    expect(result.tokenStatus).toBe("available");
  });

  it("reports missing config", () => {
    const cfg = { channels: {} } as any;
    const result = acmeChatPlugin.setup!.inspectAccount!(cfg, undefined);
    expect(result.configured).toBe(false);
  });
});

pnpm test -- <bundled-plugin-root>/acme-chat/

​

文件结构

<bundled-plugin-root>/acme-chat/
├── package.json              # openclaw.channel metadata
├── openclaw.plugin.json      # Manifest with config schema
├── index.ts                  # defineChannelPluginEntry
├── setup-entry.ts            # defineSetupPluginEntry
├── api.ts                    # Public exports (optional)
├── runtime-api.ts            # Internal runtime exports (optional)
└── src/
    ├── channel.ts            # ChannelPlugin via createChatChannelPlugin
    ├── channel.test.ts       # Tests
    ├── client.ts             # Platform API client
    └── runtime.ts            # Runtime store (if needed)

​

高级主题

​

后续步骤

• 提供商插件 - 如果你的插件也提供模型
• SDK 概览 - 完整子路径导入参考
• SDK 测试 - 测试工具和契约测试
• 插件清单 - 完整清单 schema

​

相关内容

• 插件 SDK 设置
• 构建插件
• Agent harness plugins