# vocechat-tools

**Repository Path**: cyqand/vocechat-tools

## Basic Information

- **Project Name**: vocechat-tools
- **Description**: 推送vocechat的消息到ntfy，并存储消息。
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-02
- **Last Updated**: 2024-04-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vocechat工具

只需要配置基本信息，存储vocechat机器人接收到的消息和推送消息到ntfy。

## 背景

1. 无法使用vocechat的推送服务，本应用对接vocechat使用ntfy进行vocechat消息的推送。 
2. 想要用自己的格式记录与重要人的聊天记录。

## 安装

环境如下：

```
python 3.10
```

## 使用

1. 如果需要存储消息功能，先在mysql中新建一个表格。具体创建代码见根目录下 `/doc/create_table.sql` 。
2. 配置vocechat的机器人：在vocechat中新建一个机器人，地址指向本服务的网址，例如： `http://127.0.0.1:10200`，另外新建一个api-key。
3. 配置config.json的内容：
   - vocechat: 将vocechat的网址和机器人的api-key复制到该配置中。
   - ntfy: 设置ntfy的地址，消息优先级，消息topic前缀（后面ntfy订阅时用到）。
   - mysql: 存储消息，如果不需要存储消息，请将storage设置为false，后面为mysql基本配置，自行设置即可。
4. 运行该项目。
5. 单独对机器人发送 `ntfy` 或者 `id` 即可查看id，并根据提示在ntfy中订阅消息topic。
6. 可以将机器人加入想要推送消息或者记录的群聊后，在群内发送消息测试是否能接收成功。单独发送消息到机器人也可接收到消息。

## API

运行服务后请将vocechat的机器人指向本服务的 `ip:10200/` 路径，进行消息的处理。