Version Update Time Status Author Description

v2024-07-02 14:09:17

2024-07-02 14:09:17

auto

@renxing

Created by smart-doc

1.系统类

1.1.获取机器人公开列表

Type: GET

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 获取机器人公开列表

Request-example:

curl -X GET -i 'http://{{server}}/sys/qqbotlist'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

array

结果数据，一般反馈给前端进行处理

-

└─number

int64

QQ号

-

└─qrCodeLogin

boolean

是否二维码登陆,目前仅支持macOS和AndroidPAD协议

-

└─name

string

QQ昵称

-

└─state

int32

在线状态

-

└─remarks

string

备注

-

Response-example:

{"flag":true,"msg":"返回的消息","data":[{"number":1277489864,"qrCodeLogin":2,true,"name":"会飞的任性","state":1,"remarks":"我是备注"}]}

1.2.获取所有公告

Type: GET

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 获取所有公告

Request-example:

curl -X GET -i 'http://{{server}}/sys/note'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

array

结果数据，一般反馈给前端进行处理

-

└─id

int64

公告ID

-

└─main

string

公告内容

-

└─color

string

公告在前端显示的颜色

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": [
    {
      "id": 0,
      "main": "这是公告内容",
      "color": "#ff0000"
    }
  ]
}

1.3.获取QQ登录URL

Type: GET

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 获取QQ登录URL

Request-example:

curl -X GET -i 'http://{{server}}/sys/qqUrl'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

string

结果数据，一般反馈给前端进行处理

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": ""
}

2.用户相关

2.1.用户webauthn令牌注册请求

Type: GET

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 用户webauthn令牌注册请求

Request-example:

curl -X GET -i 'http://{{server}}/user/webauthnRegReq'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

└─array

boolean

No comments found.

-

└─containerNode

boolean

No comments found.

-

└─missingNode

boolean

No comments found.

-

└─valueNode

boolean

No comments found.

-

└─object

boolean

No comments found.

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": {
    "array": true,
    "containerNode": true,
    "missingNode": true,
    "valueNode": true,
    "object": true
  }
}

2.2.用户webauthn令牌注册响应

Type: POST

Author: Renxing

Content-Type: application/json

Description: 用户webauthn令牌注册响应

Body-parameters:

Parameter Type Description Required Since

publicKeyCredentialJson

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -i 'http://{{server}}/user/webauthnRegResp'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息"
}

2.3.用户webauthn令牌登录请求

Type: GET

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 用户webauthn令牌登录请求

Request-example:

curl -X GET -i 'http://{{server}}/user/webauthnLoginReq'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

└─array

boolean

No comments found.

-

└─containerNode

boolean

No comments found.

-

└─missingNode

boolean

No comments found.

-

└─valueNode

boolean

No comments found.

-

└─object

boolean

No comments found.

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": {
    "array": true,
    "containerNode": true,
    "missingNode": true,
    "valueNode": true,
    "object": true
  }
}

2.4.用户webauthn令牌登录响应

Type: POST

Author: Renxing

Content-Type: application/json

Description: 用户webauthn令牌登录响应

Body-parameters:

Parameter Type Description Required Since

publicKeyCredentialJson

string

前端传回的json字符串

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -i 'http://{{server}}/user/webauthnLoginResp'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

└─uid

int64

用户ID

-

└─name

string

用户名

-

└─admin

int32

是否为管理默认0否1是

-

└─config

object

用户配置

-

     └─qqBot

int64

绑定的机器人QQ号

-

└─cipher

string

用户密钥

-

└─dayMaxSendCount

int64

每日最大发送次数

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": {
    "uid": 0,
    "name": "这是用户名",
    "admin": 0,
    "config": {
      "qqBot": 2816669521
    },
    "cipher": "CH32p41OXu",
    "dayMaxSendCount": 200
  }
}

2.5.用户登录

Type: POST

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 用户登录

Body-parameters:

Parameter Type Description Required Since

name

string

No comments found.

false

-

password

string

No comments found.

false

-

Request-example:

curl -X POST -i 'http://{{server}}/user/login' --data 'password=""&name=""'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

