当前公开契约 · 登录与扫码

企业微信查询扫码状态 API

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

进入控制台试用 查看完整契约
POST实例字段:ql_appid更新:2026-09-04

请求地址

POST https://api.qingluanbot.com/qingluan/api/login/checkQr

请求示例

curl -X POST 'https://api.qingluanbot.com/qingluan/api/login/checkQr' \
  -H 'X-Qingluan-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "ql_appid": "inst_xxxxxxxxxxxx",
  "proxy": "",
  "uuid": "<session-uuid>"
}'

请求参数

字段类型要求说明
ql_appidstring必填青鸾实例 ID,形如 inst_xxxx。在开发者控制台「实例与回调」扫码上号后获得。
proxystring必填代理地址,不用则传空串
uuidstring必填登录会话标识,由「获取登录二维码」返回。轮询状态与提交验证码时都要带上。

响应判断

能力层接口返回包含 code、message、time 与 data 等字段;请以 code=0 判断业务成功。HTTP 200 只表示网关已返回响应,不能替代业务状态判断。

可能的响应状态

HTTP 状态公开契约说明
200原样返回(code = 0 即成功)
403受控接口,需通过控制台配置
404ql_appid 不存在或无权访问

200 响应示例

{
  "code": 0,
  "data": {
    "status": 0,
    "uuid": "REPLACE_WITH_ID"
  },
  "detail": "请按接口说明填写",
  "message": "ok",
  "time": "2026-07-21 07:33:17"
}

接入步骤

  1. 在青鸾开发者控制台创建或查看 API Key。
  2. 在「实例与回调」接入企业微信账号,取得 ql_appid
  3. 请求头携带 X-Qingluan-Key,按当前契约提交 JSON 请求。
  4. 读取响应中的 code;仅当 code=0 时按成功流程处理。

把企业微信能力接入你的系统

从 API Key、ql_appid 到首个 code=0 响应,可在开发者控制台完成配置与验证。

打开开发者控制台