Qmsg酱

# API文档

本文章内容需要掌握基本的HTTP请求技能，如果您暂未掌握HTTP基础技能，建议通过百度 (opens new window)去学习！

赞助

Qmsg酱由林枫云 (opens new window)提供云计算服务，高防游戏云/稳定业务云

# 推送接口地址

# 表单参数推送接口

  • 协议：GET或POST
  • 参数类型：application/x-www-form-urlencoded

# 私聊消息

https://qmsg.zendee.cn/send/{您的KEY}
1

例如https://qmsg.zendee.cn/send/4dfglkslkfiuoernglalksajkljlhdgh

# 群消息

https://qmsg.zendee.cn/group/{您的KEY}
1

例如https://qmsg.zendee.cn/group/4dfglkslkfiuoernglalksajkljlhdgh

# JSON参数推送接口

  • 协议：POST
  • 参数类型：application/json

# 私聊消息

https://qmsg.zendee.cn/jsend/{您的KEY}
1

例如https://qmsg.zendee.cn/jsend/4dfglkslkfiuoernglalksajkljlhdgh

# 群消息

https://qmsg.zendee.cn/jgroup/{您的KEY}
1

例如https://qmsg.zendee.cn/jgroup/4dfglkslkfiuoernglalksajkljlhdgh

# 推送接口参数

# 必选参数

  • msg：要推送的消息内容

# 非必选参数

  • qq：指定要接收消息的QQ号或者QQ群。多个以英文逗号分割，例如：12345,12346。指定的QQ号或者QQ群必须在你的管理台 (opens new window)已添加。传参请根据当前是私聊消息接口还是群消息接口来决定私有云不会强校验qq这个参数指定的QQ号或Q群是否在管理台的QQ列表里，而是直接使用qq这个参数向QQ号或者Q群推送消息。
  • bot：机器人的QQ号。指定使用哪个机器人来发送消息，不指定则会自动随机选择一个在线的机器人发送消息。该参数仅私有云有效

# JSON参数示例

{
  "msg": "消息内容",
  "qq": "12345,12346",
  "bot": "12345"
}
1
2
3
4
5

恭喜你

(*￣︶￣) 看到这里，你已经可以实现消息推送了，可以去试试了！

# 接口响应内容

{
    "success":true,
    "reason":"操作成功",
    "code":0,
    "info":{}
}
1
2
3
4
5
6
  • success：本次请求是否成功，类型boolean,值是true或false
  • reason：本次请求结果描述，类型string
  • code：错误代码，类型integer，错误代码目前不可靠，如果要判断是否成功请使用success
  • info：在本章内容没什么用，类型object

提示

该响应结构通用，Qmsg酱提供的所有接口响应结构均相同

# 消息推送状态

消息推送完毕后，在管理台会生成相应的消息记录，通过这些记录，您可以判断消息发送状态。

以下逐个解释可能会出现的状态

  • 未回执状态，未回执状态表示机器人程序已经执行了消息推送命令，但是还未告诉管理台消息的发送结果。

未回执状态

  • 发送失败状态，发送失败状态表示机器人程序已经执行了推送命令，但是消息推送失败，具体的失败原因有很多种，如腾X风控、机器人被删好友等。如果是捐赠版或私有化机器人，可向群主提供日志来判断具体原因。

发送失败状态

  • 消息违规状态，消息违规状态出现在使用公共机器人的情况下，推送了包含违禁内容的消息。具体的违禁内容可查看消息记录内容尾部的粉红色字体。违禁检测项可在这里查看

发送失败状态

若您的消息记录无以上状态，表示消息已成功发送！

# 消息内容增强

消息内容增强支持发送QQ表情、群内@、图片

从2024年5月11日起 消息内容增加将不再支持JSON卡片和XML卡片

# 表情用法

@face=表情ID@
1

例：你好啊@face=1@这是一个撇嘴表情

表情内容增强

更多表情ID点击这里 (opens new window)查看(不全)

提示

如果使用了不存在的表情ID，本条消息发送可能会失败

# 群@用法

# @个人

@at=群员QQ号@
1

# @全体（需要机器人有管理员权限）

@at=-1@
1

例：你好@at=1244453393@,我@了你

群AT内容增强

提示

非管理员使用@全体或者@的QQ号不在群内，本条消息发送可能会失败，@语法仅在推送群消息时有效，私聊消息使用@语法会被当做普通文本发送出去

# 图片用法

@image=可访问的图片url地址@
1

例：你好，这是神邸的logo图片@image=https://www.zendee.cn/zendee.png@

图片内容增强

提示

一次推送不建议放多张图片，最好是单张图片，图片越多速度越慢，资源消耗越大，越容易出错，如果你的图片URL包含中文、特殊字符等，建议先URI编码一下，不然会出错

# 捐赠版/私有云 专属接口

# 向管理台添加QQ号

# 接口地址

https://qmsg.zendee.cn/q/add
1

# 请求类型

  • 协议：POST
  • 参数类型：application/x-www-form-urlencoded（表单参数）

# 请求参数

  • key：您的key（必填）
  • qq：要添加的QQ号（必填）
  • qqDesc：QQ号的描述（非必填）

# 从管理台删除QQ号

# 接口地址

https://qmsg.zendee.cn/q/del
1

# 请求类型

  • 协议：POST
  • 参数类型：application/x-www-form-urlencoded（表单参数）

# 请求参数

  • key：您的key（必填）
  • qq：要删除的QQ号（必填）

# 向管理台添加QQ群

# 接口地址

https://qmsg.zendee.cn/g/add
1

# 请求类型

  • 协议：POST
  • 参数类型：application/x-www-form-urlencoded（表单参数）

# 请求参数

  • key：您的key（必填）
  • qq：要添加的QQ群（必填）
  • qqDesc：QQ群的描述（非必填）

# 从管理台删除QQ群

# 接口地址

https://qmsg.zendee.cn/g/del
1

# 请求类型

  • 协议：POST
  • 参数类型：application/x-www-form-urlencoded（表单参数）

# 请求参数

  • key：您的key（必填）
  • qq：要删除的QQ群（必填）

# 触发关键词回调URL

提示

该功能仅捐赠版和私有云支持

在群里或者私聊中，机器人接收到的聊天消息包含您设置的聊天关键词，则机器人会向您设置的触发关键词回调URL发送一个POST请求，您可以在接收到该POST请求后做任何业务逻辑。聊天关键词和触发关键词回调URL可以在管理台机器人管理面板设置。

机器人管理面板入口 机器人回调设置 保存机器人设置

# 机器人回调请求类型

  • 协议：POST
  • 参数类型：application/x-www-form-urlencoded（表单参数）

# 机器人回调请求参数

  • msg：包含聊天关键词的消息内容(纯文本,即使消息中包含图片表情等非文本内容)
  • qq：发送消息的QQ号
  • group：消息所在的群号，如果是私聊消息，则该参数为空或null