└─uid

int64

用户ID

-

└─name

string

用户名

-

└─admin

int32

是否为管理默认0否1是

-

└─config

object

用户配置

-

     └─qqBot

int64

绑定的机器人QQ号

-

└─cipher

string

用户密钥

-

└─dayMaxSendCount

int64

每日最大发送次数

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": {
    "uid": 0,
    "name": "这是用户名",
    "admin": 0,
    "config": {
      "qqBot": 2816669521
    },
    "cipher": "CH32p41OXu",
    "dayMaxSendCount": 200
  }
}

2.6.telegram登录

Type: POST

Author: Renxing

Content-Type: application/json

Description: telegram登录

Body-parameters:

Parameter Type Description Required Since

auth_date

int64

No comments found.

true

-

first_name

string

No comments found.

false

-

id

int64

No comments found.

true

-

last_name

string

No comments found.

false

-

photo_url

string

No comments found.

false

-

username

string

No comments found.

false

-

hash

string

No comments found.

true

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -i 'http://{{server}}/user/telegramLogin' --data '{
  "auth_date": 0,
  "first_name": "",
  "id": 0,
  "last_name": "",
  "photo_url": "",
  "username": "",
  "hash": ""
}'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

└─uid

int64

用户ID

-

└─name

string

用户名

-

└─admin

int32

是否为管理默认0否1是

-

└─config

object

用户配置

-

     └─qqBot

int64

绑定的机器人QQ号

-

└─cipher

string

用户密钥

-

└─dayMaxSendCount

int64

每日最大发送次数

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": {
    "uid": 0,
    "name": "这是用户名",
    "admin": 0,
    "config": {
      "qqBot": 2816669521
    },
    "cipher": "CH32p41OXu",
    "dayMaxSendCount": 200
  }
}

2.7.telegram二维码登录

Type: POST

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: telegram二维码登录

Body-parameters:

Parameter Type Description Required Since

code

string

No comments found.

true

-

Request-example:

curl -X POST -i 'http://{{server}}/user/telegramQRCodeLogin' --data 'code='

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

└─uid

int64

用户ID

-

└─name

string

用户名

-

└─admin

int32

是否为管理默认0否1是

-

└─config

object

用户配置

-

     └─qqBot

int64

绑定的机器人QQ号

-

└─cipher

string

用户密钥

-

└─dayMaxSendCount

int64

每日最大发送次数

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": {
    "uid": 0,
    "name": "这是用户名",
    "admin": 0,
    "config": {
      "qqBot": 2816669521
    },
    "cipher": "CH32p41OXu",
    "dayMaxSendCount": 200
  }
}

2.8.注册

Type: POST

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 当开启极验验证码时需附带lot_number、captcha_output、pass_token、gen_time参数

Body-parameters:

Parameter Type Description Required Since

name

string

用户名 Validation[Length(min=3, max=20, message=用户名长度需大于3,小于20) ]

true

-

password

string

密码

true

-

lot_number

string

No comments found.

false

-

captcha_output

string

No comments found.

false

-

pass_token

string

No comments found.

false

-

gen_time

string

No comments found.

false

-

Request-example:

curl -X POST -i 'http://{{server}}/user/register' --data 'name=&password=&lot_number=&captcha_output=&pass_token=&gen_time='

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

└─uid

int64

用户ID

-

└─name

string

用户名

-

└─admin

int32

是否为管理默认0否1是

-

└─config

object

用户配置

-

     └─qqBot

int64

绑定的机器人QQ号

-

└─cipher

string

用户密钥

-

└─dayMaxSendCount

int64

每日最大发送次数

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": {
    "uid": 0,
    "name": "这是用户名",
    "admin": 0,
    "config": {
      "qqBot": 2816669521
    },
    "cipher": "CH32p41OXu",
    "dayMaxSendCount": 200
  }
}

2.9.重置个人密钥

Type: GET

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 重置个人密钥

Request-example:

curl -X GET -i 'http://{{server}}/user/refreshCipher'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

string

结果数据，一般反馈给前端进行处理

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": ""
}

2.10.获取个人资料

