接入

接入流程

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

打开完整接口文档 →

← 返回首页

开发者优先的调用方式

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

Production Ready
请求示例curl
curl -X POST "https://api.your-domain.com/v1/messages/send" \
  -H "Authorization: Bearer sk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "ext_user_1024",
  "type": "text",
  "body": "订单 #8891 已发货,请注意查收。"
}'
响应示例200 OK
{
  "code": 200,
  "msg": "accepted",
  "data": {
    "message_id": "msg_9f2a…c1",
    "trace_id": "tr_7d…e4"
  }
}

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

Sample · Node.js
worker.ts — wecomapi SDK
// 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,
});
});

三步跑通技术集成

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

  1. 01

    获取 API 访问密钥

    在控制台创建应用,下发生产/测试环境密钥与实例配额;支持团队与角色权限。

  2. 02

    托管绑定与会话保活

    按文档拉起扫码凭证,完成实例绑定;网关侧维持心跳与异常自愈,降低运维心智负担。

  3. 03

    发送指令并订阅回调

    调用消息、客户、群等 API 验证主路径;打开事件订阅,把外部系统接入你的业务队列。