​

构建渠道插件

​

渠道插件如何工作

• 配置 — 账号解析和设置向导
• 安全 — 私信策略和允许列表
• 配对 — 私信批准流程
• 会话语法 — 提供商特定的会话 id 如何映射到基础聊天、线程 id 和父级回退
• 出站 — 向平台发送文本、媒体和投票
• 线程 — 回复如何在线程中组织

​

批准和渠道能力

• 核心负责同聊天内的 /approve、共享批准按钮负载，以及通用回退投递。
• 当渠道需要与批准相关的特定行为时，优先在渠道插件上使用一个 approvalCapability 对象。
• ChannelPlugin.approvals 已移除。将批准投递/原生/渲染/授权相关信息放到 approvalCapability 上。
• plugin.auth 仅用于登录/登出；核心不再从该对象读取批准授权钩子。
• approvalCapability.authorizeActorAction 和 approvalCapability.getActionAvailabilityState 是规范的批准授权扩展点。
• 对于同聊天批准授权可用性，使用 approvalCapability.getActionAvailabilityState。
• 如果你的渠道公开原生 exec 批准，请在其与同聊天批准授权不同时，使用 approvalCapability.getExecInitiatingSurfaceState 表示发起表面/原生客户端状态。核心会使用这个 exec 专用钩子来区分 enabled 与 disabled，判断发起渠道是否支持原生 exec 批准，并在原生客户端回退指引中包含该渠道。createApproverRestrictedNativeApprovalCapability(...) 为常见场景填充了这一点。
• 对于渠道特定的负载生命周期行为，例如隐藏重复的本地批准提示或在投递前发送输入中指示，请使用 outbound.shouldSuppressLocalPayloadPrompt 或 outbound.beforeDeliverPayload。
• 仅将 approvalCapability.delivery 用于原生批准路由或回退抑制。
• 将 approvalCapability.nativeRuntime 用于渠道自有的原生批准信息。对于高频渠道入口点，请通过 createLazyChannelApprovalNativeRuntimeAdapter(...) 保持其惰性加载，这样它可以按需导入你的运行时模块，同时仍让核心组装批准生命周期。
• 仅在渠道确实需要自定义批准负载而不是共享渲染器时，才使用 approvalCapability.render。
• 当渠道希望禁用路径回复解释启用原生 exec 批准所需的确切配置项时，使用 approvalCapability.describeExecApprovalSetup。该钩子接收 { channel, channelLabel, accountId }；命名账号渠道应渲染账号作用域路径，例如 channels.<channel>.accounts.<id>.execApprovals.*，而不是顶层默认值。
• 如果某个渠道可以从现有配置中推断出稳定的类似所有者的私信身份，请使用 openclaw/plugin-sdk/approval-runtime 中的 createResolvedApproverActionAuthAdapter 来限制同聊天 /approve，而无需添加批准特定的核心逻辑。
• 如果某个渠道需要原生批准投递，请让渠道代码专注于目标规范化以及传输/展示事实。使用 openclaw/plugin-sdk/approval-runtime 中的 createChannelExecApprovalProfile、createChannelNativeOriginTargetResolver、createChannelApproverDmTargetResolver 和 createApproverRestrictedNativeApprovalCapability。将渠道特定信息放在 approvalCapability.nativeRuntime 后面，理想情况下通过 createChannelApprovalNativeRuntimeAdapter(...) 或 createLazyChannelApprovalNativeRuntimeAdapter(...)，这样核心就可以组装处理器并负责请求过滤、路由、去重、过期、Gateway 网关订阅以及“已路由到其他地方”的通知。nativeRuntime 被拆分为几个更小的扩展点：
• availability — 账号是否已配置，以及请求是否应被处理
• presentation — 将共享批准视图模型映射为待处理/已解决/已过期的原生负载或最终动作
• transport — 准备目标并发送/更新/删除原生批准消息
• interactions — 原生按钮或反应的可选绑定/解绑/清除动作钩子
• observe — 可选的投递诊断钩子
• 如果渠道需要运行时自有对象，例如客户端、令牌、Bolt 应用或 webhook 接收器，请通过 openclaw/plugin-sdk/channel-runtime-context 注册它们。通用 runtime-context 注册表让核心能够从渠道启动状态引导由能力驱动的处理器，而无需添加批准特定的包装胶水代码。
• 只有当能力驱动的扩展点仍不够表达需求时，才使用更底层的 createChannelApprovalHandler 或 createChannelNativeApprovalRuntime。
• 原生批准渠道必须通过这些辅助工具同时传递 accountId 和 approvalKind。accountId 可使多账号批准策略限定在正确的机器人账号范围内，而 approvalKind 可让渠道在无需核心中硬编码分支的情况下区分 exec 与插件批准行为。
• 核心现在也负责批准改道路由通知。渠道插件不应再从 createChannelNativeApprovalRuntime 发送它们自己的“批准已发送到私信/另一个渠道”后续消息；请改为通过共享批准能力辅助工具公开准确的源头 + approver 私信路由，让核心在向发起聊天发送任何通知前聚合实际投递结果。
• 在端到端流程中保留已投递批准 id 的种类。原生客户端不应根据渠道本地状态去猜测或重写 exec 与插件批准路由。
• 不同批准种类可以有意公开不同的原生表面。 当前的内置示例：
  • Slack 对 exec 和插件 id 都保留原生批准路由能力。
  • Matrix 对 exec 和插件批准保留相同的原生私信/渠道路由和反应 UX，同时仍允许授权随批准种类而不同。
