| 1 | # WeCom (企业微信) Bridge |
| 2 | |
| 3 | 此 bridge 让**企业微信**用户通过智能机器人长连接控制本地 `codewhale serve --http` runtime。 |
| 4 | 使用企业微信智能机器人 API（长连接/WebSocket 模式），无需公网 IP。 |
| 5 | |
| 6 | 与 `integrations/weixin-bridge`（个人微信 iLink Bot 协议）不同，此 bridge 面向企业微信组织内部使用， |
| 7 | 通过 BotID + Secret 认证，支持企业通讯录权限管理。 |
| 8 | |
| 9 | ## 安全模型 |
| 10 | |
| 11 | - `codewhale serve --http` 绑定于 `127.0.0.1`。 |
| 12 | - `/v1/*` runtime 调用使用 `CODEWHALE_RUNTIME_TOKEN`。 |
| 13 | - 企业微信用户必须加入白名单（`WECOM_CHAT_ALLOWLIST`），除非首次配对时设置 `WECOM_ALLOW_UNLISTED=true`。 |
| 14 | - 支持私聊和群聊（群聊需要前缀 `/cw`）。 |
| 15 | - 工具审批通过文本命令：`/allow <approval_id>` 或 `/deny <approval_id>`。 |
| 16 | - 长连接模式无需公网端口。 |
| 17 | - 企业微信只会看到 bridge 发送的提示、状态、线程摘要和审批消息；工作区、shell 和 runtime HTTP |
| 18 | 监听仍留在本机，并由 `CODEWHALE_RUNTIME_TOKEN` 保护。 |
| 19 | |
| 20 | ## 前提 |
| 21 | |
| 22 | 1. 拥有企业微信管理员权限 |
| 23 | 2. 在企业微信管理后台创建一个**智能机器人**（工作台 → 智能机器人 → 创建机器人） |
| 24 | 3. 选择 **API 模式**，获取 BotID 和 Secret |
| 25 | 4. （可选）配置机器人接收消息的格式 |
| 26 | |
| 27 | ## 设置 |
| 28 | |
| 29 | ```bash |
| 30 | cd /opt/codewhale/wecom-bridge |
| 31 | npm install --omit=dev |
| 32 | cp .env.example /etc/codewhale/wecom-bridge.env |
| 33 | sudoedit /etc/codewhale/wecom-bridge.env |
| 34 | node src/index.mjs |
| 35 | ``` |
| 36 | |
| 37 | 启动后 bridge 会自动建立 WebSocket 长连接，无需额外配置。 |
| 38 | |
| 39 | ## 命令 |
| 40 | |
| 41 | | 命令 | 说明 | |
| 42 | |------|------| |
| 43 | | `/help` | 显示帮助 | |
| 44 | | `/status` | runtime 和工作区状态 | |
| 45 | | `/threads` | 最近的 runtime 线程 | |
| 46 | | `/new` | 为此聊天创建新线程 | |
| 47 | | `/resume <thread_id>` | 绑定到此聊天的现有线程 | |
| 48 | | `/model <name\|default>` | 设置或重置聊天模型 | |
| 49 | | `/interrupt` | 中断活动 turn | |
| 50 | | `/compact` | 压缩当前线程 | |
| 51 | | `/allow <approval_id> [remember]` | 批准待处理的工具调用 | |
| 52 | | `/deny <approval_id>` | 拒绝待处理的工具调用 | |
| 53 | |
| 54 | 其他所有内容均作为 Codewhale 提示发送。群聊中需要在消息前加 `/cw` 前缀。 |
| 55 | |
| 56 | ## 首次配对 |
| 57 | |
| 58 | 1. 设置 `WECOM_ALLOW_UNLISTED=true` 启动 bridge。 |
| 59 | 2. 在企业微信中向机器人发送 `/status`。 |
| 60 | 3. Bridge 会拒绝并返回你的 `user_id`（或 `chat_id`）。 |
| 61 | 4. 将 `user_id` 加入 `WECOM_CHAT_ALLOWLIST`。 |
| 62 | 5. 将 `WECOM_ALLOW_UNLISTED` 改回 `false` 并重启 bridge。 |
| 63 | |
| 64 | ## 环境变量 |
| 65 | |
| 66 | | 变量 | 必填 | 说明 | |
| 67 | |------|------|------| |
| 68 | | `CODEWHALE_RUNTIME_URL` | 否 | Runtime HTTP 地址（默认 `http://127.0.0.1:7878`） | |
| 69 | | `CODEWHALE_RUNTIME_TOKEN` | **是** | Runtime Bearer 令牌 | |
| 70 | | `CODEWHALE_WORKSPACE` | 否 | 工作区路径（默认 cwd） | |
| 71 | | `CODEWHALE_MODEL` | 否 | 模型名称（默认 `auto`） | |
| 72 | | `CODEWHALE_MODE` | 否 | 运行模式（默认 `agent`） | |
| 73 | | `WECOM_BOT_ID` | **是** | 企业微信智能机器人 BotID | |
| 74 | | `WECOM_BOT_SECRET` | **是** | 企业微信智能机器人 Secret | |
| 75 | | `WECOM_CHAT_ALLOWLIST` | 否 | 逗号分隔的允许用户 UserID | |
| 76 | | `WECOM_ALLOW_UNLISTED` | 否 | 首次配对模式（默认 `false`） | |
| 77 | | `WECOM_STATE_DIR` | 否 | 状态持久化目录 | |
| 78 | | `WECOM_THREAD_MAP_PATH` | 否 | 线程映射文件路径 | |
| 79 | | `WECOM_MAX_REPLY_CHARS` | 否 | 单条回复最大字符数（默认 `3500`） | |
| 80 | | `CODEWHALE_TURN_TIMEOUT_MS` | 否 | Turn 超时（默认 `900000`） | |
| 81 | |
| 82 | ## 架构 |
| 83 | |
| 84 | ``` |
| 85 | 企业微信客户端 → 智能机器人长连接(WebSocket) → WeCom Bridge ──HTTP──→ codewhale serve --http |
| 86 | ◀── aibot_respond_msg ◀── (127.0.0.1:7878) |
| 87 | ``` |
| 88 | |
| 89 | Bridge 使用 BotID + Secret 获取 access_token，建立 WebSocket 长连接。 |
| 90 | 接收 `aibot_msg_callback` 事件，通过 `aibot_respond_msg` 命令回复消息。 |
| 91 | 所有消息处理与 Codewhale Runtime API 交互，与 Feishu/Telegram bridge 共享相同逻辑。 |
| 92 | |
| 93 | ## 与 weixin-bridge 的区别 |
| 94 | |
| 95 | | 特性 | weixin-bridge | wecom-bridge | |
| 96 | |------|---------------|--------------| |
| 97 | | 账号类型 | 个人微信 | 企业微信 | |
| 98 | | 登录方式 | 扫码登录 | BotID + Secret | |
| 99 | | 消息协议 | iLink Bot 长轮询 | 智能机器人 WebSocket | |
| 100 | | 认证方式 | 扫码获取 bot_token | API 获取 access_token | |
| 101 | | 组织管理 | 无 | 支持企业通讯录 | |
| 102 | | 公网需求 | 不需要 | 不需要 | |
| 103 |