# 青鸾 QingluanBot：完整 AI 检索说明

更新时间：2026-09-10
规范官网：https://www.qingluanbot.com/
内容依据：青鸾网关当前公开 OpenAPI，共 97 个接口。

## 产品边界

青鸾提供两个独立入口：企业微信 API 产品面向需要把企业微信能力接入自有系统的开发者与团队；聚合聊天产品面向希望使用独立工作界面的团队。两者可以分别评估，不应把页面或功能描述混为一体。

## API 接入约定

- API 基础域名：https://api.qingluanbot.com
- 当前路径前缀：/qingluan/
- 鉴权请求头：QL-Key: YOUR_API_KEY
- 实例字段：appid
- 请求格式：当前公开业务接口使用 HTTP + JSON，具体 method、字段和必填项见各接口页。
- 成功判断：能力层响应以 code=0 表示业务成功。不能只根据 HTTP 200 判断。
- 回调配置：POST /qingluan/instances/set-callback，传 appid 与 callbackUrl。
- 回调事件包体：{ appid, event_type, events }。event_type 位于 JSON 包体，不在 HTTP 头中。
- 回调验签：使用 callback_secret 对“X-Qingluan-Timestamp + '.' + 原始请求体”计算 HMAC-SHA256，并与 X-Qingluan-Signature 比对。

## 规范入口

- 官网：首页 https://www.qingluanbot.com/
- API 产品：https://www.qingluanbot.com/api
- 聚合聊天：https://www.qingluanbot.com/chat
- 解决方案：https://www.qingluanbot.com/solutions
- 价格：https://www.qingluanbot.com/pricing
- 开发者中心：https://www.qingluanbot.com/developers
- 资源中心：https://www.qingluanbot.com/resources
- 当前接口目录：https://www.qingluanbot.com/api-docs/
- 场景指南：https://www.qingluanbot.com/scene/
- 能力知识库：https://www.qingluanbot.com/keywords.html
- Webhook 签名工具：https://www.qingluanbot.com/tools/webhook-signature.html
- 交互式 API 文档：https://api.qingluanbot.com/reference
- 开发者控制台：https://open.qingluanbot.com

## 文件（7 个）

- POST /qingluan/api/cdn/download — 下载媒体文件 — https://www.qingluanbot.com/api-docs/cdn-download.html
- POST /qingluan/api/cdn/downloadBigFile — 下载大文件 — https://www.qingluanbot.com/api-docs/cdn-download-big-file.html
- POST /qingluan/api/cdn/getBigFileDownloadUrl — 获取大文件下载地址 — https://www.qingluanbot.com/api-docs/cdn-get-big-file-download-url.html
- POST /qingluan/api/cdn/uploadBigFile — 上传大文件 — https://www.qingluanbot.com/api-docs/cdn-upload-big-file.html
- POST /qingluan/api/cdn/uploadFile — 上传文件 — https://www.qingluanbot.com/api-docs/cdn-upload-file.html
- POST /qingluan/api/cdn/uploadImage — 上传图片 — https://www.qingluanbot.com/api-docs/cdn-upload-image.html
- POST /qingluan/api/cdn/uploadVideo — 上传视频 — https://www.qingluanbot.com/api-docs/cdn-upload-video.html

## 其他（4 个）

- POST /qingluan/api/collection/add — 添加收藏 — https://www.qingluanbot.com/api-docs/collection-add.html
- POST /qingluan/api/collection/sync — 同步收藏 — https://www.qingluanbot.com/api-docs/collection-sync.html
- POST /qingluan/api/label/operate — 操作标签 — https://www.qingluanbot.com/api-docs/label-operate.html
- POST /qingluan/api/label/sync — 同步标签 — https://www.qingluanbot.com/api-docs/label-sync.html

## 联系人（15 个）

