wecom-callback

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

将 Hermes 连接到企业微信作为自建企业应用，使用回调/webhook 模型。

:::info 企业微信机器人 vs 企业微信回调 Hermes 支持两种企业微信集成模式：

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

工作原理

1. 您在企业微信管理后台注册一个自建应用
2. 企业微信向您的 HTTP 回调端点推送加密 XML
3. Hermes 解密消息，将其排队等待代理处理
4. 立即确认（静默——不向用户显示任何内容）
5. 代理处理请求（通常 3–30 分钟）
6. 回复通过企业微信 message/send API 主动投递

前提条件

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

设置

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

1. 前往企业微信管理后台 → 应用管理 → 创建应用
2. 记下您的 企业 ID（显示在管理后台顶部）
3. 在应用设置中，创建一个 企业 Secret
4. 从应用概览页面记下 Agent ID
5. 在 接收消息 下，配置回调 URL：
   • URL：http://YOUR_PUBLIC_IP:8645/wecom/callback
   • 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	—	自建应用的企业 Secret（必填）
agent_id	—	自建应用的 Agent ID（必填）
token	—	回调验证令牌（必填）
encoding_aes_key	—	回调加密的 43 字符 AES 密钥（必填）
host	0.0.0.0	HTTP 回调服务器的绑定地址
port	8645	HTTP 回调服务器的端口
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 限定范围，以防止跨企业冲突。当用户发送消息时，适配器记录他们所属的应用（企业），并通过正确应用的访问令牌路由回复。

访问控制

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

# 白名单特定用户
WECOM_CALLBACK_ALLOWED_USERS=zhangsan,lisi,wangwu
 
# 或允许所有用户
WECOM_CALLBACK_ALLOW_ALL_USERS=true

端点

适配器暴露：

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

加密

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

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

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

限制

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