WeChat Logo

WeCom OpenClaw Integration

🤖 Connect your AI agent to WeCom (企业微信)
_{Send messages via WeCom → AI processes → Control your computer remotely}

Created by LiuJinQi (11haonb) @ Beijing Institute of Technology

📚 Docs • Quick Start • Features • Browser Control • 中文文档

--- ## 📖 What is this? This plugin connects [OpenClaw](https://github.com/openclaw/openclaw) AI agent to **WeCom (企业微信/WeChat Work)**.

💬	Chat with AI Send messages via WeCom, get AI-powered responses
🖥️	Remote Browser Control Control your PC's browser from your phone
📁	Rich Media Send/receive images, voice, video, files
🔧	Tool Calling AI can execute tasks with 100+ built-in tools

--- ## ⚡ Quick Start ### 1️⃣ Get WeCom Credentials | Field | Where to Find | |:------|:--------------| | **Corp ID** | WeCom Admin → My Enterprise → Enterprise ID | | **Agent ID** | App Management → Your App → Agent ID | | **Secret** | App Management → Your App → Secret | | **Token** | Your App → Receive Messages → Generate | | **AES Key** | Your App → Receive Messages → Generate | ### 2️⃣ Configure OpenClaw Create `~/.openclaw/openclaw.json`: ```json { "env": { "WECOM_CORP_ID": "ww1234567890abcdef", "WECOM_CORP_SECRET": "your-app-secret", "WECOM_AGENT_ID": "1000001", "WECOM_CALLBACK_TOKEN": "your-token", "WECOM_CALLBACK_AES_KEY": "your-43-character-aes-key" }, "plugins": { "entries": { "wecom": { "enabled": true } } } } ``` ### 3️⃣ Start Gateway ```bash cd /path/to/openclaw pnpm build && node dist/entry.js gateway ``` ### 4️⃣ Set Callback URL In WeCom Admin → Your App → Receive Messages: ``` URL: http://YOUR_SERVER:18789/wecom/callback ``` ### 5️⃣ Test It! 🎉 Open WeCom app → Find your app → Send "Hello"! --- ## ✨ Features

Category	Feature	Status
📨 Messaging	Text messages	✅
	Image messages	✅
	Voice messages	✅
	Video messages	✅
	File messages	✅
	Message cards	✅
👥 Group Chat	Group messages	✅
	@mention detection	✅
	Access control	✅
🖥️ Browser	Remote control	✅
🖥️ Browser	Screenshot capture	✅
⚙️ Advanced	Multi-account	✅
	Event handling	✅
	Mini programs	✅

--- ## 🖥️ Remote Browser Control **Control your computer's browser from your phone!** ``` ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │ 📱 Phone │ │ 🖥️ Server │ │ 💻 Your PC │ │ WeCom │ ───▶ │ OpenClaw │ ───▶ │ Browser │ └──────────────┘ └──────────────┘ └──────────────┘ ``` ### Setup

1. Configure Server

Add to `~/.openclaw/openclaw.json`: ```json { "browser": { "enabled": true }, "gateway": { "nodes": { "browser": { "mode": "auto" } } } } ```

2. Install and Run Node Host on Your PC

```bash # Install OpenClaw npm install -g openclaw # Connect to your server openclaw node run --host YOUR_SERVER_IP --port 18789 ```

3. Send Commands via WeCom

| Command | Action | |:--------|:-------| | `打开浏览器访问淘宝` | Open browser, go to taobao.com | | `搜索 iPhone 16` | Search on current page | | `截图` | Take screenshot | | `点击第一个商品` | Click first product |

📖 **[Full Browser Control Guide →](./docs/BROWSER_CONTROL.md)** --- ## ⚙️ Configuration ### Environment Variables | Variable | Required | Description | |:---------|:--------:|:------------| | `WECOM_CORP_ID` | ✅ | Enterprise ID | | `WECOM_CORP_SECRET` | ✅ | App secret | | `WECOM_AGENT_ID` | ✅ | App agent ID | | `WECOM_CALLBACK_TOKEN` | ✅ | Callback token | | `WECOM_CALLBACK_AES_KEY` | ✅ | 43-char AES key | | `WECOM_BOT_NAME` | | Bot name for @mention | | `WECOM_WELCOME_MESSAGE` | | Auto-reply for new users | ### Full Example

Click to expand

```json { "env": { "OPENROUTER_API_KEY": "sk-or-xxx", "WECOM_CORP_ID": "ww1234567890", "WECOM_CORP_SECRET": "your-secret", "WECOM_AGENT_ID": "1000001", "WECOM_CALLBACK_TOKEN": "your-token", "WECOM_CALLBACK_AES_KEY": "your-43-char-key", "WECOM_BOT_NAME": "AI助手", "WECOM_WELCOME_MESSAGE": "你好！我是AI助手，有什么可以帮你的？" }, "agents": { "defaults": { "model": { "primary": "openrouter/qwen/qwen3-max" } } }, "browser": { "enabled": true }, "gateway": { "mode": "local", "bind": "lan", "nodes": { "browser": { "mode": "auto" } } }, "plugins": { "entries": { "wecom": { "enabled": true } } } } ```