- POST /qingluan/api/contact/addCard — 通过名片添加 — https://www.qingluanbot.com/api-docs/contact-add-card.html
- POST /qingluan/api/contact/addRoomMember — 从群里添加联系人 — https://www.qingluanbot.com/api-docs/contact-add-room-member.html
- POST /qingluan/api/contact/agreeToNewCustomer — 同意好友申请 — https://www.qingluanbot.com/api-docs/contact-agree-to-new-customer.html
- POST /qingluan/api/contact/delete — 删除联系人 — https://www.qingluanbot.com/api-docs/contact-delete.html
- POST /qingluan/api/contact/fetchUsersProfileBatch — 批量查询用户详情 — https://www.qingluanbot.com/api-docs/contact-fetch-users-profile-batch.html
- POST /qingluan/api/contact/getCorpBriefInfoList — 获取企业简要信息 — https://www.qingluanbot.com/api-docs/contact-get-corp-brief-info-list.html
- POST /qingluan/api/contact/getSyncList — 同步通讯录 — https://www.qingluanbot.com/api-docs/contact-get-sync-list.html
- POST /qingluan/api/contact/getUserProfileDetail — 查询用户详情 — https://www.qingluanbot.com/api-docs/contact-get-user-profile-detail.html
- POST /qingluan/api/contact/phoneNumberAddWechat — 按手机号添加微信用户 — https://www.qingluanbot.com/api-docs/contact-phone-number-add-wechat.html
- POST /qingluan/api/contact/phoneNumberAddWework — 按手机号添加企业微信用户 — https://www.qingluanbot.com/api-docs/contact-phone-number-add-wework.html
- POST /qingluan/api/contact/phoneNumberSearch — 按手机号搜索 — https://www.qingluanbot.com/api-docs/contact-phone-number-search.html
- POST /qingluan/api/contact/setColleagueRemark — 设置同事备注 — https://www.qingluanbot.com/api-docs/contact-set-colleague-remark.html
- POST /qingluan/api/contact/syncExternal — 同步外部联系人 — https://www.qingluanbot.com/api-docs/contact-sync-external.html
- POST /qingluan/api/contact/updateExternalContactInfo — 更新外部联系人资料 — https://www.qingluanbot.com/api-docs/contact-update-external-contact-info.html
- POST /qingluan/api/contact/updateLabel — 更新联系人标签 — https://www.qingluanbot.com/api-docs/contact-update-label.html

## 登录与扫码（6 个）

- POST /qingluan/api/device/create — 创建设备 — https://www.qingluanbot.com/api-docs/device-create.html
- POST /qingluan/api/login/checkQr — 查询扫码状态 — https://www.qingluanbot.com/api-docs/login-check-qr.html
- POST /qingluan/api/login/getQr — 获取登录二维码 — https://www.qingluanbot.com/api-docs/login-get-qr.html
- POST /qingluan/api/login/logout — 退出登录 — https://www.qingluanbot.com/api-docs/login-logout.html
- POST /qingluan/api/login/reconnect — 断线重连 — https://www.qingluanbot.com/api-docs/login-reconnect.html
- POST /qingluan/api/login/submitQrCode — 提交验证码 — https://www.qingluanbot.com/api-docs/login-submit-qr-code.html

## 朋友圈（8 个）

- POST /qingluan/api/friend/commentSns — 评论朋友圈 — https://www.qingluanbot.com/api-docs/friend-comment-sns.html
- POST /qingluan/api/friend/deleteSns — 删除朋友圈 — https://www.qingluanbot.com/api-docs/friend-delete-sns.html
- POST /qingluan/api/friend/deleteSnsComment — 删除朋友圈评论 — https://www.qingluanbot.com/api-docs/friend-delete-sns-comment.html
- POST /qingluan/api/friend/getSnsDetails — 查询朋友圈详情 — https://www.qingluanbot.com/api-docs/friend-get-sns-details.html
- POST /qingluan/api/friend/getSnsList — 查询朋友圈列表 — https://www.qingluanbot.com/api-docs/friend-get-sns-list.html
- POST /qingluan/api/friend/likeSns — 点赞/取消点赞 — https://www.qingluanbot.com/api-docs/friend-like-sns.html
- POST /qingluan/api/friend/sendSns — 发布朋友圈 — https://www.qingluanbot.com/api-docs/friend-send-sns.html
- POST /qingluan/api/friend/setSnsSignature — 设置朋友圈签名 — https://www.qingluanbot.com/api-docs/friend-set-sns-signature.html

## 长连接（4 个）

