openclaw-wechat-channel 0.1.2 → 0.3.0

package/README.md

@@ -27,32 +27,57 @@ openclaw plugins install openclaw-wechat-channel
 ### Upgrade
 
 ```bash
-openclaw plugins update wechat
+openclaw plugins update openclaw-wechat-channel
 ```
 
 ### Configuration
 
 ```bash
+# Set Wechatify Server proxy URL (required)
+openclaw config set channels.wechat.proxyUrl "http://your-proxy-server:19088"
+
 # Set API Key (required)
 openclaw config set channels.wechat.apiKey "your-api-key"
 
+# Set webhook host — your OpenClaw server's public IP or domain (optional, auto-detected if omitted)
+openclaw config set channels.wechat.webhookHost "your-public-ip"
+
 # Set webhook port (optional, default: 18790)
 openclaw config set channels.wechat.webhookPort 18790
 
+# Set webhook path (optional, default: /webhook/wechat)
+openclaw config set channels.wechat.webhookPath "/webhook/wechat"
+
 # Enable the channel
 openclaw config set channels.wechat.enabled true
 ```
 
-### Configuration Options
-
-```yaml
-# ~/.openclaw/openclaw.json
-channels:
-  wechat:
-    enabled: true
-    apiKey: your-api-key  # Required — Wechatify Server API Key
-    webhookPort: 18790    # Optional — Webhook listen port (default: 18790)
-    webhookUrl: ""        # Optional — Custom webhook callback URL
+### Configuration Reference
+
+| Parameter | Required | Default | Description |
+|---|---|---|---|
+| `apiKey` | Yes | — | Wechatify Server API Key |
+| `proxyUrl` | Yes | — | Wechatify Server address, e.g. `http://your-server:19088` |
+| `webhookHost` | No | auto-detect | Public IP or domain of the OpenClaw server for receiving callbacks |
+| `webhookPort` | No | `18790` | Port for the webhook listener |
+| `webhookPath` | No | `/webhook/wechat` | Path for the webhook endpoint |
+| `enabled` | No | `true` | Enable/disable the channel |
+
+Example (`~/.openclaw/openclaw.json`):
+
+```json
+{
+  "channels": {
+    "wechat": {
+      "enabled": true,
+      "apiKey": "your-api-key",
+      "proxyUrl": "http://your-proxy-server:19088",
+      "webhookHost": "your-public-ip",
+      "webhookPort": 18790,
+      "webhookPath": "/webhook/wechat"
+    }
+  }
+}
 ```
 
 ### Features
@@ -64,16 +89,25 @@ channels:
 
 ### Multi-Account
 
-```yaml
-channels:
-  wechat:
-    accounts:
-      work:
-        apiKey: work-api-key
-        webhookPort: 18790
-      personal:
-        apiKey: personal-api-key
-        webhookPort: 18791
+```json
+{
+  "channels": {
+    "wechat": {
+      "accounts": {
+        "work": {
+          "apiKey": "work-api-key",
+          "proxyUrl": "http://proxy-1:19088",
+          "webhookPort": 18790
+        },
+        "personal": {
+          "apiKey": "personal-api-key",
+          "proxyUrl": "http://proxy-2:19088",
+          "webhookPort": 18791
+        }
+      }
+    }
+  }
+}
 ```
 
 ---
@@ -99,32 +133,57 @@ openclaw plugins install openclaw-wechat-channel
 ### 升级
 
 ```bash
-openclaw plugins update wechat
+openclaw plugins update openclaw-wechat-channel
 ```
 
 ### 配置
 
 ```bash
+# 设置 Wechatify Server 代理地址（必填）
+openclaw config set channels.wechat.proxyUrl "http://your-proxy-server:19088"
+
 # 设置 API Key（必填）
 openclaw config set channels.wechat.apiKey "your-api-key"
 
-# 设置 webhook 端口（可选，默认 18790）
+# 设置 Webhook 公网地址 — OpenClaw 服务器的公网 IP 或域名（可选，不填则自动检测）
+openclaw config set channels.wechat.webhookHost "your-public-ip"
+
+# 设置 Webhook 端口（可选，默认 18790）
 openclaw config set channels.wechat.webhookPort 18790
 
