青鸾QINGLUAN
控制台

查询扫码状态

轮询扫码状态。status:-1 未扫码 · 0 可免扫码 · 1 已扫待确认 · 2 登录成功 · 4 用户取消 · 10 待输入验证码。⚠️ -1 是尚未扫码,不是二维码失效。

POST/qingluan/api/login/checkQr

接口说明

轮询扫码状态。status-1 未扫码 · 0 可免扫码 · 1 已扫待确认 · 2 登录成功 · 4 用户取消 · 10 待输入验证码。⚠️ -1尚未扫码,不是二维码失效。

请求参数

请求体必填。通过 QL-Key 请求头携带 APIKey。

Content-Type:application/json

请求参数。字段名区分大小写,请按文档原样传递。

appidstring必填

青鸾实例 ID,形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。

字段示例:"we_xxxxxxxxxxxxxxx"
proxystring必填

代理地址

代理地址,不用则传空串

字段示例:""
uuidstring必填

登录会话 ID

登录会话标识,由「获取登录二维码」返回。轮询状态与提交验证码时都要带上。

字段示例:"<session-uuid>"

响应与结果确认

本接口为能力层原样返回,不统一增加青鸾外层信封。code = 0 仅表示请求被接受,不保证副作用已完成。

请结合业务数据与本页说明判断实际状态,不要仅凭响应码推断操作效果。

响应字段与 HTTP 状态

HTTP 200

能力层原样返回;code = 0 仅表示请求已受理,业务结果须按接口说明确认。

application/json

查看响应字段定义

接口原样返回平台的业务响应。HTTP 状态码与业务状态码需分别判断:HTTP 200 只表示请求已送达,成功以 code = 0 为准。

codeinteger必填

业务状态码

业务状态码:0 表示成功,-1 表示失败;失败原因见 message

字段示例:0
dataobject可选

业务数据

业务返回数据;字段结构见下方定义。

statusint64可选

状态

登录状态。-1=未认证需扫码 0=可免扫码 1=已扫码待确认 2=认证成功 4=用户取消 10=待输入6位验证码

注意:契约枚举 -1/0/1/2/4/10 未确认,任何一个值都没有真机样本。实现登录轮询时建议对未知值做兜底,不要用穷举 switch 直接抛错。

uuidstring可选

登录会话 ID

登录会话标识。由 /api/login/getQr 返回,checkQr/submitQrCode 需带上

detailstring可选

错误详情

错误详情;无补充信息时通常为空字符串。

messagestring必填

响应消息

业务结果消息。成功通常为 ok;企微错误通常为 错误码|错误信息

字段示例:"ok"
timestring必填

服务端时间

服务端时间,格式为 YYYY-MM-DD HH:mm:ss

字段示例:"2026-07-21 07:33:17"

HTTP 403

受控接口,需通过控制台配置

HTTP 404

appid 不存在或无权访问

搜索接口

输入关键词查找接口。最多显示 20 项。