获取登录二维码

获取登录二维码。返回的 data.uuid 用于后续「查询扫码状态」。

POST/qingluan/api/login/getQr

在线调试鉴权与基础约定

接口说明

获取登录二维码。返回的 data.uuid 用于后续「查询扫码状态」。

⚠️ 要求长连接处于关闭状态，否则返回 please close long client。长连接由青鸾统一管理，遇到该错误请在开发者控制台「实例与回调」重新上号。

请求参数

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

Content-Type：application/json

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

appidstring必填

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

字段示例："we_xxxxxxxxxxxxxxx"

proxystring必填

代理地址

代理地址，不用则传空串

字段示例：""

响应与结果确认

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

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

响应字段与 HTTP 状态

HTTP 200

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

application/json

查看响应字段定义

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

codeinteger必填

业务状态码

业务状态码：0 表示成功，-1 表示失败；失败原因见 message。

字段示例：0

dataobject可选

业务数据

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

imageBase64string可选

二维码图片 Base64

注意：未确认：图片格式、尺寸、有无 data: 前缀都没取到样本。注意它与个人二维码接口的字段名不同（那边叫 data.base64），不要混用解析代码。

uuidstring可选

登录会话 ID

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

refreshIntervalint64可选

二维码刷新间隔（秒）

注意：契约标 integer/int64、描述「二维码刷新间隔（秒）」。单位与是否强制刷新均未确认，接入前请取样确认。

detailstring可选

错误详情

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

messagestring必填

响应消息

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

字段示例："ok"

timestring必填

服务端时间

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

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

HTTP 403

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

HTTP 404

appid 不存在或无权访问

请求示例

请求示例 · JSON

{
  "appid": "we_xxxxxxxxxxxxxxx",
  "proxy": ""
}

响应示例

HTTP 200 响应示例 · JSON

{
  "code": 0,
  "data": {
    "imageBase64": "",
    "uuid": "",
    "refreshInterval": 0
  },
  "detail": "",
  "message": "ok",
  "time": "2026-07-21 07:33:17"
}

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

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