CoolQ HTTP API 教程

CoolQ HTTP API 教程

coolq-http-api项目地址:https://gitcode.com/gh_mirrors/coo/coolq-http-api

1. 项目介绍

CoolQ HTTP API 是一个由 RichardChien 开发的开源插件，旨在为 酷Q 提供通过 HTTP 或 WebSocket 接口进行事件上报和API调用的能力。这样一来，开发者就可以使用各种编程语言来编写QQ机器人的扩展程序，而不再局限于酷Q本身提供的DLL接口。此项目支持Windows 7及更高版本的操作系统，以及Wine和Docker环境。

2. 项目快速启动

安装酷Q

首先，你需要下载并安装酷Q应用程序。确保你的系统满足最低要求，然后从官方网站获取最新版本的酷Q。

安装 CoolQ HTTP API 插件

1. 克隆项目：

   git clone https://github.com/richardchien/coolq-http-api.git
   

2. 构建插件：

   cd coolq-http-api/src
   mkdir build && cd build
   cmake ..
   make
   

3. 配置酷Q： 将编译得到的 release\cqhttp.dll 文件复制到酷Q的 \plugins 目录下。

4. 设置插件： 打开酷Q，进入插件管理界面，启用刚刚添加的 cqhttp.dll 并进行相关配置。

启动酷Q及插件

1. 启动酷Q应用程序。
2. 在酷Q的日志中查看插件的运行状态和监听端口信息。

编写第一个测试脚本

创建一个简单的HTTP客户端，例如Python的requests库，向插件的 /send_private_msg 接口发送消息：

import requests

data = {
    "user": "目标QQ号",
    "message": "Hello, World!"
}

response = requests.post("http://localhost:5700/send_private_msg", json=data)
print(response.json())

确保替换目标QQ号，运行脚本，酷Q应该会在对应QQ上收到私聊消息。

3. 应用案例和最佳实践

• 自动回复: 设计一个基于关键字的自动回复机器人，当接收到特定信息时自动回应。
• 定时任务: 利用定时任务发送天气预报或新闻摘要到指定QQ群。
• 消息过滤: 设置规则，拦截和阻止广告、恶意链接或其他不良内容的传播。
• 命令行控制: 创建命令接口，允许通过命令行远程控制QQ机器人。

4. 典型生态项目

• nonebot/nonebot: Python的异步Web框架Quart基础上的QQ机器人框架，提供反向WebSocket通信。
• nonebot/aiocqhttp: 基于asyncio的CQHTTP SDK，适用于Python的酷Q插件开发。
• momocow/node-cq-websocket: 用于Node.js的CQHTTP WebSocket客户端库。
• koishijs/koishi: 基于Node.js的多平台聊天机器人框架，支持CQHTTP插件。

以上内容仅是快速入门和一些基础示例，更详细的文档和高级特性请参考官方文档。

---

请注意，随着酷Q即将停止服务，此项目可能不再接受新的更新或维护。考虑使用其他替代方案，或参与维护社区中的现有SDK和框架。

coolq-http-api项目地址:https://gitcode.com/gh_mirrors/coo/coolq-http-api