Skip to content

Commit

Permalink
docs: 整理目录
Browse files Browse the repository at this point in the history
  • Loading branch information
linyuchen committed Mar 24, 2024
1 parent 457c05c commit 3bab50e
Show file tree
Hide file tree
Showing 5 changed files with 150 additions and 151 deletions.
3 changes: 3 additions & 0 deletions docs/.vitepress/zh-CN.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ function sidebarDevelop() {
collapsed: false,
items: [
{ text: 'Api List', link: 'develop/api', activeMatch: '/zh-CN/develop/' },
{ text: '上报事件', link: 'develop/event', activeMatch: '/zh-CN/develop/event' },
{ text: '消息类型', link: 'develop/msg', activeMatch: '/zh-CN/develop/msg' },
{ text: '扩展api', link: 'develop/extends_api', activeMatch: '/zh-CN/develop/extends_api' },
]
}
];
Expand Down
153 changes: 2 additions & 151 deletions docs/zh-CN/develop/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,154 +67,5 @@
| send_private_forward_msg ||
| send_group_forward_msg ||
| upload_group_file ||
:::

## 消息格式支持情况
::: details 点击展开
| 消息格式 ||| 备注 |
| ------------- |:--:|:--:| :--:|
| cq码 ||| |
| 文字 ||| |
| 表情 ||| |
| 商城表情 ||| |
| 图片 ||| |
| 引用消息 ||| |
| @群成员 ||| |
| 语音||| 支持mp3、wav等多种音频格式直接发送|
| json消息 ||| 发送需要自行签名token |
| 转发消息记录 ||| **不能伪造,需要先发给自己再转发出去,不建议发送大量节点,有封号风险** |
| 视频 ||| |
| 文件 ||| 发送时可以指定`name`参数自定义文件名,详见本页下方的特殊说明 |
| 音乐卡片 ||| 实现有难度,遥遥无期 |
| 红包 ||| 没有计划支持|
| xml ||| 没有计划支持 |
:::

## 上报事件支持情况
::: details 点击展开
| 事件类型 | 可用 | 备注 |
| ------- |:--:|:--:|
| 消息 || |
| 好友消息撤回 || |
| 群消息撤回 || |
| 好友请求 || |
| 邀请加群请求 || |
| 加群请求 || 需要管理员权限 |
| 管理变动 || 需要管理员权限 |
| 群成员增加 || |
| 群成员减少 || |
| 群文件上传 || |
| 群禁言 || |
| 群成员名片变更 || |
| 群成员头衔变更 || |
| 群内戳一戳 || 暂时只支持 Windows 版本的LLOneBot, 残缺状态,识别不了谁戳的,戳的谁 |
| 好友戳一戳 || 暂时只支持 Windows 版本的LLOneBot |
| 群红包运气王 || |
| 群成员荣誉变更 || |
| 生命周期 || 目前只有 ws 的 connect |
| ws心跳 || |
:::

### 扩展api

::: details 发送文件名自定义
发送文件时支持参数 `name` 用于自定义显示的文件名
```json
{
"type": "file",
"data": {
"file": "file:///D:/1.txt",
"name": "自定义显示的文件名.txt"
}
}
```
:::

::: details 发送图片支持自定义图片预览文字
`/send_group_msg`

```json5
{
"group_id": 123456,
"message": [
{
"type": "image",
"data": {
"file": "file://D:/1.jpg",
"summary": "喵喵喵" // LLOneBot的扩展字段:图片预览文字
}
}
]
}
```
:::

::: details 设置头像api
`/set_qq_avatar`
```json5
{
"file": "file://D:/1.jpg" // 支持http://, base64://
}
```
:::

::: details 获取已过滤的加群通知

`/get_group_ignore_add_request`

return

```json5
{
"status": "ok",
"retcode": 0,
"data": [
{
"group_id": 123122,
"user_id": 123123,
"flag": "1710117534729787"
}
],
"message": "",
"wording": "",
}
```
:::

::: details message_sent 事件的 target_id
相比于 go-cq 多了个 `target_id` 字段表示发送的目标QQ号或者群号
:::

::: details 下载收到的群文件或私聊文件

`/get_file`

```json5
{
"file_id": "/xxxxx-xxxxx"
}
```

return

