请求地址
POST https://api.qingluanbot.com/qingluan/api/message/sendMiniProgram
请求示例
curl -X POST 'https://api.qingluanbot.com/qingluan/api/message/sendMiniProgram' \
-H 'QL-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"appid": "we_xxxxxxxxxxxxxxx",
"conversationId": 1000000000000001,
"content": {
"title": "示例名称",
"miniProgramDetails": {
"username": "gh_example@app",
"appId": "wx0000000000000000",
"path": "pages/index/index",
"coverUrl": "https://example.com/sample",
"title": "示例名称",
"appName": "示例名称",
"fallbackUrl": "https://example.com/sample",
"coverFileId": "<media-file-id>",
"coverMd5": "00000000000000000000000000000000",
"coverAesKey": "00000000000000000000000000000000",
"coverSize": 57102,
"coverWidth": 1000000000000001,
"coverHeight": 400
}
}
}'
请求参数
| 字段 | 类型 | 要求 | 说明 |
|---|
appid | string | 必填 | 青鸾实例 ID，形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。 |
conversationId | integer | 必填 | 会话 ID。群聊传群号，私聊传对方 uin。注意它超出 JavaScript 安全整数范围，JS 侧需按大整数处理，不要经过 Number()。 |
content | object | 必填 | 消息/动态正文。纯文本类接口传字符串；媒体类传对象（把上传接口返回的 data 整体带上） |
响应判断
能力层接口返回包含 code、message、time 与 data 等字段；请以 code=0 判断业务成功。HTTP 200 只表示网关已返回响应，不能替代业务状态判断。
可能的响应状态
| HTTP 状态 | 公开契约说明 |
|---|
200 | 原样返回（code = 0 即成功） |
403 | 受控接口，需通过控制台配置 |
404 | appid 不存在或无权访问 |
200 响应示例
{
"code": 0,
"data": {
"id": 0,
"syncKey": 0,
"messageType": 0,
"fromUserId": 0,
"toUserId": 0,
"roomId": 0,
"contentType": 0,
"sendTime": 0,
"appInfo": "",
"senderName": "",
"content": {
"title": "",
"miniProgramDetails": {
"username": "",
"appId": "",
"path": "",
"type": 0,
"source": 0,
"coverUrl": "",
"title": "",
"appName": "",
"fallbackUrl": "",
"appNameDup": "",
"coverMd5": "",
"coverSize": 0,
"reserved19": 0,
"reserved20": 0,
"coverWidth": 0,
"coverHeight": 0,
"flag": 0
}
}
},
"detail": "",
"message": "ok",
"time": "2026-07-21 07:33:17"
}
接入步骤
- 在青鸾开发者控制台创建或查看 API Key。
- 在「实例与回调」接入企业微信账号，取得
appid。 - 请求头携带
QL-Key，按当前契约提交 JSON 请求。 - 读取响应中的
code；仅当 code=0 时按成功流程处理。