Skip to content
This repository has been archived by the owner on Aug 2, 2020. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stdrc committed Oct 22, 2017
1 parent 75da2d4 commit 0edf55c
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 1 deletion.
39 changes: 39 additions & 0 deletions docs/3.0/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,45 @@ GET /send_private_msg?access_token=kSLuTF2GC2Q4q4ugm3&user_id=123456&message=hel
| `plugin_build_number` | number | HTTP API 插件 build 号 |
| `plugin_build_configuration` | string | HTTP API 插件编译配置,`debug``release` |

### `/set_restart` 重启酷 Q,并以当前登录号自动登录(需勾选快速登录)

> v3.0.2 新增
#### 参数


#### 响应数据


## API 列表(试验性)

3.0.2 版本开始加入了一些并非酷 Q 原生提供的接口,可以一定程度上增强实用性,但不保证随时可用,且接口可能会在后面的版本中发生变动。

所有试验性接口都以下划线(`_`)开头。

### `/_get_friend_list` 获取好友列表

> v3.0.2 新增
#### 参数


#### 响应数据

响应内容为 JSON 数组,每个元素为一个好友分组,格式如下:

| 字段名 | 数据类型 | 说明 |
| ----- | ------- | --- |
| `friend_group_id` | number | 好友分组 ID |
| `friend_group_name` | string | 好友分组名称 |
| `friends` | array | 分组中的好友 |
| `friends[i].nickname` | string | 好友昵称 |
| `friends[i].remark` | string | 好友备注 |
| `friends[i].user_id` | number | 好友 QQ 号 |

## 获取 `data` 目录中的文件的接口

2.1.0 版本开始提供一个简单的静态文件获取服务,请求方式只支持 GET,URL 路径为 `/data/` 加上要请求的文件相对于酷 Q `data` 目录的路径。例如,假设酷 Q 主目录在 `C:\Apps\CQA`,则要获取 `C:\Apps\CQA\data\image\ABCD.jpg.cqimg` 的话,只需请求 `/data/image/ABCD.jpg.cqimg`,响应内容即为要请求的文件。
Expand Down
3 changes: 2 additions & 1 deletion docs/3.0/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,5 @@ secret=kP9yK2lrGxoymmpo
| `update_source` | `https://raw.githubusercontent.com/richardchien/coolq-http-api-release/master/` | 更新源,默认使用 GitHub 的 [richardchien/coolq-http-api-release](https://github.com/richardchien/coolq-http-api-release) 仓库,对于酷 Q 运行在国内的情况,可以换成 `https://gitee.com/richardchien/coolq-http-api-release/raw/master/` |
| `update_channel` | `stable` | 更新通道,目前有 `stable``beta` 两个 |
| `auto_check_update` | `no` | 是否自动检查更新(每次启用插件时检查),`yes``true` 表示启用,否则不启用,不启用的情况下,仍然可以在酷 Q 应用菜单中手动检查更新 |
| `thread_pool_size` | `4` | 工作线程池大小,用于异步发送消息和一些其它小的异步任务,应根据计算机性能和实际需求适当调节 |
| `thread_pool_size` | `4` | 工作线程池大小,用于异步发送消息和一些其它小的异步任务,应根据计算机性能和实际需求适当调节,若设为 0,则使用 `CPU 核心数 * 2 + 1` |
| `server_thread_pool_size` | `1` | API 服务器线程池大小,用于异步处理请求,应根据计算机性能和实际需求适当调节,若设为 0,则使用 `CPU 核心数 * 2 + 1` |

0 comments on commit 0edf55c

Please sign in to comment.