```json5
{
"status": "ok",
"retcode": 0,
"data": {
"file": "d:/xxxx", // 文件的绝对路径
"file_name": "文件名",
"file_size": 123123,
"base64": "/9j/4AAQSkZJRgABAQEASxxxx", // 文件的 base64 编码, 需要在 LLOneBot 的配置文件中开启 base64
},
"message": "",
"wording": "",
}
```
:::

::: details /download_file
与 gocq 用法一样,但是支持 base64 参数用于直接下载 base64 编码的文件

::: tip 此 api 不适用于下载群文件或者私聊文件
:::
| download_file ||
:::
23 changes: 23 additions & 0 deletions docs/zh-CN/develop/event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## 上报事件支持情况

| 事件类型 | 可用 | 备注 |
| ------- |:--:|:--:|
| 消息 || |
| 好友消息撤回 || |
| 群消息撤回 || |
| 好友请求 || |
| 邀请加群请求 || |
| 加群请求 || 需要管理员权限 |
| 管理变动 || 需要管理员权限 |
| 群成员增加 || |
| 群成员减少 || |
| 群文件上传 || |
| 群禁言 || |
| 群成员名片变更 || |
| 群成员头衔变更 || |
| 群内戳一戳 || 暂时只支持 Windows 版本的LLOneBot, 残缺状态,识别不了谁戳的,戳的谁 |
| 好友戳一戳 || 暂时只支持 Windows 版本的LLOneBot |
| 群红包运气王 || |
| 群成员荣誉变更 || |
| 生命周期 || 目前只有 ws 的 connect |
| ws心跳 || |
104 changes: 104 additions & 0 deletions docs/zh-CN/develop/extends_api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@

### 扩展api

::: details 发送文件名自定义
发送文件时支持参数 `name` 用于自定义显示的文件名
```json
{
"type": "file",
"data": {
"file": "file:///D:/1.txt",
"name": "自定义显示的文件名.txt"
}
}
```
:::

::: details 发送图片支持自定义图片预览文字
`/send_group_msg`

```json5
{
"group_id": 123456,
"message": [
{
"type": "image",
"data": {
"file": "file://D:/1.jpg",
"summary": "喵喵喵" // LLOneBot的扩展字段:图片预览文字
}
}
]
}
```
:::

::: details 设置头像api
`/set_qq_avatar`
```json5
{
"file": "file://D:/1.jpg" // 支持http://, base64://
}
```
:::

::: details 获取已过滤的加群通知

`/get_group_ignore_add_request`

return

```json5
{
"status": "ok",
"retcode": 0,
"data": [
{
"group_id": 123122,
"user_id": 123123,
"flag": "1710117534729787"
}
],
"message": "",
"wording": "",
}
```
:::

::: details message_sent 事件的 target_id
相比于 go-cq 多了个 `target_id` 字段表示发送的目标QQ号或者群号
:::

::: details 下载收到的群文件或私聊文件

`/get_file`

```json5
{
"file_id": "/xxxxx-xxxxx"
}
```

return

```json5
{
"status": "ok",
"retcode": 0,
"data": {
"file": "d:/xxxx", // 文件的绝对路径
"file_name": "文件名",
"file_size": 123123,
"base64": "/9j/4AAQSkZJRgABAQEASxxxx", // 文件的 base64 编码, 需要在 LLOneBot 的配置文件中开启 base64
},
"message": "",
"wording": "",
}
```
:::

::: details /download_file
与 gocq 用法一样,但是支持 base64 参数用于直接下载 base64 编码的文件

::: tip 此 api 不适用于下载群文件或者私聊文件
:::
18 changes: 18 additions & 0 deletions docs/zh-CN/develop/msg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## 消息格式支持情况
| 消息格式 ||| 备注 |
| ------------- |:--:|:--:| :--:|
| cq码 ||| |
| 文字 ||| |
| 表情 ||| |
| 商城表情 ||| {type: "mface", data: {text: "[表情文字描述]"}} |
| 图片 ||| |
| 引用消息 ||| |
| @群成员 ||| |
| 语音||| 支持mp3、wav等多种音频格式直接发送|
| json消息 ||| 发送需要自行签名token |
| 转发消息记录 ||| **不能伪造,需要先发给自己再转发出去,不建议发送大量节点,有封号风险** |
| 视频 ||| |
| 文件 ||| 发送时可以指定`name`参数自定义文件名,详见本页下方的特殊说明 |
| 音乐卡片 ||| 实现有难度,遥遥无期 |
| 红包 ||| 没有计划支持|
| xml ||| 没有计划支持 |

0 comments on commit 3bab50e

Please sign in to comment.