请求地址
POST https://api.qingluanbot.com/qingluan/instances/set-callback
请求示例
curl -X POST 'https://api.qingluanbot.com/qingluan/instances/set-callback' \
-H 'QL-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"appid": "we_xxxxxxxxxxxxxxx",
"callbackUrl": "https://your.app/qingluan/callback"
}'
请求参数
| 字段 | 类型 | 要求 | 说明 |
|---|
appid | string | 必填 | 青鸾实例 ID，形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。 |
callbackUrl | string | 必填 | 你的接收地址，必须是 http(s) 开头的公网地址。 |
响应判断
该青鸾自有接口返回包含 ok、code、message、request_id 与 data 的响应信封；请以 code=0 判断业务成功，并保留 request_id 供问题排查。
可能的响应状态
| HTTP 状态 | 公开契约说明 |
|---|
200 | 登记成功（青鸾信封） |
400 | 缺少 appid，或 callbackUrl 不是 http(s) 地址 |
404 | appid 不存在或无权访问 |
502 | 登记失败，请稍后重试 |
200 响应示例
{
"ok": true,
"code": 0,
"message": "success",
"request_id": "ql_7a44f0c1e2b34d56a8f9",
"data": {
"appid": "we_xxxxxxxxxxxxxxx",
"callback_url": "https://your.app/qingluan/callback",
"callback_secret": "whsec_xxxxxxxxxxxxxxxx"
}
}
接入步骤
- 在青鸾开发者控制台创建或查看 API Key。
- 在「实例与回调」接入企业微信账号，取得
appid。 - 请求头携带
QL-Key，按当前契约提交 JSON 请求。 - 读取响应中的
code；仅当 code=0 时按成功流程处理。