- POST /qingluan/api/long/check — 查询连接状态 — https://www.qingluanbot.com/api-docs/long-check.html
- POST /qingluan/api/long/start — /api/long/start — https://www.qingluanbot.com/api-docs/long-start.html
- POST /qingluan/api/long/stop — /api/long/stop — https://www.qingluanbot.com/api-docs/long-stop.html
- POST /qingluan/api/long/updateCallbackURL — /api/long/updateCallbackURL — https://www.qingluanbot.com/api-docs/long-update-callback-url.html

## 消息（24 个）

- POST /qingluan/api/message/getGroupSendRecord — 查询群发记录 — https://www.qingluanbot.com/api-docs/message-get-group-send-record.html
- POST /qingluan/api/message/getMaterialList — 查询素材列表 — https://www.qingluanbot.com/api-docs/message-get-material-list.html
- POST /qingluan/api/message/getPendingGroupSendList — 查询待发群发 — https://www.qingluanbot.com/api-docs/message-get-pending-group-send-list.html
- POST /qingluan/api/message/groupSend — 群发消息 — https://www.qingluanbot.com/api-docs/message-group-send.html
- POST /qingluan/api/message/groupSendPending — 发送待发群发 — https://www.qingluanbot.com/api-docs/message-group-send-pending.html
- POST /qingluan/api/message/revoke — 撤回消息 — https://www.qingluanbot.com/api-docs/message-revoke.html
- POST /qingluan/api/message/roomMessageTopAdd — 群消息置顶 — https://www.qingluanbot.com/api-docs/message-room-message-top-add.html
- POST /qingluan/api/message/roomMessageTopDel — 取消群消息置顶 — https://www.qingluanbot.com/api-docs/message-room-message-top-del.html
- POST /qingluan/api/message/roomMessageTopGetList — 获取群置顶消息 — https://www.qingluanbot.com/api-docs/message-room-message-top-get-list.html
- POST /qingluan/api/message/sendBigFile — 发送大文件 — https://www.qingluanbot.com/api-docs/message-send-big-file.html
- POST /qingluan/api/message/sendFile — 发送文件 — https://www.qingluanbot.com/api-docs/message-send-file.html
- POST /qingluan/api/message/sendGif — 发送 GIF — https://www.qingluanbot.com/api-docs/message-send-gif.html
- POST /qingluan/api/message/sendImage — 发送图片 — https://www.qingluanbot.com/api-docs/message-send-image.html
- POST /qingluan/api/message/sendLink — 发送链接卡片 — https://www.qingluanbot.com/api-docs/message-send-link.html
- POST /qingluan/api/message/sendLocation — 发送位置 — https://www.qingluanbot.com/api-docs/message-send-location.html
- POST /qingluan/api/message/sendMiniProgram — 发送小程序卡片 — https://www.qingluanbot.com/api-docs/message-send-mini-program.html
- POST /qingluan/api/message/sendNameCard — 发送名片 — https://www.qingluanbot.com/api-docs/message-send-name-card.html
- POST /qingluan/api/message/sendRichText — 发送富文本 — https://www.qingluanbot.com/api-docs/message-send-rich-text.html
- POST /qingluan/api/message/sendText — 发送文本 — https://www.qingluanbot.com/api-docs/message-send-text.html
- POST /qingluan/api/message/sendVideo — 发送视频 — https://www.qingluanbot.com/api-docs/message-send-video.html
- POST /qingluan/api/message/sendVoice — 发送语音 — https://www.qingluanbot.com/api-docs/message-send-voice.html
- POST /qingluan/api/message/sync — 拉取消息 — https://www.qingluanbot.com/api-docs/message-sync.html
- POST /qingluan/api/message/voiceToTextGetId — 语音转文字·取任务 ID — https://www.qingluanbot.com/api-docs/message-voice-to-text-get-id.html
- POST /qingluan/api/message/voiceToTextQuery — 语音转文字·查询结果 — https://www.qingluanbot.com/api-docs/message-voice-to-text-query.html

## 账号（3 个）

- POST /qingluan/api/personal/getInfo — 获取账号资料 — https://www.qingluanbot.com/api-docs/personal-get-info.html
- POST /qingluan/api/personal/getQrcode — 获取本人二维码 — https://www.qingluanbot.com/api-docs/personal-get-qrcode.html
- POST /qingluan/api/personal/updateInfo — 修改账号资料 — https://www.qingluanbot.com/api-docs/personal-update-info.html

