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

doc: document some new API

Browse Source 
For #1009
This commit is contained in:
wdvxdr 2022-06-24 10:15:29 +08:00
parent 1d859dc373
commit 71ba266a8c
No known key found for this signature in database
GPG Key ID: 703F8C071DE7A1B6
1 changed files with 48 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
docs/cqhttp.md
View File

@ -491,6 +491,18 @@ Type: `tts`
示例: `[CQ:tts,text=这是一条测试消息]`
### 猜拳消息
Type: `rps`
参数:
| 参数名 | 类型 | 说明 |
|---------|-----|------------------|
| `value` | int | 0：石头, 1：剪刀, 2：布 |
示例: `[CQ:rps,value=0]`
## API
### 设置群名
@ -613,15 +625,16 @@ Type: `tts`
}
````
### 发送合并转发(群)
### 发送合并转发(群/私聊)
终结点: `/send_group_forward_msg`
终结点: `/send_group_forward_msg`, `send_private_forward_msg`, `send_forward_msg`
**参数**
| 字段 | 类型 | 说明 |
| ---------- | -------------- | ---------------------------- |
| `group_id` | int64 | 群号 |
| 字段 | 类型 | 说明 |
|------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `group_id` | int64 | 群号 |
| `user_id` | int64 | 私聊QQ号 |
| `messages` | forward node[] | 自定义转发消息, 具体看 [CQCode](https://github.com/Mrs4s/go-cqhttp/blob/master/docs/cqhttp.md#%E5%90%88%E5%B9%B6%E8%BD%AC%E5%8F%91%E6%B6%88%E6%81%AF%E8%8A%82%E7%82%B9) |
响应数据
@ -883,6 +896,36 @@ Type: `tts`
> 在不提供 `folder` 参数的情况下默认上传到根目录
> 只能上传本地文件, 需要上传 `http` 文件的话请先调用 `download_file` API下载
### 上传私聊文件
终结点: `/upload_group_file`
**参数**
| 字段 | 类型 | 说明 |
|-----------|--------|--------|
| `user_id` | int64 | 接收者id |
| `file` | string | 本地文件路径 |
| `name` | string | 储存名称 |
> 只能上传本地文件, 需要上传 `http` 文件的话请先调用 `download_file` API下载
### 设置 QQ 个人资料
终结点: `/set_qq_profile`
**参数**
| 字段 | 类型 | 说明 |
|-----------------|--------|------|
| `nickname` | int64 | 昵称 |
| `company` | string | 公司 |
| `email` | string | 邮箱 |
| `college` | string | 大学 |
| `personal_note` | string | 个人签名 |
> 所有参数字段都为可选。
### 获取状态
终结点: `/get_status`