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

企业微信创建设备 API

创建一个设备,返回的标识用于后续扫码登录。⚠️ version 是整数,传 0 即可;传版本号字符串会被拒绝。

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

请求地址

POST https://api.qingluanbot.com/qingluan/api/device/create

请求示例

curl -X POST 'https://api.qingluanbot.com/qingluan/api/device/create' \
  -H 'QL-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "appid": "we_xxxxxxxxxxxxxxx",
  "type": "iPad",
  "name": "示例名称",
  "version": 0
}'

请求参数

字段类型要求说明
appidstring必填青鸾实例 ID,形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。
typestring必填设备类型,例如 iPad。 注意:必填且强校验:缺失或空串直接 code=-1 / type cannot be empty。传 iPad 可用,其它取值未确认。(早期契约未把它标为必填,contract_errors.missing_required 已记录,现按实际补齐。)
namestring必填名称/昵称 注意:契约标 required,但完全不传也返回 code=0。至少在缺失时服务端不做校验。它究竟影响什么(设备显示名?风控画像?)未确认。
versioninteger必填版本号,整数,传 0 即可。

响应判断

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

可能的响应状态

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

200 响应示例

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

接入步骤

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

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

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

打开开发者控制台