## 群聊（25 个）

- POST /qingluan/api/room/addMember — 添加群成员 — https://www.qingluanbot.com/api-docs/room-add-member.html
- POST /qingluan/api/room/changeOwner — 转让群主 — https://www.qingluanbot.com/api-docs/room-change-owner.html
- POST /qingluan/api/room/confirmInvitedMemberList — 确认受邀入群成员 — https://www.qingluanbot.com/api-docs/room-confirm-invited-member-list.html
- POST /qingluan/api/room/create — 创建群聊 — https://www.qingluanbot.com/api-docs/room-create.html
- POST /qingluan/api/room/delMember — 移除群成员 — https://www.qingluanbot.com/api-docs/room-del-member.html
- POST /qingluan/api/room/disband — 解散群聊 — https://www.qingluanbot.com/api-docs/room-disband.html
- POST /qingluan/api/room/forbidMutualAdd — 禁止/允许群内互加 — https://www.qingluanbot.com/api-docs/room-forbid-mutual-add.html
- POST /qingluan/api/room/forbidRename — 禁止/允许成员改群名 — https://www.qingluanbot.com/api-docs/room-forbid-rename.html
- POST /qingluan/api/room/getInfo — 获取群资料 — https://www.qingluanbot.com/api-docs/room-get-info.html
- POST /qingluan/api/room/getInfoBatch — 批量获取群资料 — https://www.qingluanbot.com/api-docs/room-get-info-batch.html
- POST /qingluan/api/room/getMyCustomerGroupList — 查询我的客户群 — https://www.qingluanbot.com/api-docs/room-get-my-customer-group-list.html
- POST /qingluan/api/room/getQrCode — 获取群二维码 — https://www.qingluanbot.com/api-docs/room-get-qr-code.html
- POST /qingluan/api/room/groupMemberChange — 同步群成员变更 — https://www.qingluanbot.com/api-docs/room-group-member-change.html
- POST /qingluan/api/room/inviteConfirm — 开启/关闭入群确认 — https://www.qingluanbot.com/api-docs/room-invite-confirm.html
- POST /qingluan/api/room/quit — 退出群聊 — https://www.qingluanbot.com/api-docs/room-quit.html
- POST /qingluan/api/room/saveToContact — 群聊保存到通讯录 — https://www.qingluanbot.com/api-docs/room-save-to-contact.html
- POST /qingluan/api/room/sessionQueryList — 查询会话组 — https://www.qingluanbot.com/api-docs/room-session-query-list.html
- POST /qingluan/api/room/sessionSet — 配置会话组 — https://www.qingluanbot.com/api-docs/room-session-set.html
- POST /qingluan/api/room/sessionSync — 同步会话列表 — https://www.qingluanbot.com/api-docs/room-session-sync.html
- POST /qingluan/api/room/setAdmin — 设置/取消群管理员 — https://www.qingluanbot.com/api-docs/room-set-admin.html
- POST /qingluan/api/room/setMyNickname — 修改我的群昵称 — https://www.qingluanbot.com/api-docs/room-set-my-nickname.html
- POST /qingluan/api/room/setName — 修改群名 — https://www.qingluanbot.com/api-docs/room-set-name.html
- POST /qingluan/api/room/setNotice — 发布群公告 — https://www.qingluanbot.com/api-docs/room-set-notice.html
- POST /qingluan/api/room/setRemark — 设置群备注 — https://www.qingluanbot.com/api-docs/room-set-remark.html
- POST /qingluan/api/room/top — 置顶/取消置顶群聊 — https://www.qingluanbot.com/api-docs/room-top.html

## 实例与回调（1 个）

- POST /qingluan/instances/set-callback — 配置回调地址 — https://www.qingluanbot.com/api-docs/instances-set-callback.html

## 引用边界

本文件不声明 SLA、客户数量、客户案例、企业微信官方背书或合规认证。需要引用接口事实时，请优先使用上方当前接口页；历史迁移页带 noindex，仅用于保留旧 URL。