Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
linyuchen committed Nov 18, 2024
2 parents 5290496 + 8b5d4e7 commit 3312bf0
Show file tree
Hide file tree
Showing 11 changed files with 228 additions and 116 deletions.
18 changes: 14 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
node_modules
docs/.vitepress/cache
docs/.vitepress/dist
.yarn
package-lock.json
node_modules/*
docs/.vitepress/cache/*
docs/.vitepress/dist/*
.vscode/*
yarn.lock

.eslintcache
.DS_Store
.idea
.vscode
*.suo
*.ntvs*
*.njsproj
*.sln
1 change: 1 addition & 0 deletions .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
nodeLinker: node-modules
2 changes: 2 additions & 0 deletions docs/.vitepress/zh-CN.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ function sidebarGuide() {
items: [
{ text: '快速开始', link: 'guide/getting-started', activeMatch: '/zh-CN/guide/' },
{ text: '对接配置', link: 'guide/configuration', activeMatch: '/zh-CN/guide/' },
{ text: '开发对接', link: 'develop/quick-start', activeMatch: '/zh-CN/develop/quick-start' },
{ text: 'API 示例', link: 'develop/api', activeMatch: '/zh-CN/develop/api' },
{ text: '常见问题', link: 'guide/faq', activeMatch: '/zh-CN/guide/' },
{ text: '从零安装 NoneBot2', link: 'guide/nonebot2', activeMatch: '/zh-CN/guide/' }
]
Expand Down
161 changes: 104 additions & 57 deletions docs/zh-CN/develop/api.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# API 列表

## API 详细说明
LLOneBot 实现了 OneBot 11 以及 go-cqhttp 的大部分 API

[onebot v11](https://11.onebot.dev/)

[go-cqhttp](https://docs.go-cqhttp.org/api)
接口详细示例: [点击跳转](https://api.napneko.com)

## 连接方式支持情况
| 连接方式 |可用|
Expand All @@ -15,64 +13,113 @@
| 正向 WS 连接 ||
| 反向 WS 连接 ||

## API 支持情况

### OneBot 11

## API 支持情况
::: details OneBot 11
| 功能 | API |可用| 备注 |
| --- | ------------- |:--:| -------------- |
::: tip
详细用法参阅 [OneBot 11 文档](https://github.com/botuniverse/onebot-11/blob/master/api/public.md)
:::

| 功能 | API | 可用 | 备注 |
|------------| ------------- |:-:| -------------- |
| 获取 bot 账号信息 | get_login_info || |
| 发送消息 | send_msg ||
| 发送群聊消息 | send_group_msg ||
| 发送好友消息 | send_private_msg || 不支持临时消息 |
| 获取消息详情 | get_msg ||
| 撤回消息 | delete_msg ||
| 点赞 | send_like || 支持给群员点赞 |
| 获取好友列表 | get_friend_list ||
| 处理好友请求 | set_friend_add_request ||
| 获取群列表 | get_group_list ||
| 获取群信息 | get_group_info ||
| 获取群成员列表 | get_group_member_list ||
| 获取群成员信息 | get_group_member_info ||
| 获取群荣誉信息 | get_group_honor_info ||
| 设置群组专属头衔 | set_group_special_title | |
| 群匿名禁言 | set_group_anonymous_ban ||
| 开关群匿名 | set_group_anonymous ||
| 处理加群请求 | set_group_add_request ||
| 退群 | set_group_leave ||
| 群踢人 | set_group_kick ||
| 群禁言 | set_group_ban ||
| 全群禁言 | set_group_whole_ban ||
| 设置管理员 | set_group_admin ||
| 设置群名片 | set_group_card ||
| 设置群名 | set_group_name ||
| 获取陌生人信息 | get_stranger_info || |
| 获取版本信息 | get_version_info ||
| 获取状态 | get_status ||
| 检查能否发送图片 | can_send_image ||
| 检查能否发送语音 | can_send_record ||
| 获取图片详情 | get_image ||
| 获取语音文件 | get_record ||
| 获取文件详情 | get_file ||
| 发送消息 | send_msg ||
| 发送群聊消息 | send_group_msg ||
| 发送好友消息 | send_private_msg || 不支持主动临时消息 |
| 获取消息详情 | get_msg ||
| 撤回消息 | delete_msg ||
| 发送好友赞 | send_like || |
| 获取好友列表 | get_friend_list ||
| 处理好友请求 | set_friend_add_request ||
| 获取群列表 | get_group_list ||
| 获取群信息 | get_group_info ||
| 获取群成员列表 | get_group_member_list ||
| 获取群成员信息 | get_group_member_info ||
| 获取群荣誉信息 | get_group_honor_info ||
| 设置群组专属头衔 | set_group_special_title | |
| 群匿名禁言 | set_group_anonymous_ban ||
| 开关群匿名 | set_group_anonymous ||
| 处理加群请求 | set_group_add_request ||
| 退群 | set_group_leave ||
| 群踢人 | set_group_kick ||
| 群禁言 | set_group_ban ||
| 全群禁言 | set_group_whole_ban ||
| 设置管理员 | set_group_admin ||
| 设置群名片 | set_group_card ||
| 设置群名 | set_group_name ||
| 获取陌生人信息 | get_stranger_info || |
| 获取版本信息 | get_version_info ||
| 获取状态 | get_status ||
| 检查能否发送图片 | can_send_image ||
| 检查能否发送语音 | can_send_record ||
| 获取图片详情 | get_image ||
| 获取语音文件 | get_record ||
| 获取文件详情 | get_file ||
| 获取 Cookies | get_cookies ||
| 获取 CSRF Token | get_csrf_token ||
| 获取 QQ 相关接口凭证 | get_credentials ||
| 重启 OneBot 实现 | set_restart ||
| 清理缓存 | clean_cache ||
:::
| 重启 | set_restart ||
| 清理缓存 | clean_cache ||

### Go-CQHTTP

::: details Go-CQHTTP
| API |可用|
| ------------- |:--:|
| send_forward_msg ||
| send_private_forward_msg ||
| send_group_forward_msg ||
| get_group_msg_history ||
| get_forward_msg ||
| upload_group_file ||
| upload_private_file ||
| download_file ||
| set_essence_msg ||
| delete_essence_msg ||
| delete_group_file ||
::: tip
详细用法参阅 [go-cqhttp 文档](https://docs.go-cqhttp.org/api/)
:::

| 功能 | API |可用|
| --- | ------------- |:--:|
| 发送合并转发 ( 好友 ) | send_private_forward_msg ||
| 发送合并转发 ( 群聊 ) | send_group_forward_msg ||
| 获取群消息历史记录 | get_group_msg_history ||
| 获取合并转发内容 | get_forward_msg ||
| 上传群文件 | upload_group_file ||
| 上传私聊文件 | upload_private_file ||
| 下载文件到缓存目录 | download_file ||
| 设置精华消息 | set_essence_msg ||
| 移出精华消息 | delete_essence_msg ||
| 删除群文件 | delete_group_file ||
| 创建群文件文件夹 | create_group_file_folder ||
| 删除群文件文件夹 | delete_group_folder ||
| 获取群系统消息 | get_group_system_msg ||
| 获取群 @全体成员 剩余次数 | get_group_at_all_remain ||
| 获取群根目录文件列表 | get_group_root_files ||
| 发送群公告 | _send_group_notice ||
| 标记消息已读 | mark_msg_as_read ||
| 获取群子目录文件列表 | get_group_files_by_folder ||
| 获取精华消息列表 | get_essence_msg_list ||
| 获取群文件资源链接 | get_group_file_url ||
| 获取群公告 | _get_group_notice ||
| 删除好友 | delete_friend ||
| 图片 OCR | ocr_image ||
| 获取群文件系统信息 | get_group_file_system_info ||

### LLOneBot

::: tip
详细用法参阅 <https://api.napneko.com>
:::

| 功能 | API |可用|
|----------------|------------------------------|:--:|
| 设置头像 | set_qq_avatar ||
| 获取文件信息 | get_file ||
| 获取已过滤的加群通知 | get_group_ignore_add_request ||
| 转发单条信息到私聊 | forward_friend_single_msg ||
| 转发单条信息到群聊 | forward_group_single_msg ||
| 设置消息的表情回应 | set_msg_emoji_like ||
| 获取好友分类列表 | get_friends_with_category ||
| 设置自身在线状态 | set_online_status ||
| 获取自身点赞列表 | get_profile_like ||
| 发送合并转发消息 | send_forward_msg ||
| 获取收藏表情 | fetch_custom_face ||
| 获取好友历史消息记录 | get_friend_msg_history ||
| 获取表情回应列表 | fetch_emoji_like ||
| 获取官方机器人 QQ 号区间 | get_robot_uin_range ||
| 好友戳一戳 | friend_poke ||
| 群组戳一戳 | group_poke ||
| 设置好友备注 | set_friend_remark ||
| 移动好友到分组 | set_friend_category ||
| 设置群备注 | set_group_remark ||
| 设置群消息接收方式 | set_group_msg_mask ||
81 changes: 66 additions & 15 deletions docs/zh-CN/develop/extends_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,15 @@
```
:::

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

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

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

return

Expand All @@ -68,9 +65,7 @@ return
相比于 go-cq 多了个 `target_id` 字段表示发送的目标QQ号或者群号
:::

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

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

```json5
{
Expand All @@ -96,13 +91,14 @@ return
```
:::

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

`/download_file`

::: tip 此 api 不适用于下载群文件或者私聊文件
:::

::: details 转发单条消息到好友 /forward_friend_single_msg
::: details 转发单条消息到好友 `/forward_friend_single_msg`

```json5
{
Expand All @@ -113,7 +109,7 @@ return
:::


::: details 转发单条消息到群 /forward_group_single_msg
::: details 转发单条消息到群 `/forward_group_single_msg`

```json5
{
Expand All @@ -123,7 +119,7 @@ return
```
:::

::: details 发送表情回应 /set_msg_emoji_like
::: details 发送表情回应 `/set_msg_emoji_like`
```json5
{
"message_id": "-2147480026",
Expand All @@ -133,7 +129,7 @@ return
emoji_id 参考 <https://bot.q.qq.com/wiki/develop/api-v2/openapi/emoji/model.html#EmojiType>
:::

::: details 获取带分组信息好友列表 /get_friends_with_category
::: details 获取带分组信息好友列表 `/get_friends_with_category`

return:
```json5
Expand Down Expand Up @@ -189,4 +185,59 @@ return:
]
}
```
:::
:::

::: details 设置自身在线状态 `/set_online_status`

在线:
```json
{ "status": 10, "ext_status": 0, "battery_status": 0 }
```
离开:
```json
{ "status": 30, "ext_status": 0, "battery_status": 0 }
```
隐身:
```json
{ "status": 40, "ext_status": 0, "battery_status": 0 }
```
忙碌:
```json
{ "status": 50, "ext_status": 0, "battery_status": 0 }
```
Q我吧:
```json
{ "status": 60, "ext_status": 0, "battery_status": 0 }
```
请勿打扰:
```json
{ "status": 70, "ext_status": 0, "battery_status": 0 }
```
:::

::: details 获取自身点赞列表 `/get_profile_like`

请求时无需参数

:::

::: details 好友戳一戳 `/friend_poke`

```json
{
"user_id": 123456
}
```

:::

::: details 群组戳一戳 `/group_poke`

```json
{
"group_id": 123456,
"user_id": 123456
}
```

:::
38 changes: 21 additions & 17 deletions docs/zh-CN/develop/msg.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,28 @@
<https://docs.go-cqhttp.org/cqcode>

## 消息格式支持情况
| 消息格式 ||| 备注 |
|----------|:-:|:-:|:----------------------------------------------------:|
| cq码 ||| |
| 文字 ||| |
| 表情 ||| |
| 商城表情 ||| 见下方详细说明 |
| markdown ||| {type: "markdown", data: {data: "`**markdown内容**`"}} |
| 图片 ||| |
| 引用消息 ||| |
| 消息格式 ||| 备注 |
|-------------|:-:|:-:|:----------------------------------------------------:|
| cq码 ||| |
| 文字 ||| |
| 表情 ||| |
| 商城表情 ||| 见下方详细说明 |
| markdown ||| {type: "markdown", data: {content: "`**markdown内容**`"}} |
| 图片 ||| |
| 引用消息 ||| |
| @群成员 ||| |
| 语音 ||| 支持mp3、wav等多种音频格式直接发送 |
| json消息 ||| 发送需要自行签名token |
| 转发消息记录 ||| **伪造的消息会以 Bot 身份显示** |
| 视频 ||| |
| 文件 ||| 发送时可以指定`name`参数自定义文件名,详见扩展api |
| 音乐卡片 ||| 需要在设置中填写音卡签名地址,地址在 QQ 群,不保证长久可用 |
| 红包 ||| 没有计划支持 |
| xml ||| 没有计划支持 |
| 语音 ||| 支持 mp3、wav 等多种音频格式直接发送 |
| json消息 ||| 发送需要自行签名 token |
| 转发消息记录 ||| 伪造的消息会以 Bot 身份显示 |
| 视频 ||| |
| 文件 ||| 发送时可以指定`name`参数自定义文件名,详见扩展 API |
| 音乐卡片 ||| 需要在设置中填写音卡签名地址,地址在 QQ 群,不保证长久可用 |
| 猜拳 ||| |
| 掷骰子 ||| |
| 窗口抖动 ||| |
| 推荐好友/群 ||| |
| 红包 ||| 没有计划支持 |
| xml ||| 没有计划支持 |

### 商城表情
```json5
Expand Down
Loading

0 comments on commit 3312bf0

Please sign in to comment.