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

83
README.md
View File

@ -46,33 +46,34 @@
<summary>已实现API</summary> <summary>已实现API</summary>
##### 注意: 部分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>
@ -80,20 +81,20 @@
<summary>已实现Event</summary> <summary>已实现Event</summary>
##### 注意: 部分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>

20
docs/EventFilter.md
View File

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

104
docs/adminApi.md
View File

@ -6,9 +6,9 @@
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- | | ------------ | ------ | --------------------------- |
| access_token | string | 校验口令，config.json中配置 | | access_token | string | 校验口令，config.json中配置 |
@ -24,9 +24,9 @@ method：`POST/GET`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ---- | ------------------------------------- | | ------ | ---- | ---- |
| 无||| | 无 | | |
返回： 返回：
@ -44,19 +44,19 @@ method: `GET`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- | | ------ | ---- | ---- |
| 无||| | 无 | | |
返回： 返回：
```json ```json
{"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标签即可显示 |
### admin/do_web_write ### admin/do_web_write
@ -67,9 +67,9 @@ method: `POST` formdata
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- | | ------ | ------ | ---------- |
| input | string | 输入的内容 | | input | string | 输入的内容 |
返回： 返回：
@ -89,9 +89,9 @@ method: `POST`
参数: 参数:
| 参数名 |类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | -----------| | ------ | ---- | ---- |
| 无 | | | | 无 | | |
返回： 返回：
@ -108,12 +108,12 @@ 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' |
| access_token | string | 授权 token | | access_token | string | 授权 token |
返回： 返回：
@ -130,14 +130,14 @@ method: `POST` formdata
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ----------- | ------ | --------------------------------------------- |
| port | string | 服务端口 | | port | string | 服务端口 |
| host | string | 服务监听地址 | | host | string | 服务监听地址 |
| enable | string | 是否启用 ,填 'true' 或者 'false' | | enable | string | 是否启用 ,填 'true' 或者 'false' |
| timeout | string | http请求超时时间 | | timeout | string | http请求超时时间 |
| post_url | string | post上报地址 不需要就填空字符串，或者不填| | post_url | string | post上报地址 不需要就填空字符串，或者不填 |
| post_secret | string | post上报的secret 不需要就填空字符串，或者不填 | | post_secret | string | post上报的secret 不需要就填空字符串，或者不填 |
返回： 返回：
@ -154,11 +154,11 @@ method: `POST` formdata
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | -------------------------------- |
| port | string | 服务端口 | | port | string | 服务端口 |
| host | string | 服务监听地址 | | host | string | 服务监听地址 |
| enable | string | 是否启用 ,填 'true' 或者 'false' | | enable | string | 是否启用 ,填 'true' 或者 'false' |
返回： 返回：
@ -175,11 +175,11 @@ method: `POST` formdata
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | -------------------------------- |
| port | string | 服务端口 | | port | string | 服务端口 |
| host | string | 服务监听地址 | | host | string | 服务监听地址 |
| enable | string | 是否启用 ,填 'true' 或者 'false' | | enable | string | 是否启用 ,填 'true' 或者 'false' |
返回： 返回：
@ -196,9 +196,9 @@ method: `POST` formdata
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | ----------------------------------- |
| json | string | 完整的config.json的配合，json字符串 | | json | string | 完整的config.json的配合，json字符串 |
返回： 返回：
@ -215,9 +215,9 @@ method: `GET`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ---- | ---- |
| 无 | | | | 无 | | |
返回： 返回：
@ -226,7 +226,7 @@ method: `GET`
{"data": {"config":"xxxx"}, "retcode": 0, "status": "ok"} {"data": {"config":"xxxx"}, "retcode": 0, "status": "ok"}
``` ```
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | ----------------------------------- |
| config | string | 完整的config.json的配合，json字符串 | | config | string | 完整的config.json的配合，json字符串 |

58
docs/config.md
View File

@ -61,29 +61,29 @@ go-cqhttp 支持导入CQHTTP的配置文件, 具体步骤为:
} }
```` ````
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ------------------ | -------- | ------------------------------------------------------------------- | | --------------------- | -------- | ---------------------------------------------------------------------------------------- |
| uin | int64 | 登录用QQ号 | | uin | int64 | 登录用QQ号 |
| password | string | 登录用密码 | | password | string | 登录用密码 |
| encrypt_password | bool | 是否对密码进行加密. | | encrypt_password | bool | 是否对密码进行加密. |
| password_encrypted | string | 加密后的密码(请勿修改) | | password_encrypted | string | 加密后的密码(请勿修改) |
| enable_db | bool | 是否开启内置数据库, 关闭后将无法使用 **回复/撤回** 等上下文相关接口 | | enable_db | bool | 是否开启内置数据库, 关闭后将无法使用 **回复/撤回** 等上下文相关接口 |
| access_token | string | 同CQHTTP的 `access_token` 用于身份验证 | | access_token | string | 同CQHTTP的 `access_token` 用于身份验证 |
| relogin | bool | 是否自动重新登录 | | relogin | bool | 是否自动重新登录 |
| relogin_delay | int | 重登录延时（秒） | | relogin_delay | int | 重登录延时（秒） |
| max_relogin_times | uint | 最大重登录次数，若0则不设置上限 | | max_relogin_times | uint | 最大重登录次数，若0则不设置上限 |
| _rate_limit | bool | 是否启用API调用限速 | | _rate_limit | bool | 是否启用API调用限速 |
| frequency | float64 | 1s内能调用API的次数 | | frequency | float64 | 1s内能调用API的次数 |
| bucket_size | int | 令牌桶的大小，默认为1，修改此值可允许一定程度内连续调用api | | bucket_size | int | 令牌桶的大小，默认为1，修改此值可允许一定程度内连续调用api |
| post_message_format | string | 上报信息类型 | | post_message_format | string | 上报信息类型 |
| ignore_invalid_cqcode| bool | 是否忽略错误的CQ码 | | ignore_invalid_cqcode | bool | 是否忽略错误的CQ码 |
| force_fragmented | bool | 是否强制分片发送群长消息 | | force_fragmented | bool | 是否强制分片发送群长消息 |
| use_sso_address | bool | 是否使用服务器下发的地址 | | use_sso_address | bool | 是否使用服务器下发的地址 |
| heartbeat_interval | int64 | 心跳间隔时间，单位秒。小于0则关闭心跳，等于0使用默认值(5秒) | | heartbeat_interval | int64 | 心跳间隔时间，单位秒。小于0则关闭心跳，等于0使用默认值(5秒) |
| http_config | object | HTTP API配置 | | http_config | object | HTTP API配置 |
| ws_config | object | Websocket API 配置 | | ws_config | object | Websocket API 配置 |
| ws_reverse_servers | object[] | 反向 Websocket API 配置 | | ws_reverse_servers | object[] | 反向 Websocket API 配置 |
| log_level | string | 指定日志收集级别，将收集的日志单独存放到固定文件中，便于查看日志线索 当前支持 warn,error| | log_level | string | 指定日志收集级别，将收集的日志单独存放到固定文件中，便于查看日志线索 当前支持 warn,error |
> 注: 开启密码加密后程序将在每次启动时要求输入解密密钥, 密钥错误会导致登录时提示密码错误. > 注: 开启密码加密后程序将在每次启动时要求输入解密密钥, 密钥错误会导致登录时提示密码错误.
> 解密后密码将储存在内存中，用于自动重连等功能. 所以此加密并不能防止内存读取. > 解密后密码将储存在内存中，用于自动重连等功能. 所以此加密并不能防止内存读取.
@ -110,12 +110,12 @@ 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` 事件、无法接收口令红包、无法接收撤回消息 |
| 3 | MacOS | 无 | | 3 | MacOS | 无 |
> 注意, 根据协议的不同, 各类消息有所限制 > 注意, 根据协议的不同, 各类消息有所限制

422
docs/cqhttp.md
View File

@ -6,24 +6,24 @@
### 图片 ### 图片
| 参数名 | 可能的值 | 说明 | | 参数名 | 可能的值 | 说明 |
| --- | --- | --- | | ------- | --------------- | --------------------------------------------------------------- |
| `file` | - | 图片文件名 | | `file` | - | 图片文件名 |
| `type` | `flash`，`show` | 图片类型，`flash` 表示闪照，`show` 表示秀图，默认普通图片 | | `type` | `flash`，`show` | 图片类型，`flash` 表示闪照，`show` 表示秀图，默认普通图片 |
| `url` | - | 图片 URL | | `url` | - | 图片 URL |
| `cache` | `0` `1` | 只在通过网络 URL 发送时有效，表示是否使用已缓存的文件，默认 `1` | | `cache` | `0` `1` | 只在通过网络 URL 发送时有效，表示是否使用已缓存的文件，默认 `1` |
| `id` | - | 发送秀图时的特效id，默认为40000 | | `id` | - | 发送秀图时的特效id，默认为40000 |
可用的特效ID: 可用的特效ID:
| id |类型 | | id | 类型 |
| --- |-------| | ----- | ---- |
| 40000 | 普通 | | 40000 | 普通 |
| 40001 | 幻影 | | 40001 | 幻影 |
| 40002 | 抖动 | | 40002 | 抖动 |
| 40003 | 生日 | | 40003 | 生日 |
| 40004 | 爱你 | | 40004 | 爱你 |
| 40005 | 征友 | | 40005 | 征友 |
### 回复 ### 回复
@ -64,9 +64,9 @@ Type: `poke`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- | | ------ | ----- | ------------ |
| qq | int64 | 需要戳的成员 | | qq | int64 | 需要戳的成员 |
示例: `[CQ:poke,qq=123456]` 示例: `[CQ:poke,qq=123456]`
@ -80,29 +80,29 @@ Type: `gift`
参数: 参数:
| 参数名 |类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | -----------| | ------ | ----- | -------------- |
| qq | int64 | 接收礼物的成员 | | qq | int64 | 接收礼物的成员 |
| id | int | 礼物的类型 | | id | int | 礼物的类型 |
目前支持的礼物ID: 目前支持的礼物ID:
| id |类型 | | id | 类型 |
| ---| ---------| | --- | ---------- |
| 0 | 甜Wink | | 0 | 甜Wink |
| 1 | 快乐肥宅水| | 1 | 快乐肥宅水 |
| 2 | 幸运手链 | | 2 | 幸运手链 |
| 3 | 卡布奇诺 | | 3 | 卡布奇诺 |
| 4 | 猫咪手表 | | 4 | 猫咪手表 |
| 5 | 绒绒手套 | | 5 | 绒绒手套 |
| 6 | 彩虹糖果 | | 6 | 彩虹糖果 |
| 7 | 坚强 | | 7 | 坚强 |
| 8 | 告白话筒 | | 8 | 告白话筒 |
| 9 | 牵你的手 | | 9 | 牵你的手 |
| 10 | 可爱猫咪 | | 10 | 可爱猫咪 |
| 11 | 神秘面具 | | 11 | 神秘面具 |
| 12 | 我超忙的 | | 12 | 我超忙的 |
| 13 | 爱心口罩 | | 13 | 爱心口罩 |
@ -116,8 +116,8 @@ Type: `forward`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | ------------------------------------------------------------- |
| id | string | 合并转发ID, 需要通过 `/get_forward_msg` API获取转发的具体内容 | | id | string | 合并转发ID, 需要通过 `/get_forward_msg` API获取转发的具体内容 |
示例: `[CQ:forward,id=xxxx]` 示例: `[CQ:forward,id=xxxx]`
@ -130,12 +130,12 @@ Type: `node`
参数: 参数:
| 参数名 | 类型 | 说明 | 特殊说明 | | 参数名 | 类型 | 说明 | 特殊说明 |
| ------- | ------- | -------------- | ------------------------------------------------------------ | | ------- | ------- | -------------- | -------------------------------------------------------------------------------------- |
| id | int32 | 转发消息id | 直接引用他人的消息合并转发, 实际查看顺序为原消息发送顺序 **与下面的自定义消息二选一** | | id | int32 | 转发消息id | 直接引用他人的消息合并转发, 实际查看顺序为原消息发送顺序 **与下面的自定义消息二选一** |
| name | string | 发送者显示名字 | 用于自定义消息 (自定义消息并合并转发，实际查看顺序为自定义消息段顺序) | | name | string | 发送者显示名字 | 用于自定义消息 (自定义消息并合并转发，实际查看顺序为自定义消息段顺序) |
| uin | int64 | 发送者QQ号 | 用于自定义消息 | | uin | int64 | 发送者QQ号 | 用于自定义消息 |
| content | message | 具体消息 | 用于自定义消息 **不支持转发套娃，不支持引用回复** | | content | message | 具体消息 | 用于自定义消息 **不支持转发套娃，不支持引用回复** |
特殊说明: **需要使用单独的API `/send_group_forward_msg` 发送，并且由于消息段较为复杂，仅支持Array形式入参。 如果引用消息和自定义消息同时出现，实际查看顺序将取消息段顺序. 另外按 [CQHTTP](https://cqhttp.cc/docs/4.15/#/Message?id=格式) 文档说明, `data` 应全为字符串, 但由于需要接收`message` 类型的消息, 所以 *仅限此Type的content字段* 支持Array套娃** 特殊说明: **需要使用单独的API `/send_group_forward_msg` 发送，并且由于消息段较为复杂，仅支持Array形式入参。 如果引用消息和自定义消息同时出现，实际查看顺序将取消息段顺序. 另外按 [CQHTTP](https://cqhttp.cc/docs/4.15/#/Message?id=格式) 文档说明, `data` 应全为字符串, 但由于需要接收`message` 类型的消息, 所以 *仅限此Type的content字段* 支持Array套娃**
@ -217,10 +217,10 @@ Type: `xml`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | ----------------------------------------- |
| data | string | xml内容，xml中的value部分，记得实体化处理| | data | string | xml内容，xml中的value部分，记得实体化处理 |
| resid | int32 | 可以不填| | resid | int32 | 可以不填 |
示例: `[CQ:xml,data=xxxx]` 示例: `[CQ:xml,data=xxxx]`
@ -266,10 +266,10 @@ Type: `json`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ | | ------ | ------ | ----------------------------------------------- |
| data | string | json内容，json的所有字符串记得实体化处理| | data | string | json内容，json的所有字符串记得实体化处理 |
| resid | int32 | 默认不填为0，走小程序通道，填了走富文本通道发送| | resid | int32 | 默认不填为0，走小程序通道，填了走富文本通道发送 |
json中的字符串需要进行转义： json中的字符串需要进行转义：
@ -299,15 +299,15 @@ 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 |
| maxwidth | int64 | 默认不填为500，最大width| | maxwidth | int64 | 默认不填为500，最大width |
| maxheight | int64 | 默认不填为1000，最大height| | maxheight | int64 | 默认不填为1000，最大height |
| source | string | 分享来源的名称，可以留空| | source | string | 分享来源的名称，可以留空 |
| icon | string | 分享来源的icon图标url，可以留空| | icon | string | 分享来源的icon图标url，可以留空 |
示例cardimage 的cq码： 示例cardimage 的cq码：
@ -325,9 +325,9 @@ Type: `tts`
参数: 参数:
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- | | ------ | ------ | ---- |
| text | string | 内容 | | text | string | 内容 |
示例: `[CQ:tts,text=这是一条测试消息]` 示例: `[CQ:tts,text=这是一条测试消息]`
@ -339,10 +339,10 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| -------- | ------ | ---- | | ---------- | ------ | ---- |
| group_id | int64 | 群号 | | group_id | int64 | 群号 |
| group_name | string | 新名 | | group_name | string | 新名 |
### 设置群头像 ### 设置群头像
@ -350,11 +350,11 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| -------- | ------ | ---- | | -------- | ------ | ------------------------ |
| group_id | int64 | 群号 | | group_id | int64 | 群号 |
| file | string | 图片文件名 | | file | string | 图片文件名 |
| cache | int | 表示是否使用已缓存的文件 | | cache | int | 表示是否使用已缓存的文件 |
[1]`file` 参数支持以下几种格式： [1]`file` 参数支持以下几种格式：
@ -468,15 +468,15 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ------------ | ------ | ------ | | --------- | ------ | ---- |
| `content` | string | 内容 | | `content` | string | 内容 |
**响应数据** **响应数据**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | -------- | -------- | ---- |
| `slices` | string[] | 词组 | | `slices` | string[] | 词组 |
### 图片OCR ### 图片OCR
@ -486,24 +486,24 @@ 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 | 坐标 |
### 获取群系统消息 ### 获取群系统消息
@ -512,37 +512,37 @@ Type: `tts`
**响应数据** **响应数据**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ------------------ | ---------------- | ------------ |
| `invited_requests` | InvitedRequest[] | 邀请消息列表 | | `invited_requests` | InvitedRequest[] | 邀请消息列表 |
| `join_requests` | JoinRequest[] | 进群消息列表 | | `join_requests` | JoinRequest[] | 进群消息列表 |
> 注意: 如果列表不存在任何消息, 将返回 `null` > 注意: 如果列表不存在任何消息, 将返回 `null`
**InvitedRequest** **InvitedRequest**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | -------------- | ------ | ----------------- |
| `request_id` | int64 | 请求ID | | `request_id` | int64 | 请求ID |
| `invitor_uin` | int64 | 邀请者 | | `invitor_uin` | int64 | 邀请者 |
| `invitor_nick` | string | 邀请者昵称 | | `invitor_nick` | string | 邀请者昵称 |
| `group_id` | int64 | 群号 | | `group_id` | int64 | 群号 |
| `group_name` | string | 群名 | | `group_name` | string | 群名 |
| `checked` | bool | 是否已被处理| | `checked` | bool | 是否已被处理 |
| `actor` | int64 | 处理者, 未处理为0 | | `actor` | int64 | 处理者, 未处理为0 |
**JoinRequest** **JoinRequest**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ---------------- | ------ | ----------------- |
| `request_id` | int64 | 请求ID | | `request_id` | int64 | 请求ID |
| `requester_uin` | int64 | 请求者ID | | `requester_uin` | int64 | 请求者ID |
| `requester_nick` | string | 请求者昵称 | | `requester_nick` | string | 请求者昵称 |
| `message` | string | 验证消息 | | `message` | string | 验证消息 |
| `group_id` | int64 | 群号 | | `group_id` | int64 | 群号 |
| `group_name` | string | 群名 | | `group_name` | string | 群名 |
| `checked` | bool | 是否已被处理| | `checked` | bool | 是否已被处理 |
| `actor` | int64 | 处理者, 未处理为0 | | `actor` | int64 | 处理者, 未处理为0 |
### 获取群文件系统信息 ### 获取群文件系统信息
@ -550,18 +550,18 @@ 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 | 已使用空间 |
| `total_space` | int64 | 空间上限 | | `total_space` | int64 | 空间上限 |
### 获取群根目录文件列表 ### 获取群根目录文件列表
@ -571,16 +571,16 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ------------ | ------ | ------ | | ---------- | ----- | ---- |
| `group_id` | int64 | 群号 | | `group_id` | int64 | 群号 |
**响应数据** **响应数据**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | --------- | -------- | ---------- |
| `files` | File[] | 文件列表 | | `files` | File[] | 文件列表 |
| `folders` | Folder[] | 文件夹列表 | | `folders` | Folder[] | 文件夹列表 |
### 获取群子目录文件列表 ### 获取群子目录文件列表
@ -590,17 +590,17 @@ 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[] | 文件夹列表 |
### 获取群文件资源链接 ### 获取群文件资源链接
@ -610,43 +610,43 @@ Type: `tts`
**参数** **参数**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ------------ | ------ | ------ | | ---------- | ------ | ------------------------- |
| `group_id` | int64 | 群号 | | `group_id` | int64 | 群号 |
| `file_id` | string | 文件ID 参考 `File` 对象 | | `file_id` | string | 文件ID 参考 `File` 对象 |
| `busid` | int32 | 文件类型 参考 `File` 对象 | | `busid` | int32 | 文件类型 参考 `File` 对象 |
**响应数据** **响应数据**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ----- | ------ | ------------ |
| `url` | string | 文件下载链接 | | `url` | string | 文件下载链接 |
**File** **File**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ---------------- | ------ | ---------------------- |
| `file_id` | string | 文件ID | | `file_id` | string | 文件ID |
| `file_name` | string | 文件名 | | `file_name` | string | 文件名 |
| `busid` | int32 | 文件类型 | | `busid` | int32 | 文件类型 |
| `file_size` | int64 | 文件大小 | | `file_size` | int64 | 文件大小 |
| `upload_time` | int64 | 上传时间 | | `upload_time` | int64 | 上传时间 |
| `dead_time` | int64 | 过期时间,永久文件恒为0 | | `dead_time` | int64 | 过期时间,永久文件恒为0 |
| `modify_time` | int64 | 最后修改时间 | | `modify_time` | int64 | 最后修改时间 |
| `download_times` | int32 | 下载次数 | | `download_times` | int32 | 下载次数 |
| `uploader` | int64 | 上传者ID | | `uploader` | int64 | 上传者ID |
| `uploader_name` | string | 上传者名字 | | `uploader_name` | string | 上传者名字 |
**Folder** **Folder**
| 字段 | 类型 | 说明 | | 字段 | 类型 | 说明 |
| ---------- | ----------------- | -------- | | ------------------ | ------ | ---------- |
| `folder_id` | string | 文件夹ID | | `folder_id` | string | 文件夹ID |
| `folder_name` | string | 文件名 | | `folder_name` | string | 文件名 |
| `create_time` | int64 | 创建时间 | | `create_time` | int64 | 创建时间 |
| `creator` | int64 | 创建者 | | `creator` | int64 | 创建者 |
| `creator_name` | string | 创建者名字 | | `creator_name` | string | 创建者名字 |
| `total_file_count` | int32 | 子文件数量 | | `total_file_count` | int32 | 子文件数量 |
## 事件 ## 事件
@ -667,12 +667,12 @@ 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 |
| `message_id` | int64 | | 被撤回的消息id | | `message_id` | int64 | | 被撤回的消息id |
#### 群内戳一戳 #### 群内戳一戳
@ -680,14 +680,14 @@ Type: `tts`
**上报数据** **上报数据**
| 字段 | 类型 | 可能的值 | 说明 | | 字段 | 类型 | 可能的值 | 说明 |
| ------------- | ------ | -------------- | -------------- | | ------------- | ------ | -------- | -------- |
| `post_type` | string | `notice` | 上报类型 | | `post_type` | string | `notice` | 上报类型 |
| `notice_type` | string | `notify` | 消息类型 | | `notice_type` | string | `notify` | 消息类型 |
| `group_id` | int64 | | 群号 | | `group_id` | int64 | | 群号 |
| `sub_type` | string | `poke` | 提示类型 | | `sub_type` | string | `poke` | 提示类型 |
| `user_id` | int64 | | 发送者id | | `user_id` | int64 | | 发送者id |
| `target_id` | int64 | | 被戳者id | | `target_id` | int64 | | 被戳者id |
#### 群红包运气王提示 #### 群红包运气王提示
@ -695,14 +695,14 @@ Type: `tts`
**上报数据** **上报数据**
| 字段 | 类型 | 可能的值 | 说明 | | 字段 | 类型 | 可能的值 | 说明 |
| ------------- | ------ | -------------- | -------------- | | ------------- | ------ | ------------ | ------------ |
| `post_type` | string | `notice` | 上报类型 | | `post_type` | string | `notice` | 上报类型 |
| `notice_type` | string | `notify` | 消息类型 | | `notice_type` | string | `notify` | 消息类型 |
| `group_id` | int64 | | 群号 | | `group_id` | int64 | | 群号 |
| `sub_type` | string | `lucky_king` | 提示类型 | | `sub_type` | string | `lucky_king` | 提示类型 |
| `user_id` | int64 | | 红包发送者id | | `user_id` | int64 | | 红包发送者id |
| `target_id` | int64 | | 运气王id | | `target_id` | int64 | | 运气王id |
#### 群成员荣誉变更提示 #### 群成员荣誉变更提示
@ -710,14 +710,14 @@ Type: `tts`
**上报数据** **上报数据**
| 字段 | 类型 | 可能的值 | 说明 | | 字段 | 类型 | 可能的值 | 说明 |
| ------------- | ------ | -------------- | -------------- | | ------------- | ------ | -------------------------------------------------------- | -------- |
| `post_type` | string | `notice` | 上报类型 | | `post_type` | string | `notice` | 上报类型 |
| `notice_type` | string | `notify` | 消息类型 | | `notice_type` | string | `notify` | 消息类型 |
| `group_id` | int64 | | 群号 | | `group_id` | int64 | | 群号 |
| `sub_type` | string | `honor` | 提示类型 | | `sub_type` | string | `honor` | 提示类型 |
| `user_id` | int64 | | 成员id | | `user_id` | int64 | | 成员id |
| `honor_type` | string | `talkative:龙王` `performer:群聊之火` `emotion:快乐源泉` | 荣誉类型 | | `honor_type` | string | `talkative:龙王` `performer:群聊之火` `emotion:快乐源泉` | 荣誉类型 |
#### 群成员名片更新 #### 群成员名片更新
@ -725,14 +725,14 @@ 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 | | 群号 |
| `user_id` | int64 | | 成员id | | `user_id` | int64 | | 成员id |
| `card_new` | int64 | | 新名片 | | `card_new` | int64 | | 新名片 |
| `card_old` | int64 | | 旧名片 | | `card_old` | int64 | | 旧名片 |
> PS: 当名片为空时 `card_xx` 字段为空字符串, 并不是昵称 > PS: 当名片为空时 `card_xx` 字段为空字符串, 并不是昵称
@ -740,17 +740,17 @@ 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 |
| `file` | object | | 文件数据 | | `file` | object | | 文件数据 |
**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)
## 更新 ## 更新