shkong/go-cqhttp
1
0
Fork 0
mirror of https://github.com/Mrs4s/go-cqhttp.git synced 2025-05-04 19:17:37 +08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Ink-33 2020-11-17 00:13:14 +08:00
parent 8900839018
commit 990e7744a3
No known key found for this signature in database
GPG Key ID: 5D8B1D036EFB0D2E
6 changed files with 345 additions and 344 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -47,32 +47,33 @@
##### 注意: 部分API实现与CQHTTP原版略有差异，请参考文档 ##### 注意: 部分API实现与CQHTTP原版略有差异，请参考文档
| API | 功能 | | API | 功能 |
| ------------------------ | ------------------------------------------------------------ | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| /get_login_info | [获取登录号信息](https://cqhttp.cc/docs/4.15/#/API?id=get_login_info-获取登录号信息) | | /get_login_info | [获取登录号信息](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#get_login_info-%E8%8E%B7%E5%8F%96%E7%99%BB%E5%BD%95%E5%8F%B7%E4%BF%A1%E6%81%AF) |
| /get_friend_list | [获取好友列表](https://cqhttp.cc/docs/4.15/#/API?id=get_friend_list-获取好友列表) | | /get_friend_list | [获取好友列表](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#get_friend_list-%E8%8E%B7%E5%8F%96%E5%A5%BD%E5%8F%8B%E5%88%97%E8%A1%A8) |
| /get_group_list | [获取群列表](https://cqhttp.cc/docs/4.15/#/API?id=get_group_list-获取群列表) | | /get_group_list | [获取群列表](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#get_group_list-%E8%8E%B7%E5%8F%96%E7%BE%A4%E5%88%97%E8%A1%A8) |
| /get_group_info | [获取群信息](https://cqhttp.cc/docs/4.15/#/API?id=get_group_info-获取群信息) | | /get_group_info | [获取群信息](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#get_group_info-%E8%8E%B7%E5%8F%96%E7%BE%A4%E4%BF%A1%E6%81%AF) |
| /get_group_member_list | [获取群成员列表](https://cqhttp.cc/docs/4.15/#/API?id=get_group_member_list-获取群成员列表) | | /get_group_member_list | [获取群成员列表](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#get_group_member_list-%E8%8E%B7%E5%8F%96%E7%BE%A4%E6%88%90%E5%91%98%E5%88%97%E8%A1%A8) |
| /get_group_member_info | [获取群成员信息](https://cqhttp.cc/docs/4.15/#/API?id=get_group_member_info-获取群成员信息) | | /get_group_member_info | [获取群成员信息](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#get_group_member_info-%E8%8E%B7%E5%8F%96%E7%BE%A4%E6%88%90%E5%91%98%E4%BF%A1%E6%81%AF) |
| /send_msg | [发送消息](https://cqhttp.cc/docs/4.15/#/API?id=send_msg-发送消息) | | /send_msg | [发送消息](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#send_msg-%E5%8F%91%E9%80%81%E6%B6%88%E6%81%AF) |
| /send_group_msg | [发送群消息](https://cqhttp.cc/docs/4.15/#/API?id=send_group_msg-发送群消息) | | /send_group_msg | [发送群消息](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#send_group_msg-%E5%8F%91%E9%80%81%E7%BE%A4%E6%B6%88%E6%81%AF) |
| /send_private_msg | [发送私聊消息](https://cqhttp.cc/docs/4.15/#/API?id=send_private_msg-发送私聊消息) | | /send_private_msg | [发送私聊消息](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#send_private_msg-%E5%8F%91%E9%80%81%E7%A7%81%E8%81%8A%E6%B6%88%E6%81%AF) |
| /delete_msg | [撤回信息](https://cqhttp.cc/docs/4.15/#/API?id=delete_msg-撤回消息) | | /delete_msg | [撤回信息](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#delete_msg-%E6%92%A4%E5%9B%9E%E6%B6%88%E6%81%AF) |
| /set_friend_add_request | [处理加好友请求](https://cqhttp.cc/docs/4.15/#/API?id=set_friend_add_request-处理加好友请求) | | /set_friend_add_request | [处理加好友请求](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#set_friend_add_request-%E5%A4%84%E7%90%86%E5%8A%A0%E5%A5%BD%E5%8F%8B%E8%AF%B7%E6%B1%82) |
| /set_group_add_request | [处理加群请求/邀请](https://cqhttp.cc/docs/4.15/#/API?id=set_group_add_request-处理加群请求／邀请) | | /set_group_add_request | [处理加群请求/邀请](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#set_group_add_request-%E5%A4%84%E7%90%86%E5%8A%A0%E7%BE%A4%E8%AF%B7%E6%B1%82%E9%82%80%E8%AF%B7) |
| /set_group_card | [设置群名片(群备注)](https://cqhttp.cc/docs/4.15/#/API?id=set_group_card-设置群名片（群备注）) | | /set_group_card | [设置群名片(群备注)](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#set_group_card-%E8%AE%BE%E7%BD%AE%E7%BE%A4%E5%90%8D%E7%89%87%E7%BE%A4%E5%A4%87%E6%B3%A8) |
| /set_group_special_title | [设置群组专属头衔](https://cqhttp.cc/docs/4.15/#/API?id=set_group_special_title-设置群组专属头衔) | | /set_group_special_title | [设置群组专属头衔](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#set_group_special_title-%E8%AE%BE%E7%BD%AE%E7%BE%A4%E7%BB%84%E4%B8%93%E5%B1%9E%E5%A4%B4%E8%A1%94) |
| /set_group_kick | [群组T人](https://cqhttp.cc/docs/4.15/#/API?id=set_group_kick-群组踢人) | | /set_group_kick | [群组T人](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#set_group_kick-%E7%BE%A4%E7%BB%84%E8%B8%A2%E4%BA%BA) |
| /set_group_ban | [群组单人禁言](https://cqhttp.cc/docs/4.15/#/API?id=set_group_ban-群组单人禁言) | | /set_group_ban | [群组单人禁言](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#set_group_ban-%E7%BE%A4%E7%BB%84%E5%8D%95%E4%BA%BA%E7%A6%81%E8%A8%80) |
| /set_group_whole_ban | [群组全员禁言](https://cqhttp.cc/docs/4.15/#/API?id=set_group_whole_ban-群组全员禁言) | | /set_group_whole_ban | [群组全员禁言](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#set_group_whole_ban-%E7%BE%A4%E7%BB%84%E5%85%A8%E5%91%98%E7%A6%81%E8%A8%80) |
| /set_group_leave | [退出群组](https://cqhttp.cc/docs/4.15/#/API?id=set_group_leave-退出群组) | | /set_group_leave | [退出群组](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#set_group_leave-%E9%80%80%E5%87%BA%E7%BE%A4%E7%BB%84) |
| /set_group_name | 设置群组名(拓展API) | | /set_group_name | [设置群组名](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#set_group_name-%E8%AE%BE%E7%BD%AE%E7%BE%A4%E5%90%8D) |
| /get_image | 获取图片信息(拓展API) | | /set_restart | [重启go-cqhttp](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#set_restart-%E9%87%8D%E5%90%AF-onebot-%E5%AE%9E%E7%8E%B0) |
| /get_msg | [获取消息]() | <!-- TODO 来人补个链接--> | /get_image | [获取图片信息](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#get_image-%E8%8E%B7%E5%8F%96%E5%9B%BE%E7%89%87) |
| /can_send_image | [检查是否可以发送图片](https://cqhttp.cc/docs/4.15/#/API?id=can_send_image-检查是否可以发送图片) | | /get_msg | [获取消息](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#get_msg-%E8%8E%B7%E5%8F%96%E6%B6%88%E6%81%AF) |
| /can_send_record | [检查是否可以发送语音](https://cqhttp.cc/docs/4.15/#/API?id=can_send_record-检查是否可以发送语音) | | /can_send_image | [检查是否可以发送图片](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#can_send_image-%E6%A3%80%E6%9F%A5%E6%98%AF%E5%90%A6%E5%8F%AF%E4%BB%A5%E5%8F%91%E9%80%81%E5%9B%BE%E7%89%87) |
| /get_status | [获取插件运行状态](https://cqhttp.cc/docs/4.15/#/API?id=get_status-获取插件运行状态) | | /can_send_record | [检查是否可以发送语音](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#can_send_record-%E6%A3%80%E6%9F%A5%E6%98%AF%E5%90%A6%E5%8F%AF%E4%BB%A5%E5%8F%91%E9%80%81%E8%AF%AD%E9%9F%B3) |
| /get_version_info | [获取 酷Q 及 CQHTTP插件的版本信息](https://cqhttp.cc/docs/4.15/#/API?id=get_version_info-获取-酷q-及-cqhttp-插件的版本信息) | | /get_status | [获取插件运行状态](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#get_status-%E8%8E%B7%E5%8F%96%E8%BF%90%E8%A1%8C%E7%8A%B6%E6%80%81) |
| /get_version_info | [获取 酷Q 及 CQHTTP插件的版本信息](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md#get_version_info-%E8%8E%B7%E5%8F%96%E7%89%88%E6%9C%AC%E4%BF%A1%E6%81%AF) |
</details> </details>
@ -81,19 +82,19 @@
##### 注意: 部分Event数据与CQHTTP原版略有差异，请参考文档 ##### 注意: 部分Event数据与CQHTTP原版略有差异，请参考文档
| Event | | Event |
| ------------------------------------------------------------ | | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| [私聊信息](https://cqhttp.cc/docs/4.15/#/Post?id=私聊消息) | | [私聊信息](https://github.com/howmanybots/onebot/blob/master/v11/specs/event/message.md#%E7%A7%81%E8%81%8A%E6%B6%88%E6%81%AF) |
| [群消息](https://cqhttp.cc/docs/4.15/#/Post?id=群消息) | | [群消息](https://github.com/howmanybots/onebot/blob/master/v11/specs/event/message.md#%E7%BE%A4%E6%B6%88%E6%81%AF) |
| [群消息撤回(拓展Event)](docs/cqhttp.md#群消息撤回) | | [群消息撤回(拓展Event)](docs/cqhttp.md#群消息撤回) |
| [好友消息撤回(拓展Event)](docs/cqhttp.md#好友消息撤回) | | [好友消息撤回(拓展Event)](docs/cqhttp.md#好友消息撤回) |
| [群内提示事件(拓展Event)(龙王等事件)](docs/cqhttp.md#群内戳一戳) | | [群内提示事件(拓展Event)(龙王等事件)](docs/cqhttp.md#群内戳一戳) |
| [群管理员变动](https://cqhttp.cc/docs/4.15/#/Post?id=群管理员变动) | | [群管理员变动](https://github.com/howmanybots/onebot/blob/master/v11/specs/event/notice.md#%E7%BE%A4%E7%AE%A1%E7%90%86%E5%91%98%E5%8F%98%E5%8A%A8) |
| [群成员减少](https://cqhttp.cc/docs/4.15/#/Post?id=群成员减少) | | [群成员减少](https://github.com/howmanybots/onebot/blob/master/v11/specs/event/notice.md#%E7%BE%A4%E6%88%90%E5%91%98%E5%87%8F%E5%B0%91) |
| [群成员增加](https://cqhttp.cc/docs/4.15/#/Post?id=群成员增加) | | [群成员增加](https://github.com/howmanybots/onebot/blob/master/v11/specs/event/notice.md#%E7%BE%A4%E6%88%90%E5%91%98%E5%A2%9E%E5%8A%A0) |
| [群禁言](https://cqhttp.cc/docs/4.15/#/Post?id=群禁言) | | [群禁言](https://github.com/howmanybots/onebot/blob/master/v11/specs/event/notice.md#%E7%BE%A4%E7%A6%81%E8%A8%80) |
| [群文件上传](https://cqhttp.cc/docs/4.15/#/Post?id=群文件上传) | | [群文件上传](https://github.com/howmanybots/onebot/blob/master/v11/specs/event/notice.md#%E7%BE%A4%E6%96%87%E4%BB%B6%E4%B8%8A%E4%BC%A0) |
| [加好友请求](https://cqhttp.cc/docs/4.15/#/Post?id=加好友请求) | | [加好友请求](https://github.com/howmanybots/onebot/blob/master/v11/specs/event/request.md#%E5%8A%A0%E5%A5%BD%E5%8F%8B%E8%AF%B7%E6%B1%82) |
| [加群请求/邀请](https://cqhttp.cc/docs/4.15/#/Post?id=加群请求／邀请) | | [加群请求/邀请](https://github.com/howmanybots/onebot/blob/master/v11/specs/event/request.md#%E5%8A%A0%E7%BE%A4%E8%AF%B7%E6%B1%82%E9%82%80%E8%AF%B7) |
</details> </details>

2
docs/EventFilter.md
View File

@ -111,7 +111,7 @@
下面列出所有运算符（「要求的参数类型」是指运算符的键所对应的值的类型，「可作用于的类型」是指在过滤时事件对象相应值的类型）： 下面列出所有运算符（「要求的参数类型」是指运算符的键所对应的值的类型，「可作用于的类型」是指在过滤时事件对象相应值的类型）：
| 运算符 | 要求的参数类型 | 可作用于的类型 | | 运算符 | 要求的参数类型 | 可作用于的类型 |
| ----- | ------------ | ----------- | | ----------- | -------------------------- | ----------------------------------------------------- |
| `.not` | object | 任何 | | `.not` | object | 任何 |
| `.and` | object | 若参数中全为运算符，则任何；若不全为运算符，则 object | | `.and` | object | 若参数中全为运算符，则任何；若不全为运算符，则 object |
| `.or` | array（数组元素为 object） | 任何 | | `.or` | array（数组元素为 object） | 任何 |

26
docs/adminApi.md
View File

@ -7,7 +7,7 @@
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- | | ------------ | ------ | --------------------------- |
| access_token | string | 校验口令，config.json中配置 | | access_token | string | 校验口令，config.json中配置 |
@ -25,7 +25,7 @@ method：`POST/GET`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ---- | ------------------------------------- | | ------ | ---- | ---- |
| 无 | | | | 无 | | |
返回： 返回：
@ -45,7 +45,7 @@ method: `GET`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- | | ------ | ---- | ---- |
| 无 | | | | 无 | | |
返回： 返回：
@ -54,7 +54,7 @@ method: `GET`
{"data": {"ispic": true,"picbase64":"xxxxx"}, "retcode": 0, "status": "ok"} {"data": {"ispic": true,"picbase64":"xxxxx"}, "retcode": 0, "status": "ok"}
``` ```
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- | | -------- | ------ | --------------------------------------------------- |
| ispic | bool | 是否是验证码类型 true是，false为不是（比如设备锁 | | ispic | bool | 是否是验证码类型 true是，false为不是（比如设备锁 |
| picbas64 | string | 验证码的base64编码内容，加上头，放入img标签即可显示 | | picbas64 | string | 验证码的base64编码内容，加上头，放入img标签即可显示 |
@ -68,7 +68,7 @@ method: `POST` formdata
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- | | ------ | ------ | ---------- |
| input | string | 输入的内容 | | input | string | 输入的内容 |
返回： 返回：
@ -90,7 +90,7 @@ method: `POST`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | -----------| | ------ | ---- | ---- |
| 无 | | | | 无 | | |
返回： 返回：
@ -109,7 +109,7 @@ method: `POST` formdata
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------------ | ------ | ------------------------------------- |
| uin | string | qq号 | | uin | string | qq号 |
| password | string | qq密码 | | password | string | qq密码 |
| enable_db | string | 是否启动数据库,填 'true' 或者 'false' | | enable_db | string | 是否启动数据库,填 'true' 或者 'false' |
@ -131,7 +131,7 @@ method: `POST` formdata
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ----------- | ------ | --------------------------------------------- |
| port | string | 服务端口 | | port | string | 服务端口 |
| host | string | 服务监听地址 | | host | string | 服务监听地址 |
| enable | string | 是否启用 ,填 'true' 或者 'false' | | enable | string | 是否启用 ,填 'true' 或者 'false' |
@ -155,7 +155,7 @@ method: `POST` formdata
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | -------------------------------- |
| port | string | 服务端口 | | port | string | 服务端口 |
| host | string | 服务监听地址 | | host | string | 服务监听地址 |
| enable | string | 是否启用 ,填 'true' 或者 'false' | | enable | string | 是否启用 ,填 'true' 或者 'false' |
@ -176,7 +176,7 @@ method: `POST` formdata
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | -------------------------------- |
| port | string | 服务端口 | | port | string | 服务端口 |
| host | string | 服务监听地址 | | host | string | 服务监听地址 |
| enable | string | 是否启用 ,填 'true' 或者 'false' | | enable | string | 是否启用 ,填 'true' 或者 'false' |
@ -197,7 +197,7 @@ method: `POST` formdata
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | ----------------------------------- |
| json | string | 完整的config.json的配合，json字符串 | | json | string | 完整的config.json的配合，json字符串 |
@ -216,7 +216,7 @@ method: `GET`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ---- | ---- |
| 无 | | | | 无 | | |
@ -227,6 +227,6 @@ method: `GET`
``` ```
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | ----------------------------------- |
| config | string | 完整的config.json的配合，json字符串 | | config | string | 完整的config.json的配合，json字符串 |

4
docs/config.md
View File

@ -62,7 +62,7 @@ go-cqhttp 支持导入CQHTTP的配置文件, 具体步骤为:
```` ````
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ------------------ | -------- | ------------------------------------------------------------------- | | --------------------- | -------- | ---------------------------------------------------------------------------------------- |
| uin | int64 | 登录用QQ号 | | uin | int64 | 登录用QQ号 |
| password | string | 登录用密码 | | password | string | 登录用密码 |
| encrypt_password | bool | 是否对密码进行加密. | | encrypt_password | bool | 是否对密码进行加密. |
@ -111,7 +111,7 @@ go-cqhttp 支持导入CQHTTP的配置文件, 具体步骤为:
在大部分情况下 我们只需要关心 `protocol` 字段: 在大部分情况下 我们只需要关心 `protocol` 字段:
| 值 | 类型 | 限制 | | 值 | 类型 | 限制 |
| ---- | ------------- | ----------------------------------------------------- | | --- | ------------- | ---------------------------------------------------------------- |
| 0 | iPad | 无 | | 0 | iPad | 无 |
| 1 | Android Phone | 无 | | 1 | Android Phone | 无 |
| 2 | Android Watch | 无法接收 `group_notify` 事件、无法接收口令红包、无法接收撤回消息 | | 2 | Android Watch | 无法接收 `group_notify` 事件、无法接收口令红包、无法接收撤回消息 |

76
docs/cqhttp.md
View File

@ -7,7 +7,7 @@
### 图片 ### 图片
| 参数名 | 可能的值 | 说明 | | 参数名 | 可能的值 | 说明 |
| --- | --- | --- | | ------- | --------------- | --------------------------------------------------------------- |
| `file` | - | 图片文件名 | | `file` | - | 图片文件名 |
| `type` | `flash`，`show` | 图片类型，`flash` 表示闪照，`show` 表示秀图，默认普通图片 | | `type` | `flash`，`show` | 图片类型，`flash` 表示闪照，`show` 表示秀图，默认普通图片 |
| `url` | - | 图片 URL | | `url` | - | 图片 URL |
@ -17,7 +17,7 @@
可用的特效ID: 可用的特效ID:
| id | 类型 | | id | 类型 |
| --- |-------| | ----- | ---- |
| 40000 | 普通 | | 40000 | 普通 |
| 40001 | 幻影 | | 40001 | 幻影 |
| 40002 | 抖动 | | 40002 | 抖动 |
@ -65,7 +65,7 @@ Type: `poke`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- | | ------ | ----- | ------------ |
| qq | int64 | 需要戳的成员 | | qq | int64 | 需要戳的成员 |
示例: `[CQ:poke,qq=123456]` 示例: `[CQ:poke,qq=123456]`
@ -81,14 +81,14 @@ Type: `gift`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | -----------| | ------ | ----- | -------------- |
| qq | int64 | 接收礼物的成员 | | qq | int64 | 接收礼物的成员 |
| id | int | 礼物的类型 | | id | int | 礼物的类型 |
目前支持的礼物ID: 目前支持的礼物ID:
| id | 类型 | | id | 类型 |
| ---| ---------| | --- | ---------- |
| 0 | 甜Wink | | 0 | 甜Wink |
| 1 | 快乐肥宅水 | | 1 | 快乐肥宅水 |
| 2 | 幸运手链 | | 2 | 幸运手链 |
@ -117,7 +117,7 @@ Type: `forward`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | ------------------------------------------------------------- |
| id | string | 合并转发ID, 需要通过 `/get_forward_msg` API获取转发的具体内容 | | id | string | 合并转发ID, 需要通过 `/get_forward_msg` API获取转发的具体内容 |
示例: `[CQ:forward,id=xxxx]` 示例: `[CQ:forward,id=xxxx]`
@ -131,7 +131,7 @@ Type: `node`
参数: 参数:
| 参数名 | 类型 | 说明 | 特殊说明 | | 参数名 | 类型 | 说明 | 特殊说明 |
| ------- | ------- | -------------- | ------------------------------------------------------------ | | ------- | ------- | -------------- | -------------------------------------------------------------------------------------- |
| id | int32 | 转发消息id | 直接引用他人的消息合并转发, 实际查看顺序为原消息发送顺序 **与下面的自定义消息二选一** | | id | int32 | 转发消息id | 直接引用他人的消息合并转发, 实际查看顺序为原消息发送顺序 **与下面的自定义消息二选一** |
| name | string | 发送者显示名字 | 用于自定义消息 (自定义消息并合并转发，实际查看顺序为自定义消息段顺序) | | name | string | 发送者显示名字 | 用于自定义消息 (自定义消息并合并转发，实际查看顺序为自定义消息段顺序) |
| uin | int64 | 发送者QQ号 | 用于自定义消息 | | uin | int64 | 发送者QQ号 | 用于自定义消息 |
@ -218,7 +218,7 @@ Type: `xml`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | ----------------------------------------- |
| data | string | xml内容，xml中的value部分，记得实体化处理 | | data | string | xml内容，xml中的value部分，记得实体化处理 |
| resid | int32 | 可以不填 | | resid | int32 | 可以不填 |
@ -267,7 +267,7 @@ Type: `json`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | ----------------------------------------------- |
| data | string | json内容，json的所有字符串记得实体化处理 | | data | string | json内容，json的所有字符串记得实体化处理 |
| resid | int32 | 默认不填为0，走小程序通道，填了走富文本通道发送 | | resid | int32 | 默认不填为0，走小程序通道，填了走富文本通道发送 |
@ -300,7 +300,7 @@ Type: `cardimage`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | --------- | ------ | ------------------------------------- |
| file | string | 和image的file字段对齐，支持也是一样的 | | file | string | 和image的file字段对齐，支持也是一样的 |
| minwidth | int64 | 默认不填为400，最小width | | minwidth | int64 | 默认不填为400，最小width |
| minheight | int64 | 默认不填为400，最小height | | minheight | int64 | 默认不填为400，最小height |
@ -326,7 +326,7 @@ Type: `tts`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- | | ------ | ------ | ---- |
| text | string | 内容 | | text | string | 内容 |
示例: `[CQ:tts,text=这是一条测试消息]` 示例: `[CQ:tts,text=这是一条测试消息]`
@ -340,7 +340,7 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| -------- | ------ | ---- | | ---------- | ------ | ---- |
| group_id | int64 | 群号 | | group_id | int64 | 群号 |
| group_name | string | 新名 | | group_name | string | 新名 |
@ -351,7 +351,7 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| -------- | ------ | ---- | | -------- | ------ | ------------------------ |
| group_id | int64 | 群号 | | group_id | int64 | 群号 |
| file | string | 图片文件名 | | file | string | 图片文件名 |
| cache | int | 表示是否使用已缓存的文件 | | cache | int | 表示是否使用已缓存的文件 |
@ -469,13 +469,13 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ------------ | ------ | ------ | | --------- | ------ | ---- |
| `content` | string | 内容 | | `content` | string | 内容 |
**响应数据** **响应数据**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | -------- | -------- | ---- |
| `slices` | string[] | 词组 | | `slices` | string[] | 词组 |
### 图片OCR ### 图片OCR
@ -487,20 +487,20 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ------------ | ------ | ------ | | ------- | ------ | ------ |
| `image` | string | 图片ID | | `image` | string | 图片ID |
**响应数据** **响应数据**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ---------- | --------------- | ------- |
| `texts` | TextDetection[] | OCR结果 | | `texts` | TextDetection[] | OCR结果 |
| `language` | string | 语言 | | `language` | string | 语言 |
**TextDetection** **TextDetection**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ------------- | ------- | ------ |
| `text` | string | 文本 | | `text` | string | 文本 |
| `confidence` | int32 | 置信度 | | `confidence` | int32 | 置信度 |
| `coordinates` | vector2 | 坐标 | | `coordinates` | vector2 | 坐标 |
@ -513,7 +513,7 @@ Type: `tts`
**响应数据** **响应数据**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ------------------ | ---------------- | ------------ |
| `invited_requests` | InvitedRequest[] | 邀请消息列表 | | `invited_requests` | InvitedRequest[] | 邀请消息列表 |
| `join_requests` | JoinRequest[] | 进群消息列表 | | `join_requests` | JoinRequest[] | 进群消息列表 |
@ -522,7 +522,7 @@ Type: `tts`
**InvitedRequest** **InvitedRequest**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | -------------- | ------ | ----------------- |
| `request_id` | int64 | 请求ID | | `request_id` | int64 | 请求ID |
| `invitor_uin` | int64 | 邀请者 | | `invitor_uin` | int64 | 邀请者 |
| `invitor_nick` | string | 邀请者昵称 | | `invitor_nick` | string | 邀请者昵称 |
@ -534,7 +534,7 @@ Type: `tts`
**JoinRequest** **JoinRequest**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ---------------- | ------ | ----------------- |
| `request_id` | int64 | 请求ID | | `request_id` | int64 | 请求ID |
| `requester_uin` | int64 | 请求者ID | | `requester_uin` | int64 | 请求者ID |
| `requester_nick` | string | 请求者昵称 | | `requester_nick` | string | 请求者昵称 |
@ -551,13 +551,13 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ------------ | ------ | ------ | | ---------- | ----- | ---- |
| `group_id` | int64 | 群号 | | `group_id` | int64 | 群号 |
**响应数据** **响应数据**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ------------- | ----- | ---------- |
| `file_count` | int32 | 文件总数 | | `file_count` | int32 | 文件总数 |
| `limit_count` | int32 | 文件上限 | | `limit_count` | int32 | 文件上限 |
| `used_space` | int64 | 已使用空间 | | `used_space` | int64 | 已使用空间 |
@ -572,13 +572,13 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ------------ | ------ | ------ | | ---------- | ----- | ---- |
| `group_id` | int64 | 群号 | | `group_id` | int64 | 群号 |
**响应数据** **响应数据**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | --------- | -------- | ---------- |
| `files` | File[] | 文件列表 | | `files` | File[] | 文件列表 |
| `folders` | Folder[] | 文件夹列表 | | `folders` | Folder[] | 文件夹列表 |
@ -591,14 +591,14 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ------------ | ------ | ------ | | ----------- | ------ | --------------------------- |
| `group_id` | int64 | 群号 | | `group_id` | int64 | 群号 |
| `folder_id` | string | 文件夹ID 参考 `Folder` 对象 | | `folder_id` | string | 文件夹ID 参考 `Folder` 对象 |
**响应数据** **响应数据**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | --------- | -------- | ---------- |
| `files` | File[] | 文件列表 | | `files` | File[] | 文件列表 |
| `folders` | Folder[] | 文件夹列表 | | `folders` | Folder[] | 文件夹列表 |
@ -611,7 +611,7 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ------------ | ------ | ------ | | ---------- | ------ | ------------------------- |
| `group_id` | int64 | 群号 | | `group_id` | int64 | 群号 |
| `file_id` | string | 文件ID 参考 `File` 对象 | | `file_id` | string | 文件ID 参考 `File` 对象 |
| `busid` | int32 | 文件类型 参考 `File` 对象 | | `busid` | int32 | 文件类型 参考 `File` 对象 |
@ -619,13 +619,13 @@ Type: `tts`
**响应数据** **响应数据**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ----- | ------ | ------------ |
| `url` | string | 文件下载链接 | | `url` | string | 文件下载链接 |
**File** **File**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ---------------- | ------ | ---------------------- |
| `file_id` | string | 文件ID | | `file_id` | string | 文件ID |
| `file_name` | string | 文件名 | | `file_name` | string | 文件名 |
| `busid` | int32 | 文件类型 | | `busid` | int32 | 文件类型 |
@ -640,7 +640,7 @@ Type: `tts`
**Folder** **Folder**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ------------------ | ------ | ---------- |
| `folder_id` | string | 文件夹ID | | `folder_id` | string | 文件夹ID |
| `folder_name` | string | 文件名 | | `folder_name` | string | 文件名 |
| `create_time` | int64 | 创建时间 | | `create_time` | int64 | 创建时间 |
@ -668,7 +668,7 @@ Type: `tts`
**上报数据** **上报数据**
| 字段 | 类型 | 可能的值 | 说明 | | 字段 | 类型 | 可能的值 | 说明 |
| ------------- | ------ | -------------- | -------------- | | ------------- | ------ | --------------- | -------------- |
| `post_type` | string | `notice` | 上报类型 | | `post_type` | string | `notice` | 上报类型 |
| `notice_type` | string | `friend_recall` | 消息类型 | | `notice_type` | string | `friend_recall` | 消息类型 |
| `user_id` | int64 | | 好友id | | `user_id` | int64 | | 好友id |
@ -681,7 +681,7 @@ Type: `tts`
**上报数据** **上报数据**
| 字段 | 类型 | 可能的值 | 说明 | | 字段 | 类型 | 可能的值 | 说明 |
| ------------- | ------ | -------------- | -------------- | | ------------- | ------ | -------- | -------- |
| `post_type` | string | `notice` | 上报类型 | | `post_type` | string | `notice` | 上报类型 |
| `notice_type` | string | `notify` | 消息类型 | | `notice_type` | string | `notify` | 消息类型 |
| `group_id` | int64 | | 群号 | | `group_id` | int64 | | 群号 |
@ -696,7 +696,7 @@ Type: `tts`
**上报数据** **上报数据**
| 字段 | 类型 | 可能的值 | 说明 | | 字段 | 类型 | 可能的值 | 说明 |
| ------------- | ------ | -------------- | -------------- | | ------------- | ------ | ------------ | ------------ |
| `post_type` | string | `notice` | 上报类型 | | `post_type` | string | `notice` | 上报类型 |
| `notice_type` | string | `notify` | 消息类型 | | `notice_type` | string | `notify` | 消息类型 |
| `group_id` | int64 | | 群号 | | `group_id` | int64 | | 群号 |
@ -711,7 +711,7 @@ Type: `tts`
**上报数据** **上报数据**
| 字段 | 类型 | 可能的值 | 说明 | | 字段 | 类型 | 可能的值 | 说明 |
| ------------- | ------ | -------------- | -------------- | | ------------- | ------ | -------------------------------------------------------- | -------- |
| `post_type` | string | `notice` | 上报类型 | | `post_type` | string | `notice` | 上报类型 |
| `notice_type` | string | `notify` | 消息类型 | | `notice_type` | string | `notify` | 消息类型 |
| `group_id` | int64 | | 群号 | | `group_id` | int64 | | 群号 |
@ -726,7 +726,7 @@ Type: `tts`
**上报数据** **上报数据**
| 字段 | 类型 | 可能的值 | 说明 | | 字段 | 类型 | 可能的值 | 说明 |
| ------------- | ------ | -------------- | -------------- | | ------------- | ------ | ------------ | -------- |
| `post_type` | string | `notice` | 上报类型 | | `post_type` | string | `notice` | 上报类型 |
| `notice_type` | string | `group_card` | 消息类型 | | `notice_type` | string | `group_card` | 消息类型 |
| `group_id` | int64 | | 群号 | | `group_id` | int64 | | 群号 |
@ -741,7 +741,7 @@ Type: `tts`
**上报数据** **上报数据**
| 字段 | 类型 | 可能的值 | 说明 | | 字段 | 类型 | 可能的值 | 说明 |
| ------------- | ------ | -------------- | -------------- | | ------------- | ------ | -------------- | -------- |
| `post_type` | string | `notice` | 上报类型 | | `post_type` | string | `notice` | 上报类型 |
| `notice_type` | string | `offline_file` | 消息类型 | | `notice_type` | string | `offline_file` | 消息类型 |
| `user_id` | int64 | | 发送者id | | `user_id` | int64 | | 发送者id |
@ -750,7 +750,7 @@ Type: `tts`
**file object** **file object**
| 字段 | 类型 | 可能的值 | 说明 | | 字段 | 类型 | 可能的值 | 说明 |
| ------------- | ------ | -------------- | -------------- | | ------ | ------ | -------- | -------- |
| `name` | string | | 文件名 | | `name` | string | | 文件名 |
| `size` | int64 | | 文件大小 | | `size` | int64 | | 文件大小 |
| `url` | string | | 下载链接 | | `url` | string | | 下载链接 |

2
docs/quick_start.md
View File

@ -117,7 +117,7 @@ enable ws?(Y/n)
*注：可以使用*`go env -w GOPROXY=https://goproxy.cn,direct`*来加速国内依赖安装速度* *注：可以使用*`go env -w GOPROXY=https://goproxy.cn,direct`*来加速国内依赖安装速度*
*注：此时构建后的文件名为*`main`(Linux)或`main.exe`(Windows) *注：此时构建后的文件名为*`go-cqhttp`(Linux)或`go-cqhttp.exe`(Windows)
## 更新 ## 更新