--- ## 👥 Group Chat | Mode | Behavior | |:-----|:---------| | **Private Chat** | Bot responds to all messages | | **Group Chat** | Bot only responds when @mentioned | Configure @mention names: ```bash WECOM_BOT_NAME=小助手 WECOM_BOT_ALIASES=AI,机器人,助手 ``` --- ## 🔌 API Reference

WeComApiClient

```typescript import { WeComApiClient } from "wecom-openclaw-integration"; const client = new WeComApiClient({ corpId: "your-corp-id", corpSecret: "your-secret", agentId: 1000001, }); // Send text await client.sendText("userid", "Hello!"); // Send image await client.sendImageFromUrl("userid", "https://example.com/image.jpg"); // Send file await client.sendFileFile("userid", "/path/to/file.pdf"); // Send card await client.sendTextCard("userid", { title: "Card Title", description: "Description", url: "https://example.com", }); ```

Event Handling

```typescript import { onEvent, setWelcomeMessage } from "wecom-openclaw-integration"; // Welcome new users setWelcomeMessage("Welcome! How can I help?"); // Handle events onEvent("subscribe", async (event, config) => { console.log(`New user: ${event.fromUserName}`); }); onEvent("click", async (event, config) => { // Handle menu clicks }); ```

Mini Programs

```typescript import { createMiniProgramClient } from "wecom-openclaw-integration"; const mpClient = createMiniProgramClient(client); await mpClient.sendSimpleMiniProgramCard("userid", { appid: "wx123456", pagepath: "/pages/index", title: "Open Mini Program", }); ```

--- ## 🤖 Recommended Models | Region | Model | Notes | |:-------|:------|:------| | 🇨🇳 China | `openrouter/qwen/qwen3-max` | ⭐ Recommended, no proxy | | 🇨🇳 China | `openrouter/deepseek/deepseek-chat` | Fast, cheap | | 🌍 Global | `openrouter/anthropic/claude-sonnet-4` | Best quality | | 🌍 Global | `openrouter/openai/gpt-4o` | Good balance | **Using proxy:** ```bash HTTPS_PROXY=http://127.0.0.1:7890 node dist/entry.js gateway ``` --- ## 📁 Project Structure ``` wecom-openclaw-integration/ ├── 📄 index.ts # Plugin entry point ├── 📁 src/ │ ├── api.ts # WeCom API client │ ├── crypto.ts # AES encryption │ ├── parser.ts # XML parser │ ├── monitor.ts # Webhook handler │ ├── channel.ts # Channel definition │ ├── types.ts # TypeScript types │ ├── group-policy.ts # Group chat rules │ ├── mention.ts # @mention detection │ ├── multi-account.ts # Multi-account support │ ├── events.ts # Event handlers │ └── miniprogram.ts # Mini program support ├── 📁 docs/ │ ├── QUICKSTART_CN.md # 中文快速入门 │ └── BROWSER_CONTROL.md # Browser control guide ├── 📁 test/ # Test files ├── 📄 CHANGELOG.md # Version history └── 📄 README.md # This file ``` --- ## 📖 Documentation | Document | Description | |:---------|:------------| | [Quick Start (English)](./docs/QUICKSTART_EN.md) | 5-minute setup guide | | [Quick Start (中文)](./docs/QUICKSTART_CN.md) | 5 分钟快速入门 | | [Remote Control (English)](./docs/REMOTE_CONTROL_EN.md) | Control Windows PC remotely | | [Remote Control (中文)](./docs/REMOTE_CONTROL_CN.md) | 远程控制 Windows 电脑 | | [Changelog](./CHANGELOG.md) | Version history | --- ## 🐛 Troubleshooting

Callback URL verification failed

- ✅ Check Token and AES Key match exactly - ✅ Ensure server is accessible from internet - ✅ Check firewall allows port 18789

Messages not received

- ✅ Verify callback URL in WeCom admin - ✅ Check logs: `tail -f /tmp/gateway.log` - ✅ Ensure plugin is enabled

Browser control not working

- ✅ Verify Node Host is connected - ✅ Check `browser.enabled: true` - ✅ Check `gateway.nodes.browser.mode: "auto"`

--- ## 🤝 Contributing Contributions are welcome! Please feel free to submit a Pull Request. 1. Fork the repository 2. Create your feature branch (`git checkout -b feature/amazing-feature`) 3. Commit your changes (`git commit -m 'Add amazing feature'`) 4. Push to the branch (`git push origin feature/amazing-feature`) 5. Open a Pull Request --- ## ✨ Contributors

--- ## 📄 License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. --- ## 🔗 Links

OpenClaw • WeCom Developer Docs

---

Made with ❤️ by liujinqi @ Beijing Institute of Technology