taiyi/baodan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
d0a887d5c2
baodan/WECOM_CONFIG_GUIDE.md

4.3 KiB
Raw Blame History

企业微信配置指南

📋 配置前准备

在配置企业微信之前，你需要：

  1. 注册企业微信账号：访问 https://work.weixin.qq.com/ 注册
  2. 创建自建应用：在管理后台 -> 应用管理 -> 自建 -> 创建应用
  3. 获取配置信息：按照以下步骤获取各项参数

🔑 配置参数说明

1. Corp ID（企业ID）

获取方式：

  1. 登录企业微信管理后台
  2. 进入 我的企业 -> 企业信息
  3. 找到 企业ID（格式：ww 开头的字符串）

示例：ww1234567890abcdef

2. Secret（应用Secret）

获取方式：

  1. 登录企业微信管理后台
  2. 进入 应用管理 -> 自建 -> 选择你的应用
  3. 找到 Secret（点击获取，需要管理员权限）

示例：abcdef1234567890abcdef1234567890

3. Token（回调配置Token）

获取方式：

  1. 在应用配置页面，找到 接收消息 -> 设置API接收
  2. 自定义一个 Token（用于验证回调请求）

示例：my_callback_token_123456

4. AES Key（消息加解密密钥）

获取方式：

  1. 在应用配置页面，找到 接收消息 -> 设置API接收
  2. 点击 随机获取 生成一个 EncodingAESKey

示例：abcdefghijklmnopqrstuvwxyz1234567890ABCDEFG

5. Webhook URL（机器人消息推送）

获取方式：

  1. 在企业微信中添加一个群机器人
  2. 获取机器人的 Webhook URL

示例：https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

🛠️ 配置步骤

方法一：修改 docker-compose.dify.yml（推荐）

编辑 docker-compose.dify.yml 文件，找到以下配置：

# 企微配置（需填入真实值）
WECOM_CORP_ID: ""
WECOM_SECRET: ""
WECOM_TOKEN: ""
WECOM_AES_KEY: ""
WECOM_WEBHOOK_URL: ""

替换为你的真实值：

# 企微配置（已配置）
WECOM_CORP_ID: "ww1234567890abcdef"
WECOM_SECRET: "abcdef1234567890abcdef1234567890"
WECOM_TOKEN: "my_callback_token_123456"
WECOM_AES_KEY: "abcdefghijklmnopqrstuvwxyz1234567890ABCDEFG"
WECOM_WEBHOOK_URL: "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

方法二：使用 .env 文件

  1. 复制 .env.example 为 .env
  2. 编辑 .env 文件，填入企微配置

🔄 应用配置

配置完成后，需要重启服务：

# 重启 API 服务
docker compose -f docker-compose.dify.yml up -d baodan-api

# 重启 Worker 服务（如果需要）
docker compose -f docker-compose.dify.yml up -d baodan-worker

🧪 测试配置

1. 测试登录接口

# 测试企微登录（需要真实企微环境）
curl -X POST http://localhost:5001/insurance/auth/wework-login \
  -H "Content-Type: application/json" \
  -d '{"code": "test_code", "state": ""}'

2. 测试 Webhook

# 测试机器人消息推送
curl -X POST http://localhost:5001/insurance/wecom/webhook/test \
  -H "Content-Type: application/json" \
  -d '{"message": "测试消息"}'

📝 配置示例

完整配置示例

# 企微配置
WECOM_CORP_ID: "ww1234567890abcdef"
WECOM_SECRET: "abcdef1234567890abcdef1234567890"
WECOM_TOKEN: "my_callback_token_123456"
WECOM_AES_KEY: "abcdefghijklmnopqrstuvwxyz1234567890ABCDEFG"
WECOM_WEBHOOK_URL: "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

⚠️ 注意事项

  1. 安全第一：Secret 和 AES Key 是敏感信息，不要提交到 Git
  2. 回调地址：确保企微后台配置的回调地址可访问
  3. 域名配置：生产环境需要配置域名和 HTTPS
  4. 权限申请：部分接口需要在企微后台申请权限

🔍 常见问题

Q1: 登录提示"企业ID无效"

  • 检查 Corp ID 是否正确（ww 开头）
  • 确认企业微信已激活

Q2: 回调验证失败

  • 检查 Token 和 AES Key 是否匹配
  • 确认回调地址可访问

Q3: Webhook 消息发送失败

  • 检查 Webhook URL 是否正确
  • 确认机器人未被移除

📞 获取帮助

如果遇到问题，可以：

  1. 查看后端日志：docker logs baodanagent-baodan-api-1
  2. 检查企微管理后台的配置
  3. 参考企微官方文档：https://work.weixin.qq.com/api/doc