跳到主要内容

企业微信回调（自建应用）

将 Hermes 以自建企业应用的形式连接到企业微信（WeCom），使用回调/Webhook 模式。

企业微信机器人 vs 企业微信回调

Hermes 支持两种企业微信集成模式：

  • 企业微信机器人 —— 机器人风格，通过 WebSocket 连接。配置简单，适用于群聊。
  • 企业微信回调（本页）—— 自建应用，接收加密 XML 回调。在用户的企业微信侧边栏中显示为一流应用，支持多企业路由。

工作原理​

  1. 在企业微信管理后台注册自建应用
  2. 企业微信将加密 XML 推送到您的 HTTP 回调端点
  3. Hermes 解密消息，排队交由 Agent 处理
  4. 立即确认（静默 —— 用户不可见）
  5. Agent 处理请求（通常需要 3–30 分钟）
  6. 通过企业微信 message/send API 主动投递回复

前置条件​

  • 具有管理员权限的企业微信企业账号
  • Python 包：aiohttp 和 httpx（默认安装中已包含）
  • 用于回调 URL 的公网可访问服务器（或 ngrok 等隧道工具）

配置步骤​

1. 在企业微信中创建自建应用​

  1. 进入 企业微信管理后台 → 应用管理 → 创建应用
  2. 记录您的 企业 ID（显示在管理后台顶部）
  3. 在应用设置中创建 企业密钥
  4. 记录应用概览页的 AgentID
  5. 在接收消息下，配置回调 URL：
    • URL：http://YOUR_PUBLIC_IP:8645/wecom/callback
    • Token：生成随机 Token（企业微信会提供）
    • EncodingAESKey：生成密钥（企业微信会提供）

2. 配置环境变量​

在 .env 文件中添加：

WECOM_CALLBACK_CORP_ID=your-corp-id
WECOM_CALLBACK_CORP_SECRET=your-corp-secret
WECOM_CALLBACK_AGENT_ID=1000002
WECOM_CALLBACK_TOKEN=your-callback-token
WECOM_CALLBACK_ENCODING_AES_KEY=your-43-char-aes-key

# 可选
WECOM_CALLBACK_HOST=0.0.0.0
WECOM_CALLBACK_PORT=8645
WECOM_CALLBACK_ALLOWED_USERS=user1,user2

3. 启动网关​

hermes gateway

（仅在 hermes gateway install 注册 systemd/launchd 服务后，才使用 hermes gateway start。）

回调适配器在配置的端口启动 HTTP 服务器。企业微信将通过 GET 请求验证回调 URL，然后开始通过 POST 发送消息。

配置参考​

在 config.yaml 的 platforms.wecom_callback.extra 下设置，或使用环境变量：

设置默认值说明
corp_id—企业微信 Corp ID（必填）
corp_secret—自建应用的 Corp Secret（必填）
agent_id—自建应用的 Agent ID（必填）
token—回调验证 Token（必填）
encoding_aes_key—回调加密用的 43 字符 AES 密钥（必填）
host0.0.0.0HTTP 回调服务器绑定地址
port8645HTTP 回调服务器端口
path/wecom/callback回调端点的 URL 路径

多应用路由​

对于运行多个自建应用的企业（例如跨不同部门或子公司），在 config.yaml 中配置 apps 列表：

platforms:
  wecom_callback:
    enabled: true
    extra:
      host: "0.0.0.0"
      port: 8645
      apps:
        - name: "dept-a"
          corp_id: "ww_corp_a"
          corp_secret: "secret-a"
          agent_id: "1000002"
          token: "token-a"
          encoding_aes_key: "key-a-43-chars..."
        - name: "dept-b"
          corp_id: "ww_corp_b"
          corp_secret: "secret-b"
          agent_id: "1000003"
          token: "token-b"
          encoding_aes_key: "key-b-43-chars..."

用户以 corp_id:user_id 为作用域，防止跨企业冲突。用户发送消息时，适配器记录其所属应用（企业），并通过对应应用的 Access Token 路由回复。

访问控制​

限制哪些用户可以与应用交互：

# 指定用户白名单
WECOM_CALLBACK_ALLOWED_USERS=zhangsan,lisi,wangwu

# 或允许所有用户
WECOM_CALLBACK_ALLOW_ALL_USERS=true

端点​

适配器暴露以下端点：

方法路径用途
GET/wecom/callbackURL 验证握手（企业微信在配置时发送）
POST/wecom/callback加密消息回调（企业微信在此发送用户消息）
GET/health健康检查 —— 返回 {"status": "ok"}

加密​

所有回调负载都使用 EncodingAESKey 进行 AES-CBC 加密。适配器处理：

  • 入站：解密 XML 负载，验证 SHA1 签名
  • 出站：回复通过主动 API 发送（非加密回调响应）

加密实现与腾讯官方 WXBizMsgCrypt SDK 兼容。

限制​

  • 无流式输出 —— 回复在 Agent 完成后以完整消息到达
  • 无输入状态指示 —— 回调模式不支持输入状态
  • 仅文本输入 —— 目前仅支持文本消息输入；图片/文件/语音输入尚未实现。Agent 通过企业微信平台提示可以感知出站媒体能力（图片、文档、视频、语音）
  • 响应延迟 —— Agent 会话需要 3–30 分钟；处理完成后用户才能看到回复