README

::: highlight purple 💡
本项目开源, 源码群内自行下载, 秋秋群: 480979583
永久免费, 无任何网络认证, 本地认证, 强制升级, 连接后台等限制
:::

::: tip 特色
调用时 token 身份鉴权
自定义字符集编码: utf-8/gbk
自定义推送时携带 header
事件推送: http/websocket方式推送, http支持多个
接口 json 优化, 推送 json 优化
原始 HPSocket 封装, 持续稳定运行
:::

::: note 快速入门
启动插件后, 点击设置, 打开配置文件, 修改默认配置后, 重载插件/重启服务即可, 一般来说就重载插件就行
:::

::: tip 常用字段说明
userId: qq 号
botId: 机器人 qq 号
groupId: 群号
messageId: 消息唯一id, 用于撤回消息等操作, 来源于 req 等参数, 在提供 http 服务中抹去复杂参数, 抽象成 messageId, 使接口更加规范
file/image: 文件/图像, 一般此类参数均支持 base64, 服务器本地文件, url, 值要在前面指定协议, 如: base64的协议为 base64//, 服务器本地文件协议为 file:///, url协议为 http:// 或 https://
token: 令牌, 常用于处理好友/群申请的
:::

::: highlight blue 📌
如需定制化, 下载群里源码, 构建属于自己自己分支版本, 由于 qy 接口太多了, 精力不足以支撑维护所有接口, 但常用接口已封装完成, 作者开发此插件开源且不赚取一分钱, 本身自己也不用 qy, 还请谅解
:::

::: tip token 鉴权说明
开启此功能, 可以保证提供的接口需要鉴权才能被调用
如设置 token=yoyo
调用http-api时: 在header中填写X-Token: yoyo
连接websocket时: ws://ip:port/event?token=yoyo
:::

#监听端口, 除80外, 建议 2000 以上
port=80

#监听地址, 不知道怎么用, 请不要修改
address=0.0.0.0

#http推送地址url, 多个用英文逗号分割, 会以 JSON 的格式推送到指定 URL
webhooks=http://localhost:8080

#字符编码
characterEncoding=utf-8

#身份认证令牌
token=

#启用websocket
enableWebsocket=true

#推送时会携带的header, 英文逗号分割
headers=X-Service: qy-http-service,Content-Type: application/json

#手动指定外网ip, 为空会自动获取, 不用管这个
ip=

#打印请求信息
log.print.request=true