+# 设置 Webhook 路径（可选，默认 /webhook/wechat）
+openclaw config set channels.wechat.webhookPath "/webhook/wechat"
+
 # 启用通道
 openclaw config set channels.wechat.enabled true
 ```
 
-### 配置选项
-
-```yaml
-# ~/.openclaw/openclaw.json
-channels:
-  wechat:
-    enabled: true
-    apiKey: your-api-key  # 必填 — Wechatify Server 的 API Key
-    webhookPort: 18790    # 可选 — Webhook 监听端口（默认 18790）
-    webhookUrl: ""        # 可选 — 自定义 Webhook 回调地址
+### 配置参考
+
+| 参数 | 必填 | 默认值 | 说明 |
+|---|---|---|---|
+| `apiKey` | 是 | — | Wechatify Server 的 API Key |
+| `proxyUrl` | 是 | — | Wechatify Server 地址，如 `http://your-server:19088` |
+| `webhookHost` | 否 | 自动检测 | OpenClaw 服务器的公网 IP 或域名，用于接收消息回调 |
+| `webhookPort` | 否 | `18790` | Webhook 监听端口 |
+| `webhookPath` | 否 | `/webhook/wechat` | Webhook 路径 |
+| `enabled` | 否 | `true` | 是否启用通道 |
+
+配置示例（`~/.openclaw/openclaw.json`）：
+
+```json
+{
+  "channels": {
+    "wechat": {
+      "enabled": true,
+      "apiKey": "your-api-key",
+      "proxyUrl": "http://your-proxy-server:19088",
+      "webhookHost": "your-public-ip",
+      "webhookPort": 18790,
+      "webhookPath": "/webhook/wechat"
+    }
+  }
+}
 ```
 
 ### 功能
@@ -136,16 +195,25 @@ channels:
 
 ### 多账号配置
 
