NEW

免费试用已开放

立即开始

企业微信 API 接入流程

对照示例即可联调,完整字段与鉴权说明以线上文档为准。适用于已确定采用企业微信开发 API或企微 API 网关、需要快速跑通消息与回调的工程师。

REST API

开发者优先的调用方式

REST 风格接口、统一鉴权与幂等语义;以下为示意请求与响应,生产域名与路径以控制台为准。

Production Ready
请求示例 — POST /message/sendTextcurl
curl -X POST "https://manager.wecomapi.com/message/sendText" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "guid":    "7db8…",
  "toId":    "78813…",
  "content": "订单 #8891 已发货,请注意查收。"
}'
响应示例200 OK
{ "code": 0, "msg": "success" }

x-request-id: req_7d4ec1a9
x-ratelimit-remaining: 98
鉴权
Authorization: Bearer

所有接口共用一套密钥,在控制台创建与轮换。

数据格式
application/json

请求体与响应体均为 JSON,字段含义以文档为准。

幂等
idempotent

接口按幂等语义设计,网络抖动后重试是安全的。

追踪
x-request-id

每次调用在响应头回传的标识,排障时提供它即可定位。

Webhook

事件驱动:监听回调并回写业务

企业微信侧产生的消息事件推送到你的回调地址,落进队列后按业务规则处理,再用发送接口回复回去。

Sample · Node.js
worker.ts — wecomapi SDKTypeScript
// 1) 订阅实时消息,统一进入你的业务队列
client.on("message", async (msg) => {
  await queue.enqueue({
    topic:   "inbound.dm",
    payload: msg,
  });

  // 2) 命中规则后,调用发送 API 完成闭环
  await client.messages.send({
    to:   msg.from,
    type: "text",
    body: "已收到,工单已创建:" + ticketId,
  });
});
01

订阅实时消息

回调收到的事件统一进入你的业务队列,处理逻辑与投递解耦。

02

回写业务结果

命中规则后调用发送 API,把处理结果送回同一个会话,完成闭环。

回调接口建议尽快返回,把耗时逻辑交给队列异步处理,并按事件做幂等。

接入路径

三步跑通技术集成

从拿到密钥到发出第一条生产消息,路径尽量短;复杂策略默认内置在网关策略层。

  1. 01

    获取 API 访问密钥

    在控制台创建应用,下发生产 / 测试环境密钥与实例配额。

    支持团队与角色权限。

  2. 02

    托管绑定与会话保活

    按文档拉起扫码凭证,完成实例绑定。

    网关侧维持心跳与异常自愈,降低运维心智负担。

  3. 03

    发送指令并订阅回调

    调用消息、客户、群等 API 验证主路径。

    打开事件订阅,把外部系统接入你的业务队列。

每一步涉及的参数与字段,以线上接口文档的说明为准。

阅读开发指南

联系我们

联调遇到卡点,随时找我们

接入方案、私有化部署与商务合作可加微信沟通;接口字段、鉴权与错误码以线上文档为准。

商务与合作

微信搜索下方 ID 添加,说明使用场景可以更快对接。

微信号

cc_wecomapi

接口文档

完整的接口列表、请求字段、回调事件格式与错误码说明。

控制台

创建应用、管理密钥与实例,生产域名与路径也在这里查看。