Skip to content

Eyun 企业微信 API 文档

把企业微信的客户、成员与客户群接进你的系统

每个能力一个路径,POST + JSON;接收方向走 Webhook。与微信个人号 API是并列的两条产品线,不是同一套接口。

还没有凭证?开通与支持 →

每能力一路径
POST + JSON,appid 指定实例
Bearer App Token
控制台自助开通,可以先试用
Webhook
事件推送到你的地址
OpenAPI 3.0
可导入 Apifox / Swagger

四步完成首次收发

先在控制台保存凭证、扫码并测试收发,再按文档接入自己的代码。

打开企业微信控制台
  1. 01领取 API 凭证领取默认应用完整 App Token 并保存
  2. 02扫码登录本人扫码确认,选择在线实例
  3. 03给自己发消息在手机企微确认收到测试文本
  4. 04接收消息设置 Webhook,测试并接收真实消息

按模块查找能力

名字与左侧菜单一致;参数、响应与错误处理在接口页。

调用模型 ​

http
POST {BASE_URL}/api/message/sendText
Authorization: Bearer <你的 App Token>
Content-Type: application/json

{
  "appid": "we_xxxxxxxxxxxxxxx",
  "conversationId": 1688855874759204,
  "content": "你的订单预计明天送达"
}
组成说明
{BASE_URL}在控制台「文档中心 → 快速开始」复制 API 调用地址,保留末尾 /wx-api;示例直接接 /api/… 或 /webhook/…
AuthorizationBearer <你的 App Token>,App Token 即应用凭证,决定你能调哪个应用
路径/wx-api/api/<模块>/<动作>,一个能力一个路径;回调配置接口例外:路径是 /wx-api/webhook/<动作>,body 不带 appid
appidbody 里的实例标识,决定这次调用作用在哪个已登录的企微账号上

业务响应是 { "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 已读回执;客户端手动发的消息才推正文。

从这里开始 ​

第一次使用,按快速开始在控制台领取凭证、扫码登录并测试收发,再接入自己的代码。

需要试接口,打开在线调试;查参数看API 参考,接收消息看回调说明,调用失败看错误码。凭证、登录网络和常用 ID 的详细说明在左侧「接入说明」中,用到时再查。

机器可读规范:openapi.json(协议版本 2026.09.11),可直接导入 Apifox 或 Swagger。

与微信个人号 API 的关系 ​

两条产品线并列,凭证与实例互不通用。先看你要接的是哪一种账号:

对比项微信个人号 API企业微信 API
接入对象个人微信账号的好友与群企业微信的外部联系人(客户)、客户群与企业成员
授权方式账号持有人本人扫码企业成员本人扫码,登录时指定代理(省份 / socks5 / aid 三选一)
消息接收Webhook 推送Webhook 推送;经接口发出的消息不会回推
在线调试控制台 API Playground在线调试;也可导入 openapi.json
开通方式控制台自助开通,7 天免费试用在企业微信控制台自助开通,可以先试用
实例标识wIdappid
鉴权同为 Authorization: Bearer 请求头;两边凭证不通用同左
路径前缀/…/wx-api/api/<模块>/…
响应封套code 为字符串 "1000"code 为数字 0

已经接过个人号 API 的团队:Webhook 接收与实例管理的骨架可以复用,但会话 id 是 int64、方法名和参数都要按本区文档重写。

部署方式 ​

以上能力可以运行在 Eyun 托管环境,也可以私有化部署在你自己的环境里。见官网的私有化部署方案。