Qmsg酱 v3.0

接口文档

通过简单的 HTTP 请求向 QQ 推送消息,并使用消息 ID 查询处理状态。使用过程中的任何问题都可以加交流QQ群 374944882 进行讨论。

使用协议

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

快速开始

使用 QQ 登录后,在控制台获取 API Key,并添加机器人为好友。API Key 是推送凭证,请勿泄露或提交到公共代码仓库。

进入控制台获取 API Key

重置 Key 后旧 Key 会立即失效,使用旧 Key 的推送任务将中断。

统一约定

项目说明
Key放在 URL 路径中,例如 /v3/send/{key}
QQ接收消息的QQ号
消息不能为空,目前最长 1000 个字符
限流限制每 5 秒最多提交一次推送
响应统一返回 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 和消息内容。

参数必填说明
qq接收消息的 QQ 号
msg推送内容,最长 1000 个字符

GET 示例

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

POST 示例

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

JSON 推送

/v3/jsend/{key}

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

请求体

{
  "qq": "12345678",
  "msg": "服务器任务完成"
}

请求示例

curl -X POST "https://qmsg.zendee.cn/v3/jsend/你的Key" \
  -H "Content-Type: application/json" \
  -d '{"qq":"12345678","msg":"服务器任务完成"}'
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 地址和连续数字串属于绝对禁止内容,不接受移除建议。