@mocrane/wecom 2026.2.27 → 2026.3.8-4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +4 -18
- package/README.md +572 -0
- package/assets/01.bot-add.png +0 -0
- package/assets/01.bot-setp2.png +0 -0
- package/assets/02.agent.add.png +0 -0
- package/assets/02.agent.api-set.png +0 -0
- package/assets/register.png +0 -0
- package/changelog/v2.2.28.md +70 -0
- package/changelog/v2.3.2.md +28 -0
- package/changelog/v2.3.4.md +20 -0
- package/index.ts +11 -3
- package/package.json +4 -2
- package/src/accounts.ts +17 -55
- package/src/agent/api-client.ts +84 -37
- package/src/agent/api-client.upload.test.ts +110 -0
- package/src/agent/handler.event-filter.test.ts +50 -0
- package/src/agent/handler.ts +147 -145
- package/src/channel.config.test.ts +147 -0
- package/src/channel.lifecycle.test.ts +252 -0
- package/src/channel.ts +132 -141
- package/src/config/accounts.resolve.test.ts +38 -0
- package/src/config/accounts.ts +267 -25
- package/src/config/index.ts +6 -0
- package/src/config/network.ts +9 -5
- package/src/config/routing.test.ts +88 -0
- package/src/config/routing.ts +26 -0
- package/src/config/schema.ts +41 -6
- package/src/config-schema.ts +5 -41
- package/src/dynamic-agent.account-scope.test.ts +17 -0
- package/src/dynamic-agent.ts +13 -13
- package/src/gateway-monitor.ts +260 -0
- package/src/http.ts +16 -2
- package/src/media.test.ts +28 -1
- package/src/media.ts +59 -1
- package/src/monitor/state.queue.test.ts +1 -1
- package/src/monitor/state.ts +1 -1
- package/src/monitor/types.ts +5 -1
- package/src/monitor.active.test.ts +15 -9
- package/src/monitor.inbound-filter.test.ts +63 -0
- package/src/monitor.integration.test.ts +4 -2
- package/src/monitor.ts +982 -134
- package/src/monitor.webhook.test.ts +381 -3
- package/src/onboarding.ts +379 -54
- package/src/outbound.test.ts +130 -0
- package/src/outbound.ts +82 -9
- package/src/shared/command-auth.ts +4 -2
- package/src/shared/xml-parser.test.ts +21 -1
- package/src/shared/xml-parser.ts +18 -0
- package/src/types/account.ts +54 -16
- package/src/types/config.ts +50 -6
- package/src/types/constants.ts +7 -3
- package/src/types/index.ts +3 -0
- package/src/types.ts +29 -147
- package/src/ws-adapter.ts +481 -0
package/LICENSE
CHANGED
|
@@ -1,21 +1,7 @@
|
|
|
1
|
-
|
|
1
|
+
ISC License (ISC)
|
|
2
2
|
|
|
3
|
-
Copyright (c) 2026
|
|
3
|
+
Copyright (c) 2026
|
|
4
4
|
|
|
5
|
-
Permission is hereby granted,
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
5
|
+
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
|
|
11
6
|
|
|
12
|
-
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
7
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,572 @@
|
|
|
1
|
+
# OpenClaw 企业微信(WeCom)Channel 插件
|
|
2
|
+
|
|
3
|
+
> [!WARNING]
|
|
4
|
+
> **OpenClaw 3.1+ 升级必读**:升级到 OpenClaw `3.1` 及以上版本的用户务必同步升级本插件,并将企业微信回调 URL 更新为 OpenClaw 推荐路径:`/plugins/wecom/bot/{accountId}` 与 `/plugins/wecom/agent/{accountId}`(旧 `/wecom/*` 仍兼容但不再维护)。
|
|
5
|
+
|
|
6
|
+
<p align="center">
|
|
7
|
+
<img src="https://img.shields.io/badge/Original%20Project-YanHaidao-orange?style=for-the-badge&logo=github" alt="Original Project" />
|
|
8
|
+
<img src="https://img.shields.io/badge/License-ISC-blue?style=for-the-badge" alt="License" />
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
> [!WARNING]
|
|
12
|
+
> **原创声明**:本项目涉及的“多账号隔离与矩阵路由架构”、“Bot+Agent双模融合架构”、“长任务超时接力逻辑”及“全自动媒体流转接”等核心设计均为作者 **YanHaidao** 独立思考与实践的原创成果。
|
|
13
|
+
> 欢迎技术交流与合规引用,但**严禁任何不经授权的“功能像素级抄袭”或删除原作者署名的代码搬运行为**。
|
|
14
|
+
|
|
15
|
+
<p align="center">
|
|
16
|
+
<strong>🚀 企业级双模式 AI 助手接入方案</strong>
|
|
17
|
+
</p>
|
|
18
|
+
|
|
19
|
+
<p align="center">
|
|
20
|
+
<a href="#sec-1">💡 核心价值</a> •
|
|
21
|
+
<a href="#sec-2">📊 模式对比</a> •
|
|
22
|
+
<a href="#sec-3">一、快速开始</a> •
|
|
23
|
+
<a href="#sec-4">二、配置说明</a> •
|
|
24
|
+
<a href="#sec-9">七、联系我</a>
|
|
25
|
+
</p>
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
<a id="sec-1"></a>
|
|
30
|
+
## 💡 核心价值:为什么选择本插件?
|
|
31
|
+
|
|
32
|
+
### 独创架构:Bot + Agent 双模融合 (Original Design by YanHaidao)
|
|
33
|
+
|
|
34
|
+
传统的企微插件通常只能在 "只能聊天的机器人 (Bot)" 和 "只能推送的自建应用 (Agent)" 之间二选一。
|
|
35
|
+
本插件采用 **双模并行架构**,同时压榨两种模式的极限能力:
|
|
36
|
+
|
|
37
|
+
* **Bot 通道 (智能体)**:负责 **实时对话**。提供毫秒级流式响应(打字机效果),零延迟交互。
|
|
38
|
+
* **Agent 通道 (自建应用)**:负责 **能力兜底**。当需要发送图片/文件、进行全员广播、或 Bot 对话超时(>6分钟)时,无缝切换到 Agent 通道接管。
|
|
39
|
+
|
|
40
|
+
### 🚀 企业级:多账号(Multi-account)矩阵隔离 (Original Design)
|
|
41
|
+
|
|
42
|
+
本插件支持 **无限扩展的账号矩阵**,这是本插件区别于普通插件的核心壁垒:
|
|
43
|
+
|
|
44
|
+
* **完全隔离 (Isolation)**:不同 `accountId` 之间的会话、动态 Agent、上下文完全隔离,互不串扰。
|
|
45
|
+
* **矩阵绑定 (Binding)**:支持一个 OpenClaw 实例同时挂载多个企业/多个应用,通过 `bindings` 灵活分发流量。
|
|
46
|
+
* **智能路由 (Routing)**:基于入站 `accountId` 自动分拣回复路径,Bot 无法回复时仅回退到**同账号组内**的 Agent,实现闭环的高可用。
|
|
47
|
+
|
|
48
|
+
### 功能特性全景
|
|
49
|
+
|
|
50
|
+
#### 🗣 **沉浸式交互 (Immersive Interaction)**
|
|
51
|
+
* **原生流式 (Stream)**:基于 HTTP 分块传输,拒绝 "转圈等待",体验如 ChatGPT 网页版般丝滑。
|
|
52
|
+
* **交互式卡片 (Card)**:支持 Button/Menu 交互回传,可构建审批、查询等复杂业务流 (Agent模式)。
|
|
53
|
+
|
|
54
|
+
#### 📎 **全模态支持 (Multi-Modal)**
|
|
55
|
+
* **发什么都能看**:支持接收图片、文件 (PDF/Doc/Zip)、语音 (自动转文字)、视频。
|
|
56
|
+
* **要什么都能给**:AI 生成的图表、代码文件、语音回复,均可自动上传并推送到企微。
|
|
57
|
+
|
|
58
|
+
#### 📢 **企业级触达 (Enterprise Reach)**
|
|
59
|
+
* **精准广播**:支持向 **部门 (Party)**、**标签 (Tag)** 或 **外部群** 批量推送消息。
|
|
60
|
+
* **Cronjob 集成**:通过简单的 JSON 配置实现早报推送、日报提醒、服务器报警。
|
|
61
|
+
|
|
62
|
+
#### 🛡 **生产级稳定 (Production Ready)**
|
|
63
|
+
* **容灾切换**:Bot 模式 6 分钟超时自动熔断,切换 Agent 私信送达,防止长任务回答丢失。
|
|
64
|
+
* **Token 自动运维**:内置 AccessToken 守护进程,自动缓存、提前刷新、过期重试。
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
<a id="sec-2"></a>
|
|
70
|
+
## 📊 模式能力对比
|
|
71
|
+
|
|
72
|
+
| 能力维度 | 🤖 Bot 模式 | 🧩 Agent 模式 | ✨ **本插件 (双模)** |
|
|
73
|
+
|:---|:---|:---|:---|
|
|
74
|
+
| **接收消息 (单聊)** | ✅ 文本/图片/语音/文件 | ✅ 文本/图片/语音/视频/位置/链接 | **✅ 全能互补** (覆盖所有类型) |
|
|
75
|
+
| **接收消息 (群聊)** | ✅ 文本/引用 | ❌ 不支持 (无回调) | **✅ 文本/引用** |
|
|
76
|
+
| **发送消息** | ❌ 仅支持文本/图片/Markdown | ✅ **全格式支持** (文本/图片/视频/文件等) | **✅ 智能路由** (自动切换) |
|
|
77
|
+
| **流式响应** | ✅ **支持** (打字机效果) | ❌ 不支持 | **✅ 完美支持** |
|
|
78
|
+
| **主动推送** | ❌ 仅被动回复 | ✅ **支持** (指定用户/部门/标签) | **✅ 完整 API** |
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
<a id="sec-3"></a>
|
|
83
|
+
## 一、🚀 快速开始
|
|
84
|
+
|
|
85
|
+
> 默认推荐:**多账号 + 多 Agent(matrix)**。
|
|
86
|
+
> 建议 OpenClaw 使用 **2026.2.24+** 版本以获得完整生命周期与多账号行为修复。
|
|
87
|
+
|
|
88
|
+
### 1.1 安装插件
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
openclaw plugins install @mocrane/wecom
|
|
92
|
+
openclaw plugins enable wecom
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
也可以通过命令行向导快速配置:
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
openclaw config --section channels
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### 1.2 推荐配置:多账号 + 多 Agent(默认)
|
|
102
|
+
|
|
103
|
+
直接用命令写入多 `accountId` 配置(会写入 `~/.openclaw/openclaw.json`):
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
# 1) 打开 WeCom 通道并设置默认账号
|
|
107
|
+
openclaw config set channels.wecom.enabled true
|
|
108
|
+
openclaw config set channels.wecom.defaultAccount ops
|
|
109
|
+
|
|
110
|
+
# 2) 新增 ops 账号(Bot + Agent)
|
|
111
|
+
openclaw config set channels.wecom.accounts.ops '{
|
|
112
|
+
"enabled": true,
|
|
113
|
+
"name": "运维机器人",
|
|
114
|
+
"bot": {
|
|
115
|
+
"aibotid": "BOT_OPS",
|
|
116
|
+
"token": "BOT_TOKEN_OPS",
|
|
117
|
+
"encodingAESKey": "BOT_AES_OPS",
|
|
118
|
+
"receiveId": ""
|
|
119
|
+
},
|
|
120
|
+
"agent": {
|
|
121
|
+
"corpId": "CORP_ID",
|
|
122
|
+
"corpSecret": "AGENT_SECRET_OPS",
|
|
123
|
+
"agentId": 1000001,
|
|
124
|
+
"token": "AGENT_TOKEN_OPS",
|
|
125
|
+
"encodingAESKey": "AGENT_AES_OPS"
|
|
126
|
+
}
|
|
127
|
+
}'
|
|
128
|
+
|
|
129
|
+
# 3) 新增 sales 账号(Bot + Agent)
|
|
130
|
+
openclaw config set channels.wecom.accounts.sales '{
|
|
131
|
+
"enabled": true,
|
|
132
|
+
"name": "销售机器人",
|
|
133
|
+
"bot": {
|
|
134
|
+
"aibotid": "BOT_SALES",
|
|
135
|
+
"token": "BOT_TOKEN_SALES",
|
|
136
|
+
"encodingAESKey": "BOT_AES_SALES",
|
|
137
|
+
"receiveId": ""
|
|
138
|
+
},
|
|
139
|
+
"agent": {
|
|
140
|
+
"corpId": "CORP_ID",
|
|
141
|
+
"corpSecret": "AGENT_SECRET_SALES",
|
|
142
|
+
"agentId": 1000002,
|
|
143
|
+
"token": "AGENT_TOKEN_SALES",
|
|
144
|
+
"encodingAESKey": "AGENT_AES_SALES"
|
|
145
|
+
}
|
|
146
|
+
}'
|
|
147
|
+
|
|
148
|
+
# 4) 绑定到不同 OpenClaw agent(按你的实际 agentId 修改)
|
|
149
|
+
openclaw config set bindings '[{"agentId":"ops-agent","match":{"channel":"wecom","accountId":"ops"}},{"agentId":"sales-agent","match":{"channel":"wecom","accountId":"sales"}}]'
|
|
150
|
+
|
|
151
|
+
# 5) 验证配置
|
|
152
|
+
openclaw config get channels.wecom
|
|
153
|
+
openclaw channels status
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
Webhook 回调建议按账号分别配置:
|
|
157
|
+
- Bot(推荐):`/plugins/wecom/bot/{accountId}`
|
|
158
|
+
- Agent(推荐):`/plugins/wecom/agent/{accountId}`
|
|
159
|
+
|
|
160
|
+
> 提示:如果你已有 `bindings`,请先备份并按需合并,避免覆盖其它通道绑定。
|
|
161
|
+
|
|
162
|
+
### 1.3 高级网络配置(公网出口代理)
|
|
163
|
+
如果您的服务器使用 **动态 IP** (如家庭宽带、内网穿透) 或 **无公网 IP**,企业微信 API 会因 IP 变动报错 `60020 not allow to access from your ip`。
|
|
164
|
+
此时需配置一个**固定 IP 的正向代理** (如 Squid),让插件通过该代理访问企微 API。
|
|
165
|
+
|
|
166
|
+
```bash
|
|
167
|
+
openclaw config set channels.wecom.network.egressProxyUrl "http://proxy.company.local:3128"
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### 1.4 验证
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
openclaw config set gateway.bind lan
|
|
174
|
+
openclaw gateway restart
|
|
175
|
+
openclaw channels status
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
<a id="sec-4"></a>
|
|
181
|
+
|
|
182
|
+
## 二、⚙️ 配置说明
|
|
183
|
+
|
|
184
|
+
### 2.1 推荐配置结构(多账号 + 多 Agent)
|
|
185
|
+
|
|
186
|
+
一个 `accountId` 就是一组独立通道:
|
|
187
|
+
- 一组 `bot`(群聊/流式主通道)
|
|
188
|
+
- 一组 `agent`(文件/超时/主动消息兜底)
|
|
189
|
+
- 一组路由绑定(只进同组 Agent,不跨账号)
|
|
190
|
+
|
|
191
|
+
```jsonc
|
|
192
|
+
{
|
|
193
|
+
"channels": {
|
|
194
|
+
"wecom": {
|
|
195
|
+
"enabled": true, // 通道总开关
|
|
196
|
+
"defaultAccount": "ops", // 未显式指定 accountId 时使用
|
|
197
|
+
|
|
198
|
+
// 通道级全局配置(当前不是 per-account)
|
|
199
|
+
"media": {
|
|
200
|
+
"tempDir": "/tmp/openclaw-wecom-media",
|
|
201
|
+
"retentionHours": 24,
|
|
202
|
+
"cleanupOnStart": true,
|
|
203
|
+
"maxBytes": 26214400
|
|
204
|
+
},
|
|
205
|
+
"network": {
|
|
206
|
+
"timeoutMs": 15000,
|
|
207
|
+
"retries": 2,
|
|
208
|
+
"retryDelayMs": 500,
|
|
209
|
+
"egressProxyUrl": "http://proxy.company.local:3128"
|
|
210
|
+
},
|
|
211
|
+
"dynamicAgents": {
|
|
212
|
+
"enabled": true,
|
|
213
|
+
"dmCreateAgent": true,
|
|
214
|
+
"groupEnabled": false,
|
|
215
|
+
"adminUsers": ["zhangsan"]
|
|
216
|
+
},
|
|
217
|
+
|
|
218
|
+
"accounts": {
|
|
219
|
+
"ops": {
|
|
220
|
+
"enabled": true,
|
|
221
|
+
"name": "运维机器人",
|
|
222
|
+
"bot": {
|
|
223
|
+
"aibotid": "BOT_OPS",
|
|
224
|
+
"token": "BOT_TOKEN_OPS",
|
|
225
|
+
"encodingAESKey": "BOT_AES_OPS",
|
|
226
|
+
"botIds": ["BOT_OPS", "BOT_OPS_BAK"],
|
|
227
|
+
"receiveId": "",
|
|
228
|
+
"streamPlaceholderContent": "正在思考...",
|
|
229
|
+
"welcomeText": "你好,我是运维助手",
|
|
230
|
+
"dm": {
|
|
231
|
+
"policy": "allowlist",
|
|
232
|
+
"allowFrom": ["zhangsan", "lisi"]
|
|
233
|
+
}
|
|
234
|
+
},
|
|
235
|
+
"agent": {
|
|
236
|
+
"corpId": "CORP_ID",
|
|
237
|
+
"corpSecret": "AGENT_SECRET_OPS",
|
|
238
|
+
"agentId": 1000001,
|
|
239
|
+
"token": "AGENT_TOKEN_OPS",
|
|
240
|
+
"encodingAESKey": "AGENT_AES_OPS",
|
|
241
|
+
"welcomeText": "欢迎联系运维助手",
|
|
242
|
+
"dm": {
|
|
243
|
+
"policy": "open",
|
|
244
|
+
"allowFrom": ["*"]
|
|
245
|
+
}
|
|
246
|
+
}
|
|
247
|
+
},
|
|
248
|
+
"sales": {
|
|
249
|
+
"enabled": true,
|
|
250
|
+
"name": "销售机器人",
|
|
251
|
+
"bot": {
|
|
252
|
+
"aibotid": "BOT_SALES",
|
|
253
|
+
"token": "BOT_TOKEN_SALES",
|
|
254
|
+
"encodingAESKey": "BOT_AES_SALES",
|
|
255
|
+
"receiveId": "",
|
|
256
|
+
"streamPlaceholderContent": "正在整理销售建议...",
|
|
257
|
+
"welcomeText": "你好,我是销售助手",
|
|
258
|
+
"dm": {
|
|
259
|
+
"policy": "pairing"
|
|
260
|
+
}
|
|
261
|
+
},
|
|
262
|
+
"agent": {
|
|
263
|
+
"corpId": "CORP_ID",
|
|
264
|
+
"corpSecret": "AGENT_SECRET_SALES",
|
|
265
|
+
"agentId": 1000002,
|
|
266
|
+
"token": "AGENT_TOKEN_SALES",
|
|
267
|
+
"encodingAESKey": "AGENT_AES_SALES",
|
|
268
|
+
"welcomeText": "欢迎咨询销售问题",
|
|
269
|
+
"dm": {
|
|
270
|
+
"policy": "pairing"
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
}
|
|
276
|
+
},
|
|
277
|
+
"bindings": [
|
|
278
|
+
{ "agentId": "ops-agent", "match": { "channel": "wecom", "accountId": "ops" } },
|
|
279
|
+
{ "agentId": "sales-agent", "match": { "channel": "wecom", "accountId": "sales" } }
|
|
280
|
+
]
|
|
281
|
+
}
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### 2.2 路由第一性原则
|
|
285
|
+
|
|
286
|
+
- `accountId` 是会话隔离边界:不同账号不共享会话、不共享动态 Agent。
|
|
287
|
+
- Bot 无法交付时,只回退到**同组** Agent,不跨账号兜底。
|
|
288
|
+
- 只有在未显式指定 `accountId` 时,才使用 `defaultAccount`。
|
|
289
|
+
|
|
290
|
+
### 2.3 Webhook 路径(必须使用账号路径)
|
|
291
|
+
|
|
292
|
+
| 模式 | 路径 | 说明 |
|
|
293
|
+
|:---|:---|:---|
|
|
294
|
+
| Bot(推荐,多账号) | `/plugins/wecom/bot/{accountId}` | 指定账号回调(例如 `/plugins/wecom/bot/default`) |
|
|
295
|
+
| Agent(推荐,多账号) | `/plugins/wecom/agent/{accountId}` | 指定账号回调(例如 `/plugins/wecom/agent/default`) |
|
|
296
|
+
|
|
297
|
+
### 2.4 从单账号迁移到多账号(4 步)
|
|
298
|
+
|
|
299
|
+
1. 把原来的 `channels.wecom.bot` / `channels.wecom.agent` 拆到 `channels.wecom.accounts.default.bot/agent`。
|
|
300
|
+
2. 按业务继续新增 `channels.wecom.accounts.<accountId>`(例如 `ops`、`sales`)。
|
|
301
|
+
3. 为每个账号增加 `bindings[].match.accountId`,映射到对应 OpenClaw agent。
|
|
302
|
+
4. 企业微信后台把回调 URL 改成账号路径:`/plugins/wecom/bot/{accountId}`、`/plugins/wecom/agent/{accountId}`,然后执行 `openclaw channels status` 验证。
|
|
303
|
+
|
|
304
|
+
### 2.5 DM 策略
|
|
305
|
+
|
|
306
|
+
- **不配置 `dm.allowFrom`** → 所有人可用(默认)
|
|
307
|
+
- **配置 `dm.allowFrom: ["user1", "user2"]`** → 白名单模式,仅列表内用户可私聊
|
|
308
|
+
|
|
309
|
+
### 2.6 常用指令
|
|
310
|
+
|
|
311
|
+
| 指令 | 说明 | 示例 |
|
|
312
|
+
|:---|:---|:---|
|
|
313
|
+
| `/new` | 🆕 开启新会话 (重置上下文) | `/new` 或 `/new GPT-4` |
|
|
314
|
+
| `/reset` | 🔄 重置会话 (同 /new) | `/reset` |
|
|
315
|
+
|
|
316
|
+
---
|
|
317
|
+
|
|
318
|
+
<a id="sec-5"></a>
|
|
319
|
+
|
|
320
|
+
## 三、🏢 企业微信接入指南
|
|
321
|
+
|
|
322
|
+
### 3.1 Bot 模式(智能机器人)
|
|
323
|
+
|
|
324
|
+
1. 登录 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#/manageTools)
|
|
325
|
+
2. 进入「安全与管理」→「管理工具」→「智能机器人」
|
|
326
|
+
3. 创建机器人,选择 **API 模式**
|
|
327
|
+
4. 填写回调 URL:`https://your-domain.com/plugins/wecom/bot/{accountId}`(例如默认账号:`https://your-domain.com/plugins/wecom/bot/default`)
|
|
328
|
+
5. 记录 Token 和 EncodingAESKey
|
|
329
|
+
|
|
330
|
+
### 3.2 Agent 模式(自建应用)
|
|
331
|
+
|
|
332
|
+
1. 登录 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#/apps)
|
|
333
|
+
2. 进入「应用管理」→「自建」→ 创建应用
|
|
334
|
+
3. 获取 AgentId、CorpId、Secret
|
|
335
|
+
4. **重要:** 进入「企业可信IP」→「配置」→ 添加你服务器的 IP 地址
|
|
336
|
+
- 如果你使用内网穿透/动态 IP,建议配置 `channels.wecom.network.egressProxyUrl` 走固定出口代理,否则可能出现:`60020 not allow to access from your ip`
|
|
337
|
+
5. 在应用详情中设置「接收消息 - 设置API接收」
|
|
338
|
+
6. 填写回调 URL:`https://your-domain.com/plugins/wecom/agent/{accountId}`(例如默认账号:`https://your-domain.com/plugins/wecom/agent/default`)
|
|
339
|
+
7. 记录回调 Token 和 EncodingAESKey
|
|
340
|
+
|
|
341
|
+
<div align="center">
|
|
342
|
+
<img src="https://cdn.jsdelivr.net/npm/@mocrane/wecom@latest/assets/03.bot.page.png" width="45%" alt="Bot Config" />
|
|
343
|
+
<img src="https://cdn.jsdelivr.net/npm/@mocrane/wecom@latest/assets/03.agent.page.png" width="45%" alt="Agent Config" />
|
|
344
|
+
</div>
|
|
345
|
+
|
|
346
|
+
---
|
|
347
|
+
|
|
348
|
+
<a id="sec-6"></a>
|
|
349
|
+
|
|
350
|
+
## 四、✨ 高级功能
|
|
351
|
+
|
|
352
|
+
### 4.1 A2UI 交互卡片
|
|
353
|
+
|
|
354
|
+
Agent 输出 `{"template_card": ...}` 时自动渲染为交互卡片:
|
|
355
|
+
|
|
356
|
+
- ✅ 单聊场景:发送真实交互卡片
|
|
357
|
+
- ✅ 按钮点击:触发 `template_card_event` 回调
|
|
358
|
+
- ✅ 自动去重:基于 `msgid` 避免重复处理
|
|
359
|
+
- ⚠️ 群聊降级:自动转为文本描述
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
### 4.2 ⏰ Cronjob 企业级定时推送
|
|
364
|
+
|
|
365
|
+
本插件深度集成了 OpenClaw 的 Cronjob 调度能力,配合 Agent 强大的广播 API,轻松实现企业级通知服务。
|
|
366
|
+
|
|
367
|
+
> **核心场景**:早报推送、服务器报警、日报提醒、节日祝福。
|
|
368
|
+
|
|
369
|
+
#### 4.2.1 目标配置 (Target)
|
|
370
|
+
无需遍历用户列表,直接利用 Agent 强大的组织架构触达能力:
|
|
371
|
+
|
|
372
|
+
| 目标类型 | 格式示例 | 推送范围 | 典型场景 |
|
|
373
|
+
|:---|:---|:---|:---|
|
|
374
|
+
| **部门 (Party)** | `party:1` (或 `1`) | 📢 **全员广播** | 全员通知、技术部周报 |
|
|
375
|
+
| **标签 (Tag)** | `tag:Ops` | 🎯 **精准分组** | 运维报警、管理层汇报 |
|
|
376
|
+
| **外部群 (Group)** | `group:wr...` | 💬 **群聊推送** | 项目组群日报 (需由Agent建群) |
|
|
377
|
+
| **用户 (User)** | `user:zhangsan` | 👤 **即时私信** | 个人待办提醒 |
|
|
378
|
+
|
|
379
|
+
#### 4.2.2 配置示例 (`schedule.json`)
|
|
380
|
+
|
|
381
|
+
只需在工作区根目录创建 `schedule.json` 即可生效:
|
|
382
|
+
|
|
383
|
+
```json
|
|
384
|
+
{
|
|
385
|
+
"tasks": [
|
|
386
|
+
{
|
|
387
|
+
"cron": "0 9 * * 1-5", // 每周一至周五 早上9:00
|
|
388
|
+
"action": "reply.send",
|
|
389
|
+
"params": {
|
|
390
|
+
"channel": "wecom",
|
|
391
|
+
"to": "party:1", // 一键发送给根部门所有人!
|
|
392
|
+
"text": "🌞 早安!请查收[今日行业简报](https://example.com/daily)。"
|
|
393
|
+
}
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
"cron": "0 18 * * 5",
|
|
397
|
+
"action": "reply.send",
|
|
398
|
+
"params": {
|
|
399
|
+
"channel": "wecom",
|
|
400
|
+
"to": "tag:Ops", // 仅发送给运维组
|
|
401
|
+
"text": "🔒 周五封网提醒:请检查服务器状态。"
|
|
402
|
+
}
|
|
403
|
+
}
|
|
404
|
+
]
|
|
405
|
+
}
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
---
|
|
411
|
+
|
|
412
|
+
<a id="sec-7"></a>
|
|
413
|
+
|
|
414
|
+
## 五、📖 详细行为说明 (Behavior Detail)
|
|
415
|
+
|
|
416
|
+
### 5.1 企业微信群聊交付规则
|
|
417
|
+
|
|
418
|
+
* **默认 (Bot 回复)**:群聊里 @Bot,默认由 Bot 在群内直接回复(优先文本/图片/Markdown)。
|
|
419
|
+
* **例外 (文件兜底)**:如果回复内容包含**非图片文件**(如 PDF/Word/表格/压缩包等),由于企微 Bot 接口不支持,插件会自动:
|
|
420
|
+
1. Bot 在群里提示:"由于格式限制,文件将通过私信发送给您"。
|
|
421
|
+
2. 无缝切换到 **自建应用 (Agent)** 通道,将文件私信发送给触发者。
|
|
422
|
+
* **提示**:若未配置 Agent,Bot 会明确提示“需要管理员配置自建应用通道”。
|
|
423
|
+
|
|
424
|
+
### 5.2 长任务可靠性保障
|
|
425
|
+
|
|
426
|
+
* **超时熔断**:企业微信限制 Bot 流式回复窗口约为 6 分钟。
|
|
427
|
+
* **自动接力**:当对话时长接近此阈值时,Monitor 会自动截断 Bot 流,提示 "剩余内容将私信发送",并立即启动 Agent 通道私信发送完整结果。这彻底解决了长思考任务(如深度推理、代码生成)因超时导致用户收不到结果的问题。
|
|
428
|
+
|
|
429
|
+
### 5.3 主动发送安全机制
|
|
430
|
+
|
|
431
|
+
* **群发保护**:Agent 主动发送接口不再尝试向普通群 `chatid` (wr/wc...) 发消息(该路径常因权限与归属产生的隐蔽错误)。
|
|
432
|
+
* **引导提示**:系统会明确拦截并通过日志提示中文错误:"请使用 Bot 群内交付或改为私信目标(userid/部门/标签)",帮助管理员快速排查配置。
|
|
433
|
+
|
|
434
|
+
### 5.4 管理员友好
|
|
435
|
+
|
|
436
|
+
* 所有兜底逻辑(Fallback)触发时,如果因配置缺失导致失败,Bot 都会给出清晰的**中文提示**,而不是沉默或报代码错误,极大降低了排查难度。
|
|
437
|
+
|
|
438
|
+
---
|
|
439
|
+
|
|
440
|
+
<a id="sec-8"></a>
|
|
441
|
+
|
|
442
|
+
## 六、🙋 社区问答 (FAQ)
|
|
443
|
+
|
|
444
|
+
针对社区反馈的高频问题,我们已在 v2.2.4 版本中全部解决:
|
|
445
|
+
|
|
446
|
+
**Q1: 同时使用 Bot 和 Agent 会导致消息重复吗?**
|
|
447
|
+
|
|
448
|
+
> **A:** 不会。本插件采用“Bot 优先”策略。用户在哪个通道发消息,就从哪个通道回。只有在 Bot 无法处理(如发文件)时才会智能切换到 Agent 通道作为补充。
|
|
449
|
+
|
|
450
|
+
**Q2: 使用内网穿透时,企业微信报错 60020 (IP 不白名单) 怎么办?**
|
|
451
|
+
|
|
452
|
+
> **A:** 新增了 `config.network.egressProxyUrl` 配置。您可以配置一个拥有固定公网 IP 的代理服务器(如 Squid),让插件通过该代理与企微 API 通信,从而绕过动态 IP 限制。
|
|
453
|
+
|
|
454
|
+
**Q3: 原生 Bot 模式支持图片,为什么 Agent 模式不行?**
|
|
455
|
+
|
|
456
|
+
> **A:** Agent 模式之前确实存在此短板。但在 v2.2.4 中,我们完整实现了 Agent 端的 XML 媒体解析与 `media_id` 下载逻辑,现在 Agent 模式也能完美看图、听语音了。
|
|
457
|
+
|
|
458
|
+
**Q4: 群里 @机器人 发送文件失败?**
|
|
459
|
+
|
|
460
|
+
> **A:** 因为企业微信 Bot 接口本身不支持发送非图片文件。我们的解决方案是:自动检测到文件发送需求后,改为通过 Agent 私信该用户发送文件,并在群里给出 "文件已私信发给您" 的提示。
|
|
461
|
+
|
|
462
|
+
**Q5: 为什么在 Agent 模式下发送文件(如 PDF、Word)给机器人没有反应?**
|
|
463
|
+
|
|
464
|
+
> **A:** 这是由于企业微信官方接口限制。自建应用(Agent)的消息回调接口仅支持:文本、图片、语音、视频、位置和链接信息。**不支持**通用文件(File)类型的回调,因此插件无法感知您发送的文件。
|
|
465
|
+
|
|
466
|
+
**Q6: Cronjob 定时任务怎么发给群?**
|
|
467
|
+
|
|
468
|
+
> **A:** Cronjob 必须走 Agent 通道(Bot 无法主动发消息)。您只需在配置中指定 `to: "party:1"` (部门) 或 `to: "group:wr123..."` (外部群),即可实现定时推送到群。
|
|
469
|
+
|
|
470
|
+
**Q7: 为什么发视频给 Bot 没反应?**
|
|
471
|
+
|
|
472
|
+
> **A:** 官方 Bot 接口**不支持接收视频**。如果您需要处理视频内容,请配置并使用 Agent 模式(Agent 支持接收视频)。
|
|
473
|
+
|
|
474
|
+
---
|
|
475
|
+
|
|
476
|
+
<a id="sec-9"></a>
|
|
477
|
+
|
|
478
|
+
## 七、📮 联系我
|
|
479
|
+
|
|
480
|
+
微信交流群(扫码入群):
|
|
481
|
+
|
|
482
|
+

|
|
483
|
+
|
|
484
|
+
维护者:mocrane
|
|
485
|
+
|
|
486
|
+
---
|
|
487
|
+
|
|
488
|
+
<a id="sec-legal"></a>
|
|
489
|
+
|
|
490
|
+
## ⚖️ 授权与原创声明
|
|
491
|
+
|
|
492
|
+
本项目采用 **ISC License** 开源协议,并在此强调以下要求:
|
|
493
|
+
|
|
494
|
+
1. **保留署名**:根据 ISC 协议,您在任何分发、修改或使用本项目(或其部分逻辑)时,**必须**在显著位置完整保留本项目的版权声明(Copyright Notice)。
|
|
495
|
+
2. **尊重原创**:本项目包含的“Bot/Agent 自动化互补架构”、“长对话超时接力”、“WeCom 全媒体流自动化处理”等核心逻辑均为作者 **YanHaidao** 独立思考与实践的原创成果。
|
|
496
|
+
3. **维权申明**:对于恶意删除署名、像素级抄袭、混淆视听的恶意搬运行为,作者保留在社区公示及通过法律途径维权的权利。
|
|
497
|
+
|
|
498
|
+
---
|
|
499
|
+
|
|
500
|
+
<a id="sec-10"></a>
|
|
501
|
+
## 八、📝 更新日志
|
|
502
|
+
|
|
503
|
+
### 2026.3.3(今日更新简报)
|
|
504
|
+
|
|
505
|
+
- 【SDK适配】♻️ **插件 HTTP 注册升级**:入口改为 `registerHttpRoute`(`/plugins/wecom` + `match=prefix` + `auth=plugin`),适配 OpenClaw 新版插件接口。
|
|
506
|
+
- 【兼容修复】🔁 **旧入口保持可达**:同步注册 `/wecom` 前缀路由,保障历史 Bot/Agent 回调地址继续可用。
|
|
507
|
+
- 【兼容性修复】🧩 **OpenClaw 3.1 路由抢占问题修复**:推荐回调地址升级为 `/plugins/wecom/bot/{accountId}`、`/plugins/wecom/agent/{accountId}`,规避根路径 Control UI fallback 抢占 webhook。
|
|
508
|
+
- 【引导收敛】🧭 **Onboarding 仅支持账号化配置**:配置向导统一写入 `channels.wecom.accounts.<accountId>`,不再引导单账号旧结构。
|
|
509
|
+
- 【兼容策略】🔁 **旧路径兼容保留**:`/wecom/*` 历史回调路径保留兼容能力,但不再作为维护主路径。
|
|
510
|
+
- 【分流稳定性】🧭 **路由识别增强**:monitor 按插件命名空间账号路径识别,确保 Bot/Agent 分支稳定命中。
|
|
511
|
+
- 【链路一致性】🔒 **Bot 回复不再误走 Agent**:修复 Bot 上下文通道标识,避免 `routeReply` 误触发到 outbound 主动发送链路。
|
|
512
|
+
- 【验证结果】✅ WeCom 插件测试通过:`10` files / `41` tests。
|
|
513
|
+
|
|
514
|
+
### 2026.3.2(版本更新简报)
|
|
515
|
+
|
|
516
|
+
- 【交付收口】🔄 修复 Bot 会话“正在搜索相关内容”不结束的问题,并在可用时推送最终流帧结束状态。
|
|
517
|
+
- 【媒体兜底】📎 统一非图片文件、媒体失败和超时场景为“Bot 提示 + Agent 私信兜底”闭环,确保结果可达。
|
|
518
|
+
- 【类型兼容】🧠 扩展 `txt/docx/xlsx/pptx/csv/zip` 等常见文件类型识别,并保留 `application/octet-stream` 自动重试。
|
|
519
|
+
- 【工具治理】🛡 修复 Bot 会话 `message` 工具禁用策略,避免绕过 Bot 交付链路导致会话错位。
|
|
520
|
+
|
|
521
|
+
### 2026.2.28
|
|
522
|
+
|
|
523
|
+
- 【重磅更新】🎯 **多账号/多智能体可用性增强**:支持按 `accountId` 做组内隔离(Bot + Agent + 路由绑定同组生效),动态 Agent 与会话键增加 `accountId` 维度,避免跨账号串会话。
|
|
524
|
+
- 【稳定性】🔁 **生命周期兼容修复**:适配新版 OpenClaw Gateway 生命周期,`startAccount` 改为长生命周期运行,修复“几秒一次重启 + health-monitor 二次重启”的循环问题。
|
|
525
|
+
- 【准确性】🔐 **XML 字段保真修复**:Agent XML 解析关闭自动数值化,保留 `FromUserName` 前导 `0`,并避免 `MsgId`(64 位)精度风险,确保会话与回复目标不被误改。
|
|
526
|
+
- 【准确性】🧹 **误回复修复**:Bot/Agent 入站都增加事件过滤,`event`、`sys`、缺失发送者(以及群聊缺失 `chatid`)不再进入 AI 会话,避免“一个消息触发多人误回复”。
|
|
527
|
+
- 【可控性】🧱 **配置安全护栏**:新增多账号冲突检测,自动拦截重复 `bot.token`、重复 `bot.aibotid`、重复 `agent(corpId+agentId)` 的配置并给出明确错误提示。
|
|
528
|
+
- 【可控性】🛠 **账号管理修复**:`deleteAccount` 改为仅删除目标账号,不再误删整个 `channels.wecom`。
|
|
529
|
+
- 【易用性】📘 **文档默认路径调整**:README 快速开始与配置说明改为优先展示“多账号 + 多 Agent”矩阵配置;单账号模式保留为兼容方案。
|
|
530
|
+
- 【质量保障】✅ **回归保护**:新增账号解析、冲突检测、动态路由隔离、生命周期与入站过滤测试。
|
|
531
|
+
|
|
532
|
+
### 2026.2.7
|
|
533
|
+
|
|
534
|
+
- ✨ **动态 Agent 路由**:新增按用户/群组隔离的动态路由功能,支持为每个对话主体自动分配独立的 Agent 实例(如 `wecom-dm-xxx`)。
|
|
535
|
+
- 🛠 **自动注册机制**:动态生成的 Agent 会自动异步注册到 `agents.list` 配置中,实现多租户 Agent 的无感扩容与管理。
|
|
536
|
+
- 🛡 **权限与兼容性**:支持 `adminUsers` 白名单绕过机制以使用主 Agent;功能默认关闭,确保对现有配置完全兼容。
|
|
537
|
+
- ⚙️ **精细化配置**:新增 `channels.wecom.dynamicAgents` 配置项,可独立控制私聊和群聊的动态路由行为。
|
|
538
|
+
- 🙏 **特别致谢**:感谢 [WhyMeta](https://github.com/WhyMeta) 开发者对动态路由实施方案的贡献。
|
|
539
|
+
|
|
540
|
+
### 2026.2.5
|
|
541
|
+
|
|
542
|
+
- 🛠 **体验优化**:WeCom 媒体(图片/语音/视频/文件)处理的默认大小上限提升到 25MB,减少大文件因超限导致的“下载/保存失败”。
|
|
543
|
+
- 📌 **可配置提示**:若仍遇到 Media exceeds ... limit,日志/回复会提示通过 channels.wecom.media.maxBytes 调整上限,并给出可直接执行的 openclaw config set 示例命令。
|
|
544
|
+
|
|
545
|
+
### 2026.2.4
|
|
546
|
+
|
|
547
|
+
- 🚀 **架构升级**:实施 "Bot 优先 + Agent 兜底" 策略,兼顾流式体验与长任务稳定性(6分钟切换)。
|
|
548
|
+
- ✨ **全模态支持**:Agent 模式完整支持接收图片/语音/视频(文件仅支持发送)。
|
|
549
|
+
- ✨ **Cronjob 增强**:支持向部门 (`party:ID`) 和标签 (`tag:ID`) 广播消息。
|
|
550
|
+
- 🛠 **Monitor 重构**:统一的消息防抖与流状态管理,提升并发稳定性。
|
|
551
|
+
- 🛠 **体验优化**:修复企微重试导致的重复回复(Bot/Agent 均做 `msgid` 去重);优化 Bot 连续多条消息的排队/合并回执,避免“重复同一答案”或“消息失败提示”。
|
|
552
|
+
- 🐞 **修复**:Outbound ID 解析逻辑及 API 客户端参数缺失问题。
|
|
553
|
+
|
|
554
|
+
### 2026.2.3
|
|
555
|
+
|
|
556
|
+
- 🎉 **重大更新**:新增 Agent 模式(自建应用)支持
|
|
557
|
+
- ✨ 双模式并行:Bot + Agent 可同时运行
|
|
558
|
+
- ✨ **多模态支持**:Agent 模式支持图片/语音/文件/视频的接收与自动下载
|
|
559
|
+
- ✨ AccessToken 自动管理:缓存 + 智能刷新
|
|
560
|
+
- ✨ Agent 主动推送:脱离回调限制
|
|
561
|
+
- ✨ XML 加解密:完整 Agent 回调支持
|
|
562
|
+
- 📁 代码重构:模块化解耦设计
|
|
563
|
+
|
|
564
|
+
### 2026.1.31
|
|
565
|
+
|
|
566
|
+
- 文档:补充入模与测试截图说明
|
|
567
|
+
- 新增文件支持
|
|
568
|
+
- 新增卡片支持
|
|
569
|
+
|
|
570
|
+
### 2026.1.30
|
|
571
|
+
|
|
572
|
+
- 项目更名:Clawdbot → OpenClaw
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|