Type: GET

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 获取个人资料

Request-example:

curl -X GET -i 'http://{{server}}/user/profile'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

└─uid

int64

用户ID

-

└─name

string

用户名

-

└─admin

int32

是否为管理默认0否1是

-

└─config

object

用户配置

-

     └─qqBot

int64

绑定的机器人QQ号

-

└─cipher

string

用户密钥

-

└─dayMaxSendCount

int64

每日最大发送次数

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": {
    "uid": 0,
    "name": "这是用户名",
    "admin": 0,
    "config": {
      "qqBot": 2816669521
    },
    "cipher": "CH32p41OXu",
    "dayMaxSendCount": 200
  }
}

2.11.换绑QQ机器人

Type: POST

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 换绑QQ机器人

Body-parameters:

Parameter Type Description Required Since

number

int64

机器人号码 Validation[Length(min=6, message=机器人号码长度需大于6) ]

true

-

Request-example:

curl -X POST -i 'http://{{server}}/user/qq_bot' --data 'number=0'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

└─uid

int64

用户ID

-

└─name

string

用户名

-

└─admin

int32

是否为管理默认0否1是

-

└─config

object

用户配置

-

     └─qqBot

int64

绑定的机器人QQ号

-

└─cipher

string

用户密钥

-

└─dayMaxSendCount

int64

每日最大发送次数

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": {
    "uid": 0,
    "name": "这是用户名",
    "admin": 0,
    "config": {
      "qqBot": 2816669521
    },
    "cipher": "CH32p41OXu",
    "dayMaxSendCount": 200
  }
}

2.12.获取当日用户使用次数

Type: GET

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 获取当日用户使用次数

Request-example:

curl -X GET -i 'http://{{server}}/user/ToDayUseCount'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

int32

结果数据，一般反馈给前端进行处理

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": 0
}

2.13.添加QQ群白名单

Type: POST

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 添加QQ群白名单

Body-parameters:

Parameter Type Description Required Since

number

int64

群号码

true

-

Request-example:

curl -X POST -i 'http://{{server}}/user/qqGroupWhitelist' --data 'number=0'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

└─id

int64

id(添加时不传)

-

└─groupName

string

群名称

-

└─number

int64

群号码

-

└─userId

int64

绑定站内用户ID

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": {
    "id": 0,
    "groupName": "",
    "number": 807374699,
    "userId": 0
  }
}

2.14.获取QQ群白名单列表

Type: GET

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 获取QQ群白名单列表

Request-example:

curl -X GET -i 'http://{{server}}/user/qqGroupWhitelist'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

array

结果数据，一般反馈给前端进行处理

-

└─id

int64

id(添加时不传)

-

└─groupName

string

群名称

-

└─number

int64

群号码

-

└─userId

int64

绑定站内用户ID

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": [
    {
      "id": 0,
      "groupName": "",
      "number": 807374699,
      "userId": 0
    }
  ]
}

2.15.删除QQ群白名单

Type: DELETE

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 删除QQ群白名单

Path-parameters:

Parameter Type Description Required Since

id

int64

白名单id

true

-

Request-example:

curl -X DELETE -i 'http://{{server}}/user/qqGroupWhitelist/{id}'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

boolean

结果数据，一般反馈给前端进行处理

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": true
}

2.16.添加消息回调

Type: POST

Author: Renxing

Content-Type: application/json

Description: 添加消息回调

Body-parameters:

Parameter Type Description Required Since

id

int64

No comments found.

false

-

uid

int64

消息回调所属用户ID

false

-

appType

string

应用类型:qq/qq_group/telegram

false

-

keyword

string

关键词

false

-

callbackURL

string

回调地址

false

-

feedback

string

回调反馈 Validation[Length(max=3000) ]

false

-

sender

string

发件人

false

-

group

string

所在群组

false

-

message

string

原消息内容

false

-

reply

boolean

是否回应

false

-

response

string

