Skip to content

快速开始 ​

先打开企业微信控制台,按下面四步完成第一次收发。这四步在控制台操作;跑通后再用 curl 调用接口。

1. 领取 API 凭证 ​

激活试用或购买后,在应用凭证页点击「领取 Auth」,复制并保存完整凭证。勾选「我已安全保存这把 Auth」,点击「已保存,扫码登录」。

API 凭证就是控制台里的 Auth,接口文档也称 App Token,这里指同一个值。完整凭证只展示一次。

完成标志:你已保存完整凭证,并进入扫码弹窗。

已有应用,页面只显示掩码怎么办?

使用之前保存的完整 API 凭证,掩码不能用于调用。确实遗失时,才到应用安全设置重置;旧凭证立即失效,自己的服务端也要更新。首次接入不需要重置已有凭证。

2. 扫码登录 ​

在弹窗选择与手机企微常用登录地相同省份的网络,由账号本人扫码并在手机确认。出现验证码等提示时,按弹窗操作;网络选择有疑问时看登录账号与网络设置。

完成标志:控制台显示当前账号「在线」。 已有在线账号可直接进入下一步。

3. 给自己发消息 ​

扫码成功后点击「测试消息收发」,确认页面显示的是刚登录的账号,点击「发送这条消息」。打开手机企微,看到这条测试文本后,点击「我已在微信中看到这条消息」。

完成标志:手机上确实收到测试文本。 只看到接口返回成功还不够;手机未收到时,先核对所选账号,再查看调用日志,不要反复发送。

“发送给谁”为空怎么办?

控制台只有取得当前账号的真实自身 ID,才会自动填入。暂未取得时点击「刷新」后重试;也可以手工填写自己确认过的联系人或群 ID。不要填写文档中的示例 ID。详见常用 ID 说明。

4. 接收消息 ​

Webhook(消息回调)会把企微收到的消息发到你的程序。先按自己的情况选一条路径:

你现在的情况怎么继续
已有能从公网访问的接收服务按下面的步骤填写地址、测试接收
还没有接收程序或公网地址打开本地接收示例,按步骤准备程序和地址、完成测试,再返回本页

已有接收服务:

  1. 填入自己的公网接收地址,点击「保存并启用 Webhook」。这里填你的地址,不是 Eyun 的 API 地址。
  2. 首次创建后,保存页面显示的 Webhook 密钥,填到接收程序中,再勾选「我已保存 Webhook 密钥」。已有配置使用原密钥;它与第 1 步的 API 凭证不同。接收程序须按回调说明校验签名、保存消息后返回成功。
  3. 保持接收程序运行,点击「发送测试投递」。确认控制台显示测试成功,接收程序也已保存测试内容。
  4. 用另一个企微账号,在手机上给当前登录账号发送控制台显示的验证文字。接收程序读到相同文字后,点击「接收端已读到这条真实正文」。

完成标志:你的程序收到真实正文,控制台显示「接入完成」。 测试按钮只检查地址是否可用;用 API 发出的消息也不能代替这一步。

测试卡住时,看回调排查。中途离开后,可从工作台「继续接入」恢复。

调用接口 ​

完成控制台收发测试后,替换以下参数,用 curl 发送一条消息:

参数填写说明
{BASE_URL}在控制台文档中心复制完整 API 地址,保留末尾 /wx-api
<你的 App Token>第 1 步保存的完整 API 凭证
<你的实例 ID>第 2 步登录的实例 appid,在实例详情中复制
conversationId第 3 步验证过的发送目标;给自己发时填当前账号的 uin,可从个人信息接口的 data.uin 获取
bash
curl -X POST "{BASE_URL}/api/message/sendText" \
  -H "Authorization: Bearer <你的 App Token>" \
  -H "Content-Type: application/json" \
  -d '{
    "appid": "<你的实例 ID>",
    "conversationId": 1688850000000001,
    "content": "第一条测试消息"
  }'

将 conversationId 的示例数字替换为真实 ID,保留完整数字,不要加引号。

返回 code: 0,且手机企微收到「第一条测试消息」,即调用成功。完整参数和错误说明见发送文本消息。API 凭证只在服务端使用,请勿公开。

下一步 ​

需要在自己的产品中提供扫码登录时,再看登录接口指南,里面有取码、显示二维码、查询进度和验证码的完整示例。