• createApproverRestrictedNativeApprovalAdapter 仍然作为兼容性包装器存在，但新代码应优先使用能力构建器，并在插件上公开 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 包含运行时安全的设置辅助工具： 可安全导入的设置补丁适配器（createPatchedAccountSetupAdapter、 createEnvPatchedAccountSetupAdapter、 createSetupInputPresenceValidator）、查找说明输出、 promptResolvedAllowFrom、splitSetupEntries 以及委托式 setup-proxy 构建器
• openclaw/plugin-sdk/setup-adapter-runtime 是用于 createEnvPatchedAccountSetupAdapter 的窄型环境感知适配器扩展点
• openclaw/plugin-sdk/channel-setup 涵盖可选安装设置构建器以及少量设置安全原语： createOptionalChannelSetupSurface、createOptionalChannelSetupAdapter、

• 仅当你还需要更重的共享设置/配置辅助工具时，才使用更宽泛的 openclaw/plugin-sdk/setup 扩展点，例如 moveSingleAccountChannelSectionToDefaultAccount(...)

• openclaw/plugin-sdk/account-core、 openclaw/plugin-sdk/account-id、 openclaw/plugin-sdk/account-resolution 和 openclaw/plugin-sdk/account-helpers 用于多账号配置和默认账号回退
• openclaw/plugin-sdk/inbound-envelope 和 openclaw/plugin-sdk/inbound-reply-dispatch 用于入站路由/封装以及记录与分发接线
• openclaw/plugin-sdk/messaging-targets 用于目标解析/匹配
• openclaw/plugin-sdk/outbound-media 和 openclaw/plugin-sdk/outbound-runtime 用于媒体加载以及出站身份/发送委托
• openclaw/plugin-sdk/thread-bindings-runtime 用于线程绑定生命周期和适配器注册
• 仅当仍需要旧版智能体/媒体负载字段布局时，才使用 openclaw/plugin-sdk/agent-media-payload
• openclaw/plugin-sdk/telegram-command-config 用于 Telegram 自定义命令规范化、重复/冲突校验，以及一个可稳定回退的命令配置契约

​

入站提及策略

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

• 回复机器人检测
• 引用机器人检测
• 线程参与检查
• 服务/系统消息排除
• 证明机器人参与所需的平台原生缓存

• 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 元数据
├── openclaw.plugin.json      # 带有配置 schema 的清单
├── index.ts                  # defineChannelPluginEntry
├── setup-entry.ts            # defineSetupPluginEntry
├── api.ts                    # 公共导出（可选）
├── runtime-api.ts            # 内部运行时导出（可选）
└── src/
    ├── channel.ts            # 通过 createChatChannelPlugin 创建的 ChannelPlugin
    ├── channel.test.ts       # 测试
    ├── client.ts             # 平台 API 客户端
    └── runtime.ts            # 运行时存储（如需要）

​

高级主题

​

后续步骤

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