Appearance
Eyun 企业微信 API 文档
把企业微信的客户、成员与客户群接进你的系统
每个能力一个路径,POST + JSON;接收方向走 Webhook。与微信个人号 API是并列的两条产品线,不是同一套接口。
还没有凭证?开通与支持 →
- 每能力一路径
- POST + JSON,appid 指定实例
- Bearer App Token
- 控制台自助开通,可以先试用
- Webhook
- 事件推送到你的地址
- OpenAPI 3.0
- 可导入 Apifox / Swagger
三步发出第一条消息
每一步都有 curl 和下一步该做什么。
按模块查找能力
名字与左侧菜单一致;参数、响应与错误处理在接口页。
调用模型
http
POST {BASE_URL}/wx-api/api/message/sendText
Authorization: Bearer <你的 App Token>
Content-Type: application/json
{
"appid": "we_xxxxxxxxxxxxxxx",
"conversationId": 1688855874759204,
"content": "你的订单预计明天送达"
}| 组成 | 说明 |
|---|---|
{BASE_URL} | 接入地址在企业微信控制台应用凭证页查看 |
Authorization | Bearer <你的 App Token>,App Token 即应用凭证,决定你能调哪个应用 |
| 路径 | /wx-api/api/<模块>/<动作>,一个能力一个路径;回调配置接口例外:路径是 /wx-api/webhook/<动作>,body 不带 appid |
appid | body 里的实例标识,决定这次调用作用在哪个已登录的企微账号上 |
业务响应是 { "code": 0, "data": …, "detail": "", "message": "ok", "time": "…" }。数字 code=0 表示成功;业务失败为数字 -1,具体企微码在 message 中。鉴权与网关错误的 code 则是字符串,详见错误码。
术语对照:contentType 是消息类型码,接口响应与 Webhook 报文里是同一个;messageType 是会话类型(0 好友 / 1 群聊 / 3 系统通知)。
两个必须知道的约定
- 大整数:
uin、corpId、conversationId、roomId等是 int64,发送时必须是 JSON number,不能传字符串;解析时不要经过浮点数。 - 接口发出的消息不会回推:经接口发送的消息正文不会推给你,只会推一条 2001 已读回执;客户端手动发的消息才推正文。
从这里开始
接入顺序:快速开始 → 认证与凭证 → 实例与代理;接收消息看回调说明,排错看错误码。
机器可读规范:openapi.json(协议版本 2026.09.11),可直接导入 Apifox 或 Swagger。
与微信个人号 API 的关系
两条产品线并列,凭证与实例互不通用。先看你要接的是哪一种账号:
| 对比项 | 微信个人号 API | 企业微信 API |
|---|---|---|
| 接入对象 | 个人微信账号的好友与群 | 企业微信的外部联系人(客户)、客户群与企业成员 |
| 授权方式 | 账号持有人本人扫码 | 企业成员本人扫码,登录时指定代理(省份 / socks5 / aid 三选一) |
| 消息接收 | Webhook 推送 | Webhook 推送;经接口发出的消息不会回推 |
| 在线调试 | 控制台 API Playground | 无 Playground,用 openapi.json 导入 Apifox 或 Swagger |
| 开通方式 | 控制台自助开通,7 天免费试用 | 在企业微信控制台自助开通,可以先试用 |
| 实例标识 | wId | appid |
| 鉴权 | 同为 Authorization: Bearer 请求头;两边凭证不通用 | 同左 |
| 路径前缀 | /… | /wx-api/api/<模块>/… |
| 响应封套 | code 为字符串 "1000" | code 为数字 0 |
已经接过个人号 API 的团队:Webhook 接收与实例管理的骨架可以复用,但会话 id 是 int64、方法名和参数都要按本区文档重写。
部署方式
以上能力可以运行在 Eyun 托管环境,也可以私有化部署在你自己的环境里。见官网的私有化部署方案。