Plugin maintainer reference

頻道輸入 API

頻道進站是針對傳入頻道事件的實驗性存取控制邊界。外掛負責平台事實與副作用;核心負責通用政策:私訊/群組允許清單、配對儲存區中的私訊項目、路由閘門、命令閘門、事件授權、提及啟用、經遮蔽的診斷資訊,以及准入。

新的接收路徑請使用 openclaw/plugin-sdk/channel-ingress-runtime。較舊的 openclaw/plugin-sdk/channel-ingress 子路徑會繼續匯出,作為供第三方外掛使用的已棄用相容性門面。

執行階段解析器

ts
   defineStableChannelIngressIdentity,  resolveChannelMessageIngress,} from "openclaw/plugin-sdk/channel-ingress-runtime"; const identity = defineStableChannelIngressIdentity({  key: "platform-user-id",  normalize: normalizePlatformUserId,  sensitivity: "pii",}); const result = await resolveChannelMessageIngress({  channelId: "my-channel",  accountId,  identity,  subject: { stableId: platformUserId },  conversation: { kind: isGroup ? "group" : "direct", id: conversationId },  event: { kind: "message", authMode: "inbound", mayPair: !isGroup },  policy: {    dmPolicy: config.dmPolicy,    groupPolicy: config.groupPolicy,    groupAllowFromFallbackToAllowFrom: true,  },  allowFrom: config.allowFrom,  groupAllowFrom: config.groupAllowFrom,  accessGroups: cfg.accessGroups,  route,  readStoreAllowFrom,  command: hasControlCommand ? { allowTextCommands: true, hasControlCommand } : undefined,});

請勿預先計算有效允許清單、命令擁有者或命令群組。解析器會根據原始允許清單、儲存區回呼、路由描述元、存取群組、政策及對話類型推導這些內容。

結果

內建外掛應直接使用現代化投影:

欄位 含義
ingress 依序執行的閘門決策與准入
senderAccess 僅包含傳送者/對話授權
routeAccess 路由與路由傳送者投影
commandAccess 命令授權;未執行命令閘門時為 requested: false
activationAccess 提及/啟用結果

事件授權仍可從依序執行的 ingress.graph 與具決定性的 ingress.reasonCode 取得;不會另外產生事件投影。

已棄用的第三方 SDK 輔助函式可在內部重建舊有結構。新的內建接收路徑不應將現代化結果轉換回本機 DTO。

存取群組

accessGroup:<name> 項目會保持遮蔽。核心會自行解析靜態 message.senders 群組,並且只對需要查詢平台的動態群組呼叫 resolveAccessGroupMembership。缺少、不支援或解析失敗的群組一律採取封閉式拒絕。

事件模式

authMode 含義
inbound 一般傳入事件的傳送者閘門
command 回呼或限定範圍按鈕的命令閘門
origin-subject 執行者必須符合原始訊息主體
route-only 僅對限定路由範圍的受信任事件套用路由閘門
none 外掛擁有的內部事件略過共用授權

回應、按鈕、回呼及原生命令請使用 mayPair: false

路由與啟用

請使用路由描述元定義聊天室、主題、伺服器、討論串或巢狀路由政策:

ts
route: {  id: "room",  allowed: roomAllowed,  enabled: roomEnabled,  senderPolicy: "replace",  senderAllowFrom: roomAllowFrom,  blockReason: "room_sender_not_allowlisted",}

當外掛具有數個選用路由描述元時,請使用 channelIngressRoutes(...);它會篩除停用的分支,同時保持路由事實的通用性,並依每個描述元的 precedence 排序。

提及閘門是一種啟用閘門。未提及時會傳回 admission: "skip",使回合核心不會處理僅供觀察的回合。大多數頻道應將啟用閘門置於傳送者與命令閘門之後。若公開聊天介面必須先抑制未提及的流量,以免產生傳送者允許清單雜訊,且已停用文字命令略過機制,則可選擇使用 activation.order: "before-sender"。具有隱含啟用機制的頻道(例如機器人討論串中的回覆)可傳入 activation.allowedImplicitMentionKinds;投影出的 activationAccess.shouldBypassMention 隨後會指出命令或隱含啟用何時略過了明確提及要求。

遮蔽

原始傳送者值與原始允許清單項目僅能作為解析器輸入。它們不得出現在解析後的狀態、決策、診斷資訊、快照或相容性事實中。請使用不透明的主體 ID、項目 ID、路由 ID 與診斷 ID。

驗證

bash
pnpm test src/channels/message-access/message-access.test.ts src/plugin-sdk/channel-ingress-runtime.test.tspnpm plugin-sdk:api:check
Was this useful?
On this page

On this page