-```yaml
-channels:
-  wechat:
-    accounts:
-      work:
-        apiKey: work-api-key
-        webhookPort: 18790
-      personal:
-        apiKey: personal-api-key
-        webhookPort: 18791
+```json
+{
+  "channels": {
+    "wechat": {
+      "accounts": {
+        "work": {
+          "apiKey": "work-api-key",
+          "proxyUrl": "http://proxy-1:19088",
+          "webhookPort": 18790
+        },
+        "personal": {
+          "apiKey": "personal-api-key",
+          "proxyUrl": "http://proxy-2:19088",
+          "webhookPort": 18791
+        }
+      }
+    }
+  }
+}
 ```
 
 ---

package/dist/index.d.mts

@@ -17,6 +17,7 @@ interface WechatAccountConfig {
   wcId?: string;
   nickName?: string;
   configured?: boolean;
+  allowUsers?: string[];
 }
 interface WechatConfig {
   enabled?: boolean;
@@ -25,6 +26,7 @@ interface WechatConfig {
   webhookHost?: string;
   webhookPort?: number;
   webhookPath?: string;
+  allowUsers?: string[];
   accounts?: Record<string, WechatAccountConfig | undefined>;
 }
 //#endregion
@@ -43,6 +45,7 @@ interface ResolvedWeChatAccount {
   webhookHost?: string;
   webhookPort: number;
   webhookPath: string;
+  allowUsers?: string[];
   config: WechatAccountConfig;
 }
 //#endregion

package/dist/index.mjs

@@ -1,5 +1,7 @@
 import { DEFAULT_ACCOUNT_ID, createReplyPrefixContext, emptyPluginConfigSchema } from "openclaw/plugin-sdk";
 import http from "node:http";
+import { H3, defineEventHandler, readBody } from "h3";
+import { toNodeHandler } from "h3/node";
 
 //#region src/proxy-client.ts
 var ProxyClient = class {
@@ -105,14 +107,17 @@ function getWeChatRuntime() {
 //#region src/reply-dispatcher.ts
 function createWeChatReplyDispatcher(params) {
 	const core = getWeChatRuntime();
-	const { cfg, agentId, runtime, apiKey, replyTo, accountId } = params;
+	const { cfg, agentId, runtime, apiKey, proxyUrl, replyTo, accountId } = params;
 	const prefixContext = createReplyPrefixContext({
 		cfg,
 		agentId
 	});
 	const textChunkLimit = core.channel.text.resolveTextChunkLimit(cfg, "wechat", accountId, { fallbackLimit: 2e3 });
 	const chunkMode = core.channel.text.resolveChunkMode(cfg, "wechat");
-	const client = new ProxyClient({ apiKey });
+	const client = new ProxyClient({
+		apiKey,
+		baseUrl: proxyUrl
+	});
 	const { dispatcher, replyOptions, markDispatchIdle } = core.channel.reply.createReplyDispatcherWithTyping({
 		responsePrefix: prefixContext.responsePrefix,
 		responsePrefixContextProvider: prefixContext.responsePrefixContextProvider,
@@ -155,6 +160,7 @@ const DEDUP_WINDOW_MS = 1800 * 1e3;
 const DEDUP_MAX_SIZE = 1e3;
 const DEDUP_CLEANUP_INTERVAL_MS = 300 * 1e3;
 let lastCleanup = Date.now();
+const notifiedNonWhitelistUsers = /* @__PURE__ */ new Set();
 function tryRecordMessage(messageId) {
 	const now = Date.now();
 	if (now - lastCleanup > DEDUP_CLEANUP_INTERVAL_MS) {
@@ -177,6 +183,18 @@ async function handleWeChatMessage(params) {
 		log(`wechat: skipping duplicate message ${message.id}`);
 		return;
 	}
+	const allowUsers = account.allowUsers;
+	if (allowUsers && allowUsers.length > 0 && message.sender.id !== account.wcId && !allowUsers.includes(message.sender.id)) {
+		log(`wechat[${accountId}]: ignoring message from ${message.sender.id} (not in allowUsers)`);
+		if (account.wcId && !notifiedNonWhitelistUsers.has(message.sender.id)) {
+			notifiedNonWhitelistUsers.add(message.sender.id);
+			await new ProxyClient({
+				apiKey: account.apiKey,
+				baseUrl: account.proxyUrl
+			}).sendText(account.wcId, `‼️ ${message.sender.id} 不在白名单中，配置 allowUsers 后即可回复`).catch(() => {});
+		}
+		return;
+	}
 	const isGroup = !!message.group;
 	log(`wechat[${accountId}]: received ${message.type} from ${message.sender.id}${isGroup ? ` in group ${message.group.id}` : ""}`);
 	if (message.type !== "text") {
@@ -240,6 +258,7 @@ async function handleWeChatMessage(params) {
 			agentId: route.agentId,
 			runtime,
 			apiKey: account.apiKey,
+			proxyUrl: account.proxyUrl,
 			replyTo,
 			accountId: account.accountId
 		});
@@ -260,23 +279,17 @@ async function handleWeChatMessage(params) {
 //#endregion
 //#region src/callback-server.ts
 async function startCallbackServer(options) {
-	const { port, onMessage, abortSignal } = options;
-	const server = http.createServer((req, res) => {
-		if ((req.url?.split("?")[0] || "") === "/webhook/wechat" && req.method === "POST") {
-			let body = "";
-			req.on("data", (chunk) => body += chunk);
-			req.on("end", async () => {
-				try {
-					const message = convertToMessageContext(JSON.parse(body));
-					if (message) onMessage(message);
-					res.writeHead(200).end("OK");
-				} catch (err) {
-					console.error("Failed to process webhook:", err);
-					res.writeHead(400).end("Bad Request");
-				}
-			});
-		} else res.writeHead(404).end("Not Found");
-	});
+	const { port, apiKey, onMessage, abortSignal } = options;
+	const app = new H3();
+	app.post("/webhook/wechat", defineEventHandler(async (event) => {
+		const incomingKey = event.req.headers.get("x-api-key");
+		if (apiKey && incomingKey !== apiKey) throw createHttpError(401, "Unauthorized");
+		const message = convertToMessageContext(await readBody(event));
+		if (message) onMessage(message);
+		return "OK";
+	}));
+	const handler = toNodeHandler(app);
+	const server = http.createServer(handler);
 	return new Promise((resolve, reject) => {
 		server.listen(port, "0.0.0.0", () => {
 			const addr = server.address();
@@ -299,6 +312,11 @@ async function startCallbackServer(options) {
 		});
 	});
 }
+function createHttpError(statusCode, message) {
+	const error = new Error(message);
+	error.statusCode = statusCode;
+	return error;
+}
 function normalizePayload(payload) {
 	const { messageType, wcId } = payload;
 	if (payload.fromUser) return {
@@ -402,6 +420,7 @@ function displayLoginSuccess(nickName, wcId) {
 
 //#endregion
 //#region src/channel.ts
+const runningServers = /* @__PURE__ */ new Map();
 const PLUGIN_META = {
 	id: "wechat",
 	label: "WeChat",
@@ -426,7 +445,8 @@ function resolveWeChatAccount({ cfg, accountId }) {
 			proxyUrl: wechatCfg?.proxyUrl,
 			webhookHost: wechatCfg?.webhookHost,
 			webhookPort: wechatCfg?.webhookPort,
-			webhookPath: wechatCfg?.webhookPath
+			webhookPath: wechatCfg?.webhookPath,
+			allowUsers: wechatCfg?.allowUsers
 		};
 		const defaultAccount = wechatCfg?.accounts?.default;
 		accountCfg = {
@@ -454,6 +474,7 @@ function resolveWeChatAccount({ cfg, accountId }) {
 		webhookHost: accountCfg.webhookHost,
 		webhookPort: accountCfg.webhookPort || 18790,
 		webhookPath: accountCfg.webhookPath || "/webhook/wechat",
+		allowUsers: accountCfg.allowUsers,
 		config: accountCfg
 	};
 }
@@ -491,6 +512,10 @@ const wechatPlugin = {
 			webhookHost: { type: "string" },
 			webhookPort: { type: "integer" },
 			webhookPath: { type: "string" },
+			allowUsers: {
+				type: "array",
+				items: { type: "string" }
+			},
 			accounts: {
 				type: "object",
 				additionalProperties: {
@@ -505,7 +530,11 @@ const wechatPlugin = {
 						webhookPort: { type: "integer" },
 						webhookPath: { type: "string" },
 						wcId: { type: "string" },
-						nickName: { type: "string" }
+						nickName: { type: "string" },
+						allowUsers: {
+							type: "array",
+							items: { type: "string" }
+						}
 					},
 					required: ["apiKey"]
 				}
@@ -584,15 +613,8 @@ const wechatPlugin = {
 			name: account.name || account.nickName || account.accountId,
 			wcId: account.wcId,
 			isLoggedIn: account.isLoggedIn
-		}),
-		resolveAllowFrom: ({ cfg, accountId }) => {
-			return [];
-		},
-		formatAllowFrom: ({ allowFrom }) => allowFrom.map(String)
+		})
 	},
-	security: { collectWarnings: ({ cfg, accountId }) => {
-		return [];
-	} },
 	setup: {
 		resolveAccountId: () => DEFAULT_ACCOUNT_ID,
 		applyAccountConfig: ({ cfg, accountId }) => {
@@ -640,7 +662,7 @@ const wechatPlugin = {
 	},
 	directory: {
 		self: async () => null,
-		listPeers: async ({ cfg, query, limit, accountId }) => {
+		listPeers: async ({ cfg, limit, accountId }) => {
 			const account = resolveWeChatAccount({
 				cfg,
 				accountId: accountId || DEFAULT_ACCOUNT_ID
@@ -655,7 +677,7 @@ const wechatPlugin = {
 				name: id
 			}));
 		},
-		listGroups: async ({ cfg, query, limit, accountId }) => {
+		listGroups: async ({ cfg, limit, accountId }) => {
 			const account = resolveWeChatAccount({
 				cfg,
 				accountId: accountId || DEFAULT_ACCOUNT_ID
@@ -688,7 +710,7 @@ const wechatPlugin = {
 			lastError: snapshot.lastError ?? null,
 			port: snapshot.port ?? null
 		}),
-		probeAccount: async ({ account, cfg }) => {
+		probeAccount: async ({ account }) => {
 			const client = new ProxyClient({
 				apiKey: account.apiKey,
 				baseUrl: account.proxyUrl
@@ -790,6 +812,12 @@ const wechatPlugin = {
 		log?.info(`Using webhook URL: ${webhookUrl}`);
 		log?.info(`Registering webhook with proxy service for wcId: ${account.wcId}`);
 		await client.registerWebhook(account.wcId, webhookUrl);
+		const prevStop = runningServers.get(accountId);
+		if (prevStop) {
+			prevStop();
+			runningServers.delete(accountId);
+			await new Promise((r) => setTimeout(r, 500));
+		}
 		const { stop } = await startCallbackServer({
 			port,
 			apiKey: account.apiKey,
@@ -807,10 +835,12 @@ const wechatPlugin = {
 			abortSignal
 		});
 		abortSignal?.addEventListener("abort", stop);
+		runningServers.set(accountId, stop);
 		log?.info(`WeChat account ${accountId} started successfully on port ${port}`);
 		log?.info(`Webhook URL: ${webhookUrl}`);
 		return { async stop() {
 			stop();
+			runningServers.delete(accountId);
 			setStatus({
 				accountId,
 				port,

package/openclaw.plugin.json

@@ -3,7 +3,14 @@
   "channels": ["wechat"],
   "configSchema": {
     "type": "object",
+    "additionalProperties": false,
     "properties": {
+      "enabled": { "type": "boolean" },
+      "apiKey": { "type": "string" },
+      "proxyUrl": { "type": "string" },
+      "webhookHost": { "type": "string" },
+      "webhookPort": { "type": "integer" },
+      "webhookPath": { "type": "string" },
       "accounts": {
         "type": "object",
         "additionalProperties": {
@@ -13,8 +20,10 @@
             "enabled": { "type": "boolean" },
             "name": { "type": "string" },
             "apiKey": { "type": "string" },
+            "proxyUrl": { "type": "string" },
+            "webhookHost": { "type": "string" },
             "webhookPort": { "type": "integer" },
-            "webhookUrl": { "type": "string" },
+            "webhookPath": { "type": "string" },
             "wcId": { "type": "string" },
             "nickName": { "type": "string" }
           },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "openclaw-wechat-channel",
   "type": "module",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "packageManager": "pnpm@10.30.0",
   "description": "OpenClaw WeChat channel plugin via Proxy API",
   "license": "MIT",
@@ -63,6 +63,9 @@
   "peerDependencies": {
     "openclaw": ">=2026.2.9"
   },
+  "dependencies": {
+    "h3": "2.0.1-rc.14"
+  },
   "devDependencies": {
     "@antfu/eslint-config": "^7.4.3",
     "@types/node": "^25.3.0",