Developer First · 快速接入

企业微信 API 接入，每一步都可以验证

统一的 HTTP / JSON 调用方式，用 X-Qingluan-Key 鉴权、用 ql_appid 路由实例。先在控制台跑通真实请求，再接入业务系统。

标准 HTTP / JSON 控制台真实联调 Webhook 事件回流

第一条企业微信消息code = 0

curl -X POST 'https://api.qingluanbot.com/qingluan/api/message/sendText' \
  -H 'X-Qingluan-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "ql_appid": "inst_xxxxxxxxxxxx",
    "conversationId": 1688855874759204,
    "content": "你好，来自青鸾 API"
  }'

RESPONSE{ "code": 0, "message": "ok", "data": { ... } }

最小接入闭环

四步完成一次真实调用

每一步都有清晰的成功状态。接口字段、权限和返回结构以在线文档与控制台当期展示为准。

创建 API Key

注册开发者控制台，创建并妥善保存调用凭证。

得到 X-Qingluan-Key

接入企业微信实例

在实例页完成扫码登录，并确认账号保持在线。

得到 ql_appid

发送测试请求

先在在线测试中选择实例和接口，验证参数与真实结果。

以 code = 0 判成功

配置事件回调

登记业务服务器地址，接收消息与实例状态事件。

验证签名与事件类型

调用契约

请求、路由、返回，一眼能看懂

把鉴权、账号实例和业务参数分清，联调会更快，生产排查也更直接。

打开接口参考

AUTHENTICATION

X-Qingluan-Key

请求头携带 API Key，用于识别开发者和权限范围。

INSTANCE ROUTING

ql_appid

业务请求明确目标实例，多账号共用一套接口，不混淆路由。

RESPONSE

code = 0

当前能力层响应以 code 判断结果；特殊青鸾自有接口以文档说明为准。

当前公开能力目录

九个能力域，按业务问题查找

当前公开契约共 74 个文档端点。高风险写操作和媒体能力可能受权限策略控制，请以实际开通范围为准。

登录与扫码5 项

实例登录、扫码状态与重新连接

消息19 项

文本、富文本、图片、文件与群发等

联系人13 项

客户同步、资料、好友申请与备注

群聊17 项

群信息、成员、公告与群管理

朋友圈8 项

朋友圈读取与受控互动能力

文件7 项

媒体上传、下载与高风险权限控制

账号3 项

账号信息与自身资料

长连接1 项

连接状态检查与运行确认

实例与回调1 项

为实例配置独立事件回调

浏览接口能力目录

开发者资源

文档、指南和调试工具放在一起

从“能不能做”到“具体怎么接”，通过资源中心、接口目录和在线文档逐层深入。

接口能力总览

按九个能力域浏览当前公开文档端点。

Webhook 场景指南

了解事件回调、签名校验和联调方法。

企业微信 API 对接

从业务场景出发理解完整接入链路。

Webhook 验签工具

在浏览器中核对回调签名计算结果。

上线前检查

把长期运行的问题提前想清楚

正式接入不仅是一次请求成功，还包括权限、状态、回调和失败处理。

凭证与权限Key 不写入前端代码，按环境和应用隔离。
实例状态确认掉线、重连和不可用期间的业务兜底。
回调可靠性验签后再处理事件，并设计幂等与失败重试。
调用节奏按业务场景控制并发与频率，高风险动作人工确认。
口径一致生产字段与返回判断只以当期在线文档为准。

开始联调

先跑通一条真实链路，再扩展业务能力

进入控制台创建凭证、接入实例并完成在线测试；需要协助时，使用右下角“咨询接入”。

进入开发者控制台查看接入指南