请求地址
POST https://api.qingluanbot.com/qingluan/api/collection/add
请求示例
curl -X POST 'https://api.qingluanbot.com/qingluan/api/collection/add' \
-H 'QL-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"appid": "we_xxxxxxxxxxxxxxx",
"id": 0,
"syncKey": 0,
"messageType": 0,
"fromUserId": 0,
"toUserId": 0,
"roomId": 0,
"contentType": 0,
"sendTime": 0,
"appInfo": "",
"senderName": "",
"content": [],
"extraData": "",
"flag": "",
"devInfo": "",
"summary": ""
}'
请求参数
| 字段 | 类型 | 要求 | 说明 |
|---|
appid | string | 必填 | 青鸾实例 ID，形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。 |
id | integer | 可选 | 消息 ID。发送接口返回的 data.id。 |
syncKey | integer | 可选 | 分页游标。首次传 0，之后传上一页返回的 syncKey。 |
messageType | integer | 可选 | 消息类型枚举。 |
fromUserId | integer | 可选 | 发送方 ID。 |
toUserId | integer | 可选 | 接收方 ID。 |
roomId | integer | 可选 | 群 ID。取自「创建群聊」或「查询我的客户群」。注意查询接口返回的是字符串，回传时需转整数。 |
contentType | integer | 可选 | 内容类型码。 |
sendTime | integer | 可选 | 发送时间戳（秒）。 |
appInfo | string | 可选 | 消息指纹串，原样回填。 |
senderName | string | 可选 | 发送者显示名。 |
content | array<string> | 可选 | 正文。结构随 contentType 变化，原样回填。 |
extraData | string | 可选 | 随 data 一并回填，不需要自行构造。 |
flag | string | 可选 | 随 data 一并回填，不需要自行构造。 |
devInfo | string | 可选 | 随 data 一并回填，不需要自行构造。 |
summary | string | 可选 | 随 data 一并回填，不需要自行构造。 |
响应判断
能力层接口返回包含 code、message、time 与 data 等字段；请以 code=0 判断业务成功。HTTP 200 只表示网关已返回响应，不能替代业务状态判断。
可能的响应状态
| HTTP 状态 | 公开契约说明 |
|---|
200 | 原样返回（code = 0 即成功） |
403 | 受控接口，需通过控制台配置 |
404 | appid 不存在或无权访问 |
200 响应示例
{
"code": 0,
"data": {},
"detail": "",
"message": "ok",
"time": "2026-07-21 07:33:17"
}
接入步骤
- 在青鸾开发者控制台创建或查看 API Key。
- 在「实例与回调」接入企业微信账号，取得
appid。 - 请求头携带
QL-Key，按当前契约提交 JSON 请求。 - 读取响应中的
code；仅当 code=0 时按成功流程处理。