回应语

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -i 'http://{{server}}/user/messageCallback' --data '{
  "id": 0,
  "uid": 0,
  "appType": "qq",
  "keyword": "keyword",
  "callbackURL": "https://www.baidu.com/callback",
  "feedback": "feedbackOK",
  "sender": "1277489864",
  "group": "1277489864",
  "message": "我是一条消息",
  "reply": true,
  "response": "回调成功了"
}'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

└─id

int64

No comments found.

-

└─uid

int64

消息回调所属用户ID

-

└─appType

string

应用类型:qq/qq_group/telegram

-

└─keyword

string

关键词

-

└─callbackURL

string

回调地址

-

└─feedback

string

回调反馈 Validation[Length(max=3000) ]

-

└─sender

string

发件人

-

└─group

string

所在群组

-

└─message

string

原消息内容

-

└─reply

boolean

是否回应

-

└─response

string

回应语

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": {
    "id": 0,
    "uid": 0,
    "appType": "qq",
    "keyword": "keyword",
    "callbackURL": "https://www.baidu.com/callback",
    "feedback": "feedbackOK",
    "sender": "1277489864",
    "group": "1277489864",
    "message": "我是一条消息",
    "reply": true,
    "response": "回调成功了"
  }
}

2.17.获取消息回调列表

Type: GET

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 获取消息回调列表

Request-example:

curl -X GET -i 'http://{{server}}/user/messageCallback'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

array

结果数据，一般反馈给前端进行处理

-

└─id

int64

No comments found.

-

└─uid

int64

消息回调所属用户ID

-

└─appType

string

应用类型:qq/qq_group/telegram

-

└─keyword

string

关键词

-

└─callbackURL

string

回调地址

-

└─feedback

string

回调反馈 Validation[Length(max=3000) ]

-

└─sender

string

发件人

-

└─group

string

所在群组

-

└─message

string

原消息内容

-

└─reply

boolean

是否回应

-

└─response

string

回应语

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": [
    {
      "id": 0,
      "uid": 0,
      "appType": "qq",
      "keyword": "keyword",
      "callbackURL": "https://www.baidu.com/callback",
      "feedback": "feedbackOK",
      "sender": "1277489864",
      "group": "1277489864",
      "message": "我是一条消息",
      "reply": true,
      "response": "回调成功了"
    }
  ]
}

2.18.删除消息回调

Type: DELETE

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 删除消息回调

Path-parameters:

Parameter Type Description Required Since

id

int64

消息回调id

true

-

Request-example:

curl -X DELETE -i 'http://{{server}}/user/messageCallback/{id}'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

boolean

结果数据，一般反馈给前端进行处理

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": true
}

2.19.退出账号

Type: GET

Author: Renxing

Content-Type: application/x-www-form-urlencoded

Description: 退出账号

Request-example:

curl -X GET -i 'http://{{server}}/user/logout'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

boolean

结果数据，一般反馈给前端进行处理

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息",
  "data": true
}

3.消息处理

3.1.推送消息

Type: POST

Author: Renxing

Content-Type: application/json

Description: 推送消息

Path-parameters:

Parameter Type Description Required Since

cipher

string

个人密钥

true

-

Body-parameters:

Parameter Type Description Required Since

content

string

消息内容 Validation[Length(max=3000, message=消息内容长度不能超过3000) ]

true

-

meta

object

消息元数据

false

-

└─type

string

消息类型，目前仅支持"qq"、"qq_group、telegram" Validation[Pattern(regexp= (^qq$|^qq_group$|^telegram$), message=type暂仅支持qq、qq_group、telegram) ]

false

-

└─data

string

消息元数据，与type对应。 qq-QQ号，qq_group-QQ群号，telegram-telegramID

true

-

└─qqBot

int64

指定QQ机器人号码

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -i 'http://{{server}}/msg/send/{cipher}' --data '{
  "content": "这是一条消息",
  "meta": {
    "type": "qq",
    "data": "1277489864",
    "qqBot": 1277489864
  }
}'

Response-fields:

Field Type Description Since

flag

boolean

结果标志，true为成功，false为失败

-

msg

string

结果消息，一般反馈给用户

-

data

object

结果数据，一般反馈给前端进行处理

-

Response-example:

{
  "flag": true,
  "msg": "返回的消息"
}
Top