企业微信场景指南

企业微信 API 对接

对接青鸾企业微信 API 的核心约定有四个:基础域名是 https://api.qingluanbot.com;当前路径以 /qingluan/ 开头;用 QL-Key 鉴权并在请求体传 appid;能力层响应以 code=0 判断成功。

进入开发者控制台 查看公开契约

内容依据当前公开接口能力整理 · 更新于 2026-09-10

请求与鉴权

从开发者控制台取得 API Key,通过 QL-Key 请求头携带。当前业务接口使用 JSON 请求体,并用 appid 指定已接入的企业微信实例。

响应判断

能力层一般返回 code、message、time 与 data 等字段。HTTP 200 代表网关返回了响应,但业务是否成功仍以 code=0 为准。配置回调地址属于青鸾自有接口,会额外返回 ok 和 request_id。

从哪个接口开始

建议先用查询连接状态或查询账号资料验证鉴权和实例归属,再接入消息、联系人、群聊等业务接口。调用参数应从当前接口目录或交互式文档读取。

建议实施步骤

  1. 创建 API Key。
  2. 接入企业微信账号并取得 appid。
  3. 调用查询类接口验证鉴权与实例。
  4. 接入业务动作并按 code=0 处理成功。
  5. 需要接收事件时再配置回调和验签。

常见问题

当前 API 路径前缀是什么?

当前公开接口位于 /qingluan/**,完整路径请从当前接口目录查看。

为什么 HTTP 200 还要判断 code?

HTTP 状态表示传输和网关响应情况,能力层的业务结果由 code 表达;code=0 才是业务成功。

把场景拆成可验证的接口步骤

从一个查询接口开始,确认 appid、鉴权和 code=0 判断,再扩展业务流程。

打开控制台