diff --git a/readme.md b/readme.md index 1bcff60..7cecd88 100644 --- a/readme.md +++ b/readme.md @@ -20,7 +20,22 @@ services: ``` 运行起来之后,直接浏览器打开`http://{your_ip}:9000`就可以看到接口文档了。 +### 登录流程 +```mermaid +graph TB + A[GetQRCode【首次登录】
AwakenLogin【已经登录过,重新登录】] --> B[CheckUuid] + B --> C{返回用户信息?} + C -- 否 --> B + C -- 是 --> D[AutoHeartbeatStart] + D --> E[Sync] +``` +如果是首次登录,需要调用`GetQRCode`接口获取二维码扫码,如果已经登录过,可以直接调用`AwakenLogin`接口。 +获取二维码接口,如果不需要设置代理,相关参数可以直接不传。 +`CheckUuid`接口用于检查是否已经扫码,如果已经扫码,会返回用户信息。 +`AutoHeartbeatStart`接口用于开启自动心跳,如果不喜欢,也可以手动轮询`/Heartbeat`接口。 +`Sync`接口用于同步消息,需要一直轮询,如果账号已退出,该接口也会有返回`Error:用户可能退出`。 + ### 更新日志 版本 | 日志 ---|--- -20250217 | fix: 发送视频报错,视频消息不应该堵塞。 \ No newline at end of file +20250217 | fix: 发送视频报错,视频消息不应该堵塞。