1
0
mirror of https://github.com/Mrs4s/go-cqhttp.git synced 2025-05-04 19:17:37 +08:00
go-cqhttp/docs/adminApi.md
2020-11-17 01:23:44 +08:00

4.9 KiB
Raw Blame History

管理 API

支持跨域

公共参数

参数:

参数名 类型 说明
access_token string 校验口令config.json中配置

admin/do_restart

热重启

热重启

ps: 目前不支持ws部分的修改生效

methodPOST/GET

参数:

参数名 类型 说明

返回:

{"data": {}, "retcode": 0, "status": "ok"}

admin/get_web_write

拉取验证码/设备锁

method: GET

参数:

参数名 类型 说明

返回:

{"data": {"ispic": true,"picbase64":"xxxxx"}, "retcode": 0, "status": "ok"}
参数名 类型 说明
ispic bool 是否是验证码类型 true是false为不是比如设备锁
picbas64 string 验证码的base64编码内容加上头放入img标签即可显示

admin/do_web_write

web输入验证码/设备锁确认

method: POST formdata

参数:

参数名 类型 说明
input string 输入的内容

返回:

{"data": {}, "retcode": 0, "status": "ok"}

admin/do_restart_docker

冷重启

注意此api 会直接结束掉进程需要依赖docker/supervisor等进程管理工具来自动拉起

method: POST

参数:

参数名 类型 说明

返回:

{"data": {}, "retcode": 0, "status": "ok"}

admin/do_process_restart

冷重启

method: POST

参数:

参数名 类型 说明

返回:

{"data": {}, "retcode": 0, "status": "ok"}

admin/do_config_base

基础配置

method: POST formdata

参数:

参数名 类型 说明
uin string qq号
password string qq密码
enable_db string 是否启动数据库,填 'true' 或者 'false'
access_token string 授权 token

返回:

{"data": {}, "retcode": 0, "status": "ok"}

admin/do_config_http

http服务配置

method: POST formdata

参数:

参数名 类型 说明
port string 服务端口
host string 服务监听地址
enable string 是否启用 ,填 'true' 或者 'false'
timeout string http请求超时时间
post_url string post上报地址 不需要就填空字符串,或者不填
post_secret string post上报的secret 不需要就填空字符串,或者不填

返回:

{"data": {}, "retcode": 0, "status": "ok"}

admin/do_config_ws

正向ws设置

method: POST formdata

参数:

参数名 类型 说明
port string 服务端口
host string 服务监听地址
enable string 是否启用 ,填 'true' 或者 'false'

返回:

{"data": {}, "retcode": 0, "status": "ok"}

admin/do_config_reverse

反向ws配置

method: POST formdata

参数:

参数名 类型 说明
port string 服务端口
host string 服务监听地址
enable string 是否启用 ,填 'true' 或者 'false'

返回:

{"data": {}, "retcode": 0, "status": "ok"}

admin/do_config_json

直接修改 config.json配置

method: POST formdata

参数:

参数名 类型 说明
json string 完整的config.json的配合json字符串

返回:

{"data": {}, "retcode": 0, "status": "ok"}

admin/get_config_json

获取当前 config.json配置

method: GET

参数:

参数名 类型 说明

返回:

{"data": {"config":"xxxx"}, "retcode": 0, "status": "ok"}
参数名 类型 说明
config string 完整的config.json的配合json字符串