01
消息发送与接收
覆盖文本、图片、文件、链接等高频消息类型，支持同步发送结果与异步事件回调。
企业微信 API · 开放能力
把企业微信能力，封装成统一的 REST API
消息、客户、群聊、朋友圈、文件、事件回调与实例托管，统一通过 HTTP API 组织，适合 SCRM、AI Agent 与业务系统集成。具体开放范围以当期文档与权限为准。
HTTP 标准调用 Webhook 实时回调 多实例托管
POST
/qingluan/api/message/sendText200 OK{
"ql_appid": "inst_9b2f",
"conversationId": 1688855874759204,
"content": "您好，欢迎了解青鸾。"
}code = 0 · 请求成功能力层结果按当前文档判断
86 msWebhook envelopeevent_type + ql_appid
完整能力矩阵
围绕真实业务闭环设计的 API
当前公开契约包含 74 个文档端点，覆盖九个能力域。从创建凭证、接入实例，到消息收发、客户管理与事件回调，每项能力都有明确边界。
02
登录与实例托管
通过企业微信扫码完成实例接入，统一处理在线状态、重连、代理与异常提醒。
03
客户与联系人
同步客户资料、标签、备注与跟进状态，为 CRM、SCRM 和客户运营系统提供底层数据。
04
群聊与群管理
面向客户群场景提供群资料、成员、公告、管理员与常用群管理能力，便于接入业务流程。
05
素材与媒体能力
当前契约包含图片、文件与媒体相关能力；是否开放由账号环境和风险权限共同决定。
06
Webhook 事件回调
消息与实例状态等事件可推送到业务服务器，并通过控制台完成地址配置与联调核对。
07
OpenAPI 与调试台
在线文档、参数说明和控制台真实调试围绕同一份当前契约组织。
08
鉴权与实例边界
API Key 识别调用方，ql_appid 指定企业微信实例，凭证可在控制台创建和撤销。
09
风险能力控制
媒体、朋友圈和部分高风险写操作默认受控，按测试结果与实际开通权限调用。
开放边界说明：媒体、朋友圈和部分高风险写操作会按账号环境、测试结果和权限策略控制；接口数量与字段以在线文档为唯一准绳。
核对当前文档创建调用凭证
注册开发者控制台并创建 API Key，请求时通过 X-Qingluan-Key 携带。
扫码接入企业微信实例
在实例页完成扫码登录，平台为该账号分配唯一的 ql_appid。
调用 API 验证结果
先在在线测试中选择实例和接口，确认参数、权限与真实返回。
配置 Webhook 回调
需要接收消息和状态事件时，为实例登记业务服务器回调地址。
文档与调试
接口、参数、日志，都在同一条链路里
在线文档、OpenAPI 契约和控制台调试台围绕同一套接口组织。注册并登录控制台即可直接测试，不需要额外流程。
const response = await fetch(
'https://api.qingluanbot.com/qingluan/api/message/sendText',
{
method: 'POST',
headers: {
'X-Qingluan-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
ql_appid: 'inst_xxxxx',
conversationId: 1688855874759204,
content: '你好，来自青鸾 API'
})
}
)
青鸾控制台 服务正常客户事件已同步 成功
敏感字段脱敏策略 已启用
稳定与可控
不止是接口可用，整条链路都要可观察
账号、权限、数据和调用节奏都在控制台里清晰呈现，异常状态可以被及时发现和处理。
调用节奏控制请求会经过既有配额与频控策略，实际阈值以开通范围和当前配置为准。
权限分级接口可用范围按实际开通清单与权限策略确认，相关操作可通过现有记录核对。
数据暴露控制操作日志避免记录凭证明文；其他字段的展示与留存方式以具体模块策略和实际配置为准。
状态与异常排查实例、回调和调用状态可在控制台核对，为异常定位提供统一入口。
接入问答
调用之前，先确认这些契约
页面只说明稳定的公共约定；逐接口参数、权限范围与返回字段，始终以当期在线文档为准。
青鸾 API 的当前基础路径是什么？
当前数据面接口使用 /qingluan/ 路径，其中业务能力集中在 /qingluan/api/{模块}/{动作}。请不要再使用已经退役的 /wecom/ 旧路径。
API 请求如何鉴权并指定账号？
请求头携带 X-Qingluan-Key；业务请求体携带 ql_appid，用它指定要调用的企业微信实例。
怎样判断一次能力调用是否成功？
当前能力层响应原样返回，通常以 code = 0 判断成功；青鸾自有接口可能使用单独响应结构，具体以该接口的在线文档为准。
所有接口注册后都会自动开放吗？
不会。媒体、朋友圈及部分高风险写操作会受账号环境、测试结果和权限策略控制，正式开放范围以实际开通清单为准。