请求地址
POST https://api.qingluanbot.com/qingluan/api/long/start
请求示例
curl -X POST 'https://api.qingluanbot.com/qingluan/api/long/start' \
-H 'QL-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"appid": "we_xxxxxxxxxxxxxxx",
"callbackUrl": "<省略>",
"pushHistory": false
}'
请求参数
| 字段 | 类型 | 要求 | 说明 |
|---|
appid | string | 必填 | 青鸾实例 ID，形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。 |
callbackUrl | string | 必填 | 公网可访问的回调地址，只接受 POST；事件类型见回调包体的 event_type 字段。 注意：只在建连时登记一次。已经连着的时候想换地址，必须用 /api/long/updateCallbackURL；用 start 换会连带重置连接。另外契约 example 里这个值被生成成了 https://example.com/sample.jpg（占位符错误，一张图片地址不可能是回调端点），别照抄，实际要填能接 POST 的接口地址。 |
pushHistory | boolean | 必填 | 是否推送历史消息。true=登录后补推历史，false=只推新消息 注意：未确认。因为没有在「未连接」状态下建过连，true 会补推多少条、补推事件与增量事件在结构上是否有区别，都没有样本。 |
响应判断
能力层接口返回包含 code、message、time 与 data 等字段；请以 code=0 判断业务成功。HTTP 200 只表示网关已返回响应，不能替代业务状态判断。
可能的响应状态
| HTTP 状态 | 公开契约说明 |
|---|
200 | 原样返回（code = 0 即成功） |
403 | 受控接口，需通过控制台配置 |
404 | appid 不存在或无权访问 |
200 响应示例
{
"code": 0,
"data": {}
}
接入步骤
- 在青鸾开发者控制台创建或查看 API Key。
- 在「实例与回调」接入企业微信账号，取得
appid。 - 请求头携带
QL-Key，按当前契约提交 JSON 请求。 - 读取响应中的
code；仅当 code=0 时按成功流程处理。