Qmsg酱 v3.0

接口文档

通过简单的 HTTP 请求向 QQ 推送消息,并使用消息 ID 查询处理状态。使用过程中的任何问题都可以加交流QQ群 374944882 进行讨论。Qmsg酱支持机器人托管,点击查看。

使用协议

  1. 禁止发送涉黄、涉政、涉恐、辱骂、威胁、广告、诈骗等违规内容。后台已接入云文字识别,检测到违规内容后可能封禁账户,识别结果可能存在误伤。如果涉及法律责任,相关内容将被上报至有关部门。
  2. 使用本站服务,即默认同意本网站平台机器人账号有权通过平台 API 功能,被动向您推送消息。
  3. 使用本站服务,即默认同意本网站保留对您在本网站账号的全部管理权利。
  4. 平台不会主动向您推送消息。您在平台上的一切活动均为主观操作,与平台无关。

快速开始

使用 QQ 登录后,在控制台获取 API Key,然后使用 QQ 扫码添加机器人为好友,并向机器人发送您的 API Key 完成绑定。绑定完成后,推送的消息将由该机器人发送到您的 QQ 单聊。API Key 是推送凭证,请勿泄露或提交到公共代码仓库。

进入控制台获取 API Key

统一约定

项目说明
Key放在 URL 路径中,例如 /v3/send/{key}
消息不能为空,目前最长 1800 个字符
限流同一 API Key 每 5 秒最多提交一次推送
限额每日最多推送 500 次,违规消息不计次,每日 0 点重置
响应统一返回 JSON,通过 success 判断业务是否成功,结果位于 data

成功响应

{
  "success": true,
  "message": "操作成功"
  "code": 0,
  "data": 42
}

推送接口中的 data 是消息 ID,可用于查询消息状态。

失败响应

{
  "success": false,
  "message": "错误描述"
  "code": 500,
  "data": null
}

响应结果中的 code 目前只有0和500,0代表成功,500是有错误,请使用success属性来判断本次业务是否成功。

GET / POST

参数推送

/v3/send/{key}

使用查询参数或表单参数提交消息内容,默认发送到您绑定机器人的 QQ 单聊;传入 group 参数则推送到对应的 QQ 群。

参数必填说明
msg是推送内容,最长 1800 个字符
group否目标 QQ 群号,传入后消息将推送到该群(需先在控制台添加该群并完成群绑定)

GET 示例

https://qmsg.zendee.cn/v3/send/你的Key?msg=服务器任务完成

POST 示例

curl -X POST "https://qmsg.zendee.cn/v3/send/你的Key" \
  --data-urlencode "msg=服务器任务完成"

群推送示例

https://qmsg.zendee.cn/v3/send/你的Key?msg=服务器任务完成&group=123456789
POST JSON

JSON 推送

/v3/jsend/{key}

请求头必须包含 Content-Type: application/json。

请求体

{
  "msg": "服务器任务完成"
}

可选字段 group 为目标 QQ 群号,传入后消息将推送到该群(需先在控制台添加该群并完成群绑定)。

请求示例

curl -X POST "https://qmsg.zendee.cn/v3/jsend/你的Key" \
  -H "Content-Type: application/json" \
  -d '{"msg":"服务器任务完成"}'

群推送示例

curl -X POST "https://qmsg.zendee.cn/v3/jsend/你的Key" \
  -H "Content-Type: application/json" \
  -d '{"msg":"服务器任务完成","group":"123456789"}'
GET / POST

消息状态

/v3/msg/status/{key}

推送为异步处理,返回消息 ID 后即可通过状态接口查询发送结果。

参数必填说明
msgId是发送接口返回的消息 ID

请求示例

https://qmsg.zendee.cn/v3/msg/status/你的Key?msgId=42

响应示例

{
  "success": true,
  "message": "操作成功"
  "code": 0,
  "data": 1
}
状态含义
0未回执,消息已提交发送,QQ还未返回发送结果
1发送成功
2消息违规
-1发送失败

限制与说明

为保证服务稳定和消息合规,系统会对推送内容进行检测。

检测范围

  • URL
  • IPv4 地址
  • 连续数字
  • 敏感词汇

消息违规反馈

如果您不理解消息为什么违规,可以在 QQ 群 @1244453393 提出反馈。

URL、IPv4 地址和连续数字串属于绝对禁止内容,不接受移除建议。

PRIVATE BOT

机器人托管

Qmsg酱支持机器人托管。您自己的 QQ 机器人可以接入 Qmsg酱,并且该机器人只有您自己可以使用,不受其他任何人的干扰。接入 Qmsg酱的工作完全由我们来做,不需要您进行任何代码开发,接入后使用方式与文档一致。

推送限流 0.5 秒
每日消息数 1000 条
违规内容检查 不受限制

如需托管,请前往 机器人托管页面 自助接入。