XYBotV2-core/readme.md
李寻欢 21d0618b80
All checks were successful
BuildImage / build-image (push) Successful in 1m4s
更新 readme.md
2025-02-17 15:07:58 +08:00

39 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# `侵删`
### 我是谁
从[XYBotV2](https://github.com/HenryXiaoYang/XYBotV2)抽离出来的协议程序仅包含iPad协议不含任何业务逻辑所以业务逻辑需要自行开发。
### 如何使用
```yaml
services:
XYBotV2:
container_name: xybot
image: lxh01/xybotv2:latest
restart: unless-stopped
ports:
- "9000:9000"
volumes:
- ./data:/var/lib/redis # 登录缓存数据
```
运行起来之后,直接浏览器打开`http://{your_ip}:9000`就可以看到接口文档了。
### 登录流程
```mermaid
graph TB
A[GetQRCode【首次登录】<br/>AwakenLogin【已经登录过重新登录】] --> B[CheckUuid]
B --> C{返回用户信息?}
C -- 否 --> B
C -- 是 --> D[AutoHeartbeatStart]
D --> E[Sync]
```
如果是首次登录,需要调用`GetQRCode`接口获取二维码扫码,如果已经登录过,可以直接调用`AwakenLogin`接口。
获取二维码接口,如果不需要设置代理,相关参数可以直接不传。
`CheckUuid`接口用于检查是否已经扫码,如果已经扫码,会返回用户信息。
`AutoHeartbeatStart`接口用于开启自动心跳,如果不喜欢,也可以手动轮询`/Heartbeat`接口。
`Sync`接口用于同步消息,需要一直轮询,如果账号已退出,该接口也会有返回`Error用户可能退出`
### 更新日志
版本 | 日志
---|---
20250217 | fix: 发送视频报错,视频消息不应该堵塞。