wecomapi · 企业微信 API / 协议网关

官网 · 开发文档 · 控制台

把企业微信的消息、外部群、联系人、朋友圈等能力,通过统一 REST 网关 + Webhook 回调封装成简单接口,接进你自己的业务系统。适合客服、SCRM、AI 助手、自动化通知等场景。

✨ 特性

• 🔌 统一网关 —— 所有能力走一个 POST /api/qw/doApi,用 method 字段区分,鉴权一个 token 头
• 👥 外部群全托管 —— 建群、拉人、改群名/群公告、群二维码、群消息、群事件,一整套可编程
• 📩 实时回调 —— Webhook 推送会话消息与系统事件(成员进出、群变更等)
• 🧩 多账号调度 —— 扫码登录托管,一个企业微信账号 = 一个 guid,统一管理
• 🛠 多场景 —— 客服系统、SCRM、企业微信机器人、AI 客服、客户触达

🚀 快速开始

1. 准备:在控制台扫码登录企业微信账号,拿到 Token 与账号 guid。

2. 发一条群消息(toId 填外部群 ID):

curl -X POST https://<网关地址>/api/qw/doApi \
  -H "Content-Type: application/json" \
  -H "<鉴权Token头>: <你的Token>" \
  -d '{"method":"/msg/sendText","params":{"guid":"<guid>","toId":"<外部群ID>","content":"hello"}}'

3. 接收消息/事件:在控制台给 Token 配回调地址,企业微信侧动态会 POST 过来:

{ "code": 0, "data": [{ "guid": "...", "cmd": 15000, "msgType": 2, "fromRoomId": 0 }] }

cmd:11016 设备状态 · 15000 会话消息 · 15500 系统事件 · 20000 异步回执;回调请 3 秒内回 200 并按 seq 幂等去重。

4. 更多:见 examples/ 与 docs/。

🧩 接口模块概览

模块	前缀	能力
登录托管	/login/*	扫码登录、在线状态(一账号一 guid)
消息	/msg/*	文本/图片/视频/文件/链接/小程序、撤回
外部群	/room/*	建群、改群名/群公告、群二维码、邀请/移除成员、管理员、转让、解散
联系人	/contact/*	列表、详情、加好友、改备注
朋友圈	/sns/*	发布、点赞、评论、可见范围
云存储	/cloud/*	文件上传 / 下载

📚 文档与教程

• 在线接口文档:https://post.wecomapi.com
• 仓库内文档:快速开始 · 接口模块总览 · 外部群 · 消息 · 回调 Webhook

⚠️ 合规提示

本仓库仅作接入说明与示例,请在合法合规前提下,仅用于客户服务、社群运营、企业内部自动化等正当场景,遵守企业微信平台规则与相关法律法规。具体接口、字段与边界以官方文档为准。

📄 License

MIT