青鸾QINGLUAN
控制台

/api/long/updateCallbackURL

登录时未配回调地址可用此接口补配。

POST/qingluan/api/long/updateCallbackURL

接口说明

登录时未配回调地址可用此接口补配。

:::tip 🔗 调用关系

登录成功后可补充或更新回调地址;新地址需支持公网 POST。 :::

:::check ✅ 成功判定:HTTP 200 且响应体 code = 0。业务失败请查看 messagedetail。 :::

请求参数

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

Content-Type:application/json

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

appidstring必填

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

字段示例:"we_xxxxxxxxxxxxxxx"
callbackUrlstring必填

回调地址

公网可访问的回调地址,只接受 POST;事件类型见回调包体的 event_type 字段。

注意:写入的是一条长度 42 的 https 地址,被接受。地址校验强度未确认:会不会拒绝 http://、内网地址或不可达地址,没试。另外契约 example 里该值被生成成了 https://example.com/sample.jpg(占位符错误),别照抄。

字段示例:"https://example.com"

响应与结果确认

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

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

响应字段与 HTTP 状态

HTTP 200

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

application/json

查看响应字段定义

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

codeinteger必填

业务状态码

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

字段示例:0
dataobject可选

业务数据

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

appidstring可选

设备实例 ID

设备实例 ID。由 /api/device/create 返回;登录后保持不变,可长期复用。

最短长度:1 字段示例:"{{appid}}"
callbackUrlstring可选

回调地址

公网可访问的回调地址,只接受 POST;事件类型见回调包体的 event_type 字段。

注意回显刚写入的地址(连同 data.appid 一起)。这是本组唯一能确认回调配置写入结果的手段 —— long/checkdatanull,读不出配置。

detailstring可选

错误详情

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

messagestring必填

响应消息

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

字段示例:"ok"
timestring必填

服务端时间

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

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

HTTP 403

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

HTTP 404

appid 不存在或无权访问

搜索接口

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