Version | Update Time | Status | Author | Description |
---|---|---|---|---|
v2023-07-30 02:38:52 |
2023-07-30 02:38:52 |
auto |
@renxing |
Created by smart-doc |
1.管理员相关
1.1.请求登录qq机器人
Type:POST
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:请求登录qq机器人
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
int64 |
qq号 |
false |
- |
Request-example:
curl -X POST -i http://{{server}}/admin/remoteLoginQQBot
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
flag |
boolean |
结果标志,true为成功,false为失败 |
- |
msg |
string |
结果消息,一般反馈给用户 |
- |
data |
object |
结果数据,一般反馈给前端进行处理 |
- |
Response-example:
{
"flag": true,
"msg": "返回的消息"
}
1.2.获取验证码url
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:获取验证码url
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
int64 |
在{@link #remoteLoginQQBot(Long)}中请求的qq号 |
false |
- |
Request-example:
curl -X GET -i http://{{server}}/admin/getRemoteLoginQQBotUrl?qq=639
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
flag |
boolean |
结果标志,true为成功,false为失败 |
- |
msg |
string |
结果消息,一般反馈给用户 |
- |
data |
string |
结果数据,一般反馈给前端进行处理 |
- |
Response-example:
{
"flag": true,
"msg": "返回的消息",
"data": "i84ub6"
}
1.3.提交qq机器人登录验证码ticket
Type:POST
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:提交qq机器人登录验证码ticket
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
int64 |
在{@link #remoteLoginQQBot(Long)}中请求的qq号 |
false |
- |
|
ticket |
string |
验证码ticket |
false |
- |
Request-example:
curl -X POST -i http://{{server}}/admin/submitTicket
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
flag |
boolean |
结果标志,true为成功,false为失败 |
- |
msg |
string |
结果消息,一般反馈给用户 |
- |
data |
object |
结果数据,一般反馈给前端进行处理 |
- |
Response-example:
{
"flag": true,
"msg": "返回的消息"
}
2.系统类
2.1.获取机器人公开列表
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
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号 |
- |
└─protocol |
enum |
登陆协议<br>ANDROID_PHONE,0<br>ANDROID_PAD,1<br>ANDROID_WATCH,2<br>IPAD,3<br>MACOS,4 |
- |
└─qrCodeLogin |
boolean |
是否二维码登陆,目前仅支持macOS和AndroidPAD协议 |
- |
└─name |
string |
QQ昵称 |
- |
└─state |
int32 |
在线状态 |
- |
└─remarks |
string |
备注 |
- |
Response-example:
{
"flag": true,
"msg": "返回的消息",
"data": [
{
"number": 1277489864,
"protocol": 2,
"qrCodeLogin": true,
"name": "会飞的任性",
"state": 1,
"remarks": "我是备注"
}
]
}
2.2.获取所有公告
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
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": 204,
"main": "这是公告内容",
"color": "#ff0000"
}
]
}
2.3.获取QQ登录URL
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
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": "36h0te"
}
3.消息处理
3.1.推送消息
Type:POST
Author:Renxing
Content-Type:application/json; charset=utf-8
Description:推送消息
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
cipher |
string |
个人密钥 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
content |
string |
消息内容 |
true |
- |
meta |
object |
消息元数据 |
false |
- |
└─type |
string |
消息类型,目前仅支持"qq"、"qq_group、telegram" |
false |
- |
└─data |
string |
消息元数据,与type对应。<br>qq-QQ号,qq_group-QQ群号,telegram-telegramID |
true |
- |
└─qqBot |
int64 |
指定QQ机器人号码 |
false |
- |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://{{server}}/msg/send/CH32p41OXu --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": "返回的消息"
}
4.用户相关
4.1.用户webauthn令牌注册请求
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:用户webauthn令牌注册请求
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id |
string |
No comments found. |
false |
- |
creationTime |
int64 |
No comments found. |
false |
- |
maxInactiveInterval |
int32 |
No comments found. |
false |
- |
lastAccessedTime |
int64 |
No comments found. |
false |
- |
servletContext |
object |
No comments found. |
false |
- |
└─classLoader |
object |
No comments found. |
false |
- |
└─majorVersion |
int32 |
No comments found. |
false |
- |
└─minorVersion |
int32 |
No comments found. |
false |
- |
└─defaultSessionTrackingModes |
array |
No comments found. |
false |
- |
└─responseCharacterEncoding |
string |
No comments found. |
false |
- |
└─requestCharacterEncoding |
string |
No comments found. |
false |
- |
└─effectiveSessionTrackingModes |
array |
No comments found. |
false |
- |
└─servletRegistrations |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─virtualServerName |
string |
No comments found. |
false |
- |
└─effectiveMinorVersion |
int32 |
No comments found. |
false |
- |
└─jspConfigDescriptor |
object |
No comments found. |
false |
- |
└─jspPropertyGroups |
array |
No comments found. |
false |
- |
└─taglibs |
array |
No comments found. |
false |
- |
└─contextPath |
string |
No comments found. |
false |
- |
└─servletContextName |
string |
No comments found. |
false |
- |
└─filterRegistrations |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─effectiveMajorVersion |
int32 |
No comments found. |
false |
- |
└─serverInfo |
string |
No comments found. |
false |
- |
└─sessionTimeout |
int32 |
No comments found. |
false |
- |
└─initParameterNames |
object |
No comments found. |
false |
- |
└─sessionCookieConfig |
object |
No comments found. |
false |
- |
└─domain |
string |
No comments found. |
false |
- |
└─name |
string |
No comments found. |
false |
- |
└─path |
string |
No comments found. |
false |
- |
└─attributes |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─comment |
string |
No comments found. |
false |
- |
└─secure |
boolean |
No comments found. |
false |
- |
└─maxAge |
int32 |
No comments found. |
false |
- |
└─httpOnly |
boolean |
No comments found. |
false |
- |
└─attributeNames |
object |
No comments found. |
false |
- |
attributeNames |
object |
No comments found. |
false |
- |
new |
boolean |
No comments found. |
false |
- |
Request-example:
curl -X GET -i http://{{server}}/user/webauthnRegReq?servletContext.sessionCookieConfig.httpOnly=true&servletContext.responseCharacterEncoding=lfijaj&servletContext.effectiveMinorVersion=720&servletContext.sessionCookieConfig.secure=true&servletContext.requestCharacterEncoding=4yv0nm&servletContext.sessionCookieConfig.name=ruthie.hansen&servletContext.sessionTimeout=744&servletContext.contextPath=9fje4g&servletContext.sessionCookieConfig.path=p3nlkx&new=true&servletContext.sessionCookieConfig.maxAge=15&servletContext.servletContextName=ruthie.hansen&servletContext.sessionCookieConfig.domain=mayert.net&servletContext.serverInfo=jvj8w6&servletContext.effectiveMajorVersion=418&servletContext.majorVersion=292&maxInactiveInterval=764&servletContext.sessionCookieConfig.comment=iv9ecq&servletContext.minorVersion=413&creationTime=1690655933222&lastAccessedTime=1690655933222&id=187&servletContext.virtualServerName=ruthie.hansen
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
flag |
boolean |
结果标志,true为成功,false为失败 |
- |
msg |
string |
结果消息,一般反馈给用户 |
- |
data |
object |
结果数据,一般反馈给前端进行处理 |
- |
└─array |
boolean |
No comments found. |
- |
└─valueNode |
boolean |
No comments found. |
- |
└─containerNode |
boolean |
No comments found. |
- |
└─missingNode |
boolean |
No comments found. |
- |
└─object |
boolean |
No comments found. |
- |
Response-example:
{
"flag": true,
"msg": "返回的消息",
"data": {
"array": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"object": true
}
}
4.2.用户webauthn令牌注册响应
Type:POST
Author:Renxing
Content-Type:application/json; charset=utf-8
Description:用户webauthn令牌注册响应
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
publicKeyCredentialJson |
string |
No comments found. |
false |
- |
id |
string |
No comments found. |
false |
- |
creationTime |
int64 |
No comments found. |
false |
- |
maxInactiveInterval |
int32 |
No comments found. |
false |
- |
lastAccessedTime |
int64 |
No comments found. |
false |
- |
servletContext |
object |
No comments found. |
false |
- |
└─classLoader |
object |
No comments found. |
false |
- |
└─majorVersion |
int32 |
No comments found. |
false |
- |
└─minorVersion |
int32 |
No comments found. |
false |
- |
└─defaultSessionTrackingModes |
array |
No comments found. |
false |
- |
└─responseCharacterEncoding |
string |
No comments found. |
false |
- |
└─requestCharacterEncoding |
string |
No comments found. |
false |
- |
└─effectiveSessionTrackingModes |
array |
No comments found. |
false |
- |
└─servletRegistrations |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─virtualServerName |
string |
No comments found. |
false |
- |
└─effectiveMinorVersion |
int32 |
No comments found. |
false |
- |
└─jspConfigDescriptor |
object |
No comments found. |
false |
- |
└─jspPropertyGroups |
array |
No comments found. |
false |
- |
└─taglibs |
array |
No comments found. |
false |
- |
└─contextPath |
string |
No comments found. |
false |
- |
└─servletContextName |
string |
No comments found. |
false |
- |
└─filterRegistrations |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─effectiveMajorVersion |
int32 |
No comments found. |
false |
- |
└─serverInfo |
string |
No comments found. |
false |
- |
└─sessionTimeout |
int32 |
No comments found. |
false |
- |
└─initParameterNames |
object |
No comments found. |
false |
- |
└─sessionCookieConfig |
object |
No comments found. |
false |
- |
└─domain |
string |
No comments found. |
false |
- |
└─name |
string |
No comments found. |
false |
- |
└─path |
string |
No comments found. |
false |
- |
└─attributes |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─comment |
string |
No comments found. |
false |
- |
└─secure |
boolean |
No comments found. |
false |
- |
└─maxAge |
int32 |
No comments found. |
false |
- |
└─httpOnly |
boolean |
No comments found. |
false |
- |
└─attributeNames |
object |
No comments found. |
false |
- |
attributeNames |
object |
No comments found. |
false |
- |
new |
boolean |
No comments found. |
false |
- |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://{{server}}/user/webauthnRegResp --data 'mi392c'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
flag |
boolean |
结果标志,true为成功,false为失败 |
- |
msg |
string |
结果消息,一般反馈给用户 |
- |
data |
object |
结果数据,一般反馈给前端进行处理 |
- |
Response-example:
{
"flag": true,
"msg": "返回的消息"
}
4.3.用户webauthn令牌登录请求
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:用户webauthn令牌登录请求
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id |
string |
No comments found. |
false |
- |
creationTime |
int64 |
No comments found. |
false |
- |
maxInactiveInterval |
int32 |
No comments found. |
false |
- |
lastAccessedTime |
int64 |
No comments found. |
false |
- |
servletContext |
object |
No comments found. |
false |
- |
└─classLoader |
object |
No comments found. |
false |
- |
└─majorVersion |
int32 |
No comments found. |
false |
- |
└─minorVersion |
int32 |
No comments found. |
false |
- |
└─defaultSessionTrackingModes |
array |
No comments found. |
false |
- |
└─responseCharacterEncoding |
string |
No comments found. |
false |
- |
└─requestCharacterEncoding |
string |
No comments found. |
false |
- |
└─effectiveSessionTrackingModes |
array |
No comments found. |
false |
- |
└─servletRegistrations |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─virtualServerName |
string |
No comments found. |
false |
- |
└─effectiveMinorVersion |
int32 |
No comments found. |
false |
- |
└─jspConfigDescriptor |
object |
No comments found. |
false |
- |
└─jspPropertyGroups |
array |
No comments found. |
false |
- |
└─taglibs |
array |
No comments found. |
false |
- |
└─contextPath |
string |
No comments found. |
false |
- |
└─servletContextName |
string |
No comments found. |
false |
- |
└─filterRegistrations |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─effectiveMajorVersion |
int32 |
No comments found. |
false |
- |
└─serverInfo |
string |
No comments found. |
false |
- |
└─sessionTimeout |
int32 |
No comments found. |
false |
- |
└─initParameterNames |
object |
No comments found. |
false |
- |
└─sessionCookieConfig |
object |
No comments found. |
false |
- |
└─domain |
string |
No comments found. |
false |
- |
└─name |
string |
No comments found. |
false |
- |
└─path |
string |
No comments found. |
false |
- |
└─attributes |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─comment |
string |
No comments found. |
false |
- |
└─secure |
boolean |
No comments found. |
false |
- |
└─maxAge |
int32 |
No comments found. |
false |
- |
└─httpOnly |
boolean |
No comments found. |
false |
- |
└─attributeNames |
object |
No comments found. |
false |
- |
attributeNames |
object |
No comments found. |
false |
- |
new |
boolean |
No comments found. |
false |
- |
Request-example:
curl -X GET -i http://{{server}}/user/webauthnLoginReq?servletContext.requestCharacterEncoding=bi7i3y&servletContext.virtualServerName=ruthie.hansen&servletContext.sessionCookieConfig.path=54ujhi&lastAccessedTime=1690655933222&servletContext.serverInfo=6mlvyc&servletContext.sessionCookieConfig.domain=mayert.net&id=187&servletContext.effectiveMajorVersion=548&servletContext.sessionTimeout=972&new=true&servletContext.sessionCookieConfig.name=ruthie.hansen&maxInactiveInterval=103&servletContext.sessionCookieConfig.comment=22meeb&servletContext.effectiveMinorVersion=281&servletContext.servletContextName=ruthie.hansen&servletContext.sessionCookieConfig.httpOnly=true&servletContext.contextPath=t29n0n&servletContext.sessionCookieConfig.maxAge=15&creationTime=1690655933222&servletContext.majorVersion=755&servletContext.responseCharacterEncoding=weru2k&servletContext.sessionCookieConfig.secure=true&servletContext.minorVersion=442
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
flag |
boolean |
结果标志,true为成功,false为失败 |
- |
msg |
string |
结果消息,一般反馈给用户 |
- |
data |
object |
结果数据,一般反馈给前端进行处理 |
- |
└─array |
boolean |
No comments found. |
- |
└─valueNode |
boolean |
No comments found. |
- |
└─containerNode |
boolean |
No comments found. |
- |
└─missingNode |
boolean |
No comments found. |
- |
└─object |
boolean |
No comments found. |
- |
Response-example:
{
"flag": true,
"msg": "返回的消息",
"data": {
"array": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"object": true
}
}
4.4.用户webauthn令牌登录响应
Type:POST
Author:Renxing
Content-Type:application/json; charset=utf-8
Description:用户webauthn令牌登录响应
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
publicKeyCredentialJson |
string |
前端传回的json字符串 |
false |
- |
id |
string |
No comments found. |
false |
- |
creationTime |
int64 |
No comments found. |
false |
- |
maxInactiveInterval |
int32 |
No comments found. |
false |
- |
lastAccessedTime |
int64 |
No comments found. |
false |
- |
servletContext |
object |
No comments found. |
false |
- |
└─classLoader |
object |
No comments found. |
false |
- |
└─majorVersion |
int32 |
No comments found. |
false |
- |
└─minorVersion |
int32 |
No comments found. |
false |
- |
└─defaultSessionTrackingModes |
array |
No comments found. |
false |
- |
└─responseCharacterEncoding |
string |
No comments found. |
false |
- |
└─requestCharacterEncoding |
string |
No comments found. |
false |
- |
└─effectiveSessionTrackingModes |
array |
No comments found. |
false |
- |
└─servletRegistrations |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─virtualServerName |
string |
No comments found. |
false |
- |
└─effectiveMinorVersion |
int32 |
No comments found. |
false |
- |
└─jspConfigDescriptor |
object |
No comments found. |
false |
- |
└─jspPropertyGroups |
array |
No comments found. |
false |
- |
└─taglibs |
array |
No comments found. |
false |
- |
└─contextPath |
string |
No comments found. |
false |
- |
└─servletContextName |
string |
No comments found. |
false |
- |
└─filterRegistrations |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─effectiveMajorVersion |
int32 |
No comments found. |
false |
- |
└─serverInfo |
string |
No comments found. |
false |
- |
└─sessionTimeout |
int32 |
No comments found. |
false |
- |
└─initParameterNames |
object |
No comments found. |
false |
- |
└─sessionCookieConfig |
object |
No comments found. |
false |
- |
└─domain |
string |
No comments found. |
false |
- |
└─name |
string |
No comments found. |
false |
- |
└─path |
string |
No comments found. |
false |
- |
└─attributes |
map |
No comments found. |
false |
- |
└─any object |
object |
any object. |
false |
- |
└─comment |
string |
No comments found. |
false |
- |
└─secure |
boolean |
No comments found. |
false |
- |
└─maxAge |
int32 |
No comments found. |
false |
- |
└─httpOnly |
boolean |
No comments found. |
false |
- |
└─attributeNames |
object |
No comments found. |
false |
- |
attributeNames |
object |
No comments found. |
false |
- |
new |
boolean |
No comments found. |
false |
- |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://{{server}}/user/webauthnLoginResp --data '9ctqmk'
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": 809,
"name": "这是用户名",
"admin": 0,
"config": {
"qqBot": 2816669521
},
"cipher": "CH32p41OXu",
"dayMaxSendCount": 200
}
}
4.5.用户登录
Type:POST
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:用户登录
Query-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
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": 687,
"name": "这是用户名",
"admin": 0,
"config": {
"qqBot": 2816669521
},
"cipher": "CH32p41OXu",
"dayMaxSendCount": 200
}
}
4.6.telegram登录
Type:POST
Author:Renxing
Content-Type:application/json; charset=utf-8
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; charset=utf-8' -i http://{{server}}/user/telegramLogin --data '{
"auth_date": 164,
"first_name": "ruthie.hansen",
"id": 997,
"last_name": "ruthie.hansen",
"photo_url": "www.juan-bogan.us",
"username": "ruthie.hansen",
"hash": "agxomz"
}'
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": 968,
"name": "这是用户名",
"admin": 0,
"config": {
"qqBot": 2816669521
},
"cipher": "CH32p41OXu",
"dayMaxSendCount": 200
}
}
4.7.telegram二维码登录
Type:POST
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:telegram二维码登录
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
code |
string |
No comments found. |
true |
- |
Request-example:
curl -X POST -i http://{{server}}/user/telegramQRCodeLogin --data 'code=91184'
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": 93,
"name": "这是用户名",
"admin": 0,
"config": {
"qqBot": 2816669521
},
"cipher": "CH32p41OXu",
"dayMaxSendCount": 200
}
}
4.8.注册
Type:POST
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:当开启极验验证码时需附带lot_number、captcha_output、pass_token、gen_time参数
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
name |
string |
用户名 |
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=ruthie.hansen&password=xwxz8j&lot_number=6vnryw&captcha_output=djmz9j&pass_token=81czdl&gen_time=2023-07-30 02:38:53'
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": 931,
"name": "这是用户名",
"admin": 0,
"config": {
"qqBot": 2816669521
},
"cipher": "CH32p41OXu",
"dayMaxSendCount": 200
}
}
4.9.重置个人密钥
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
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": "kkddh4"
}
4.10.获取个人资料
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
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": 737,
"name": "这是用户名",
"admin": 0,
"config": {
"qqBot": 2816669521
},
"cipher": "CH32p41OXu",
"dayMaxSendCount": 200
}
}
4.11.换绑QQ机器人
Type:POST
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:换绑QQ机器人
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
number |
int64 |
机器人号码 |
true |
- |
Request-example:
curl -X POST -i http://{{server}}/user/qq_bot --data 'number=144'
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": 52,
"name": "这是用户名",
"admin": 0,
"config": {
"qqBot": 2816669521
},
"cipher": "CH32p41OXu",
"dayMaxSendCount": 200
}
}
4.12.获取当日用户使用次数
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
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": 129
}
4.13.添加QQ群白名单
Type:POST
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:添加QQ群白名单
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
number |
int64 |
群号码 |
true |
- |
Request-example:
curl -X POST -i http://{{server}}/user/qqGroupWhitelist --data 'number=135'
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": 788,
"groupName": "ruthie.hansen",
"number": 807374699,
"userId": 497
}
}
4.14.获取QQ群白名单列表
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
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": 583,
"groupName": "ruthie.hansen",
"number": 807374699,
"userId": 490
}
]
}
4.15.删除QQ群白名单
Type:DELETE
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:删除QQ群白名单
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id |
int64 |
白名单id |
true |
- |
Request-example:
curl -X DELETE -i http://{{server}}/user/qqGroupWhitelist/327
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
flag |
boolean |
结果标志,true为成功,false为失败 |
- |
msg |
string |
结果消息,一般反馈给用户 |
- |
data |
boolean |
结果数据,一般反馈给前端进行处理 |
- |
Response-example:
{
"flag": true,
"msg": "返回的消息",
"data": true
}
4.16.添加消息回调
Type:POST
Author:Renxing
Content-Type:application/json; charset=utf-8
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 |
回调反馈 |
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; charset=utf-8' -i http://{{server}}/user/messageCallback --data '{
"id": 40,
"uid": 958,
"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 |
回调反馈 |
- |
└─sender |
string |
发件人 |
- |
└─group |
string |
所在群组 |
- |
└─message |
string |
原消息内容 |
- |
└─reply |
boolean |
是否回应 |
- |
└─response |
string |
回应语 |
- |
Response-example:
{
"flag": true,
"msg": "返回的消息",
"data": {
"id": 607,
"uid": 683,
"appType": "qq",
"keyword": "keyword",
"callbackURL": "https://www.baidu.com/callback",
"feedback": "feedbackOK",
"sender": "1277489864",
"group": "1277489864",
"message": "我是一条消息",
"reply": true,
"response": "回调成功了"
}
}
4.17.获取消息回调列表
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
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 |
回调反馈 |
- |
└─sender |
string |
发件人 |
- |
└─group |
string |
所在群组 |
- |
└─message |
string |
原消息内容 |
- |
└─reply |
boolean |
是否回应 |
- |
└─response |
string |
回应语 |
- |
Response-example:
{
"flag": true,
"msg": "返回的消息",
"data": [
{
"id": 696,
"uid": 577,
"appType": "qq",
"keyword": "keyword",
"callbackURL": "https://www.baidu.com/callback",
"feedback": "feedbackOK",
"sender": "1277489864",
"group": "1277489864",
"message": "我是一条消息",
"reply": true,
"response": "回调成功了"
}
]
}
4.18.删除消息回调
Type:DELETE
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
Description:删除消息回调
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id |
int64 |
消息回调id |
true |
- |
Request-example:
curl -X DELETE -i http://{{server}}/user/messageCallback/783
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
flag |
boolean |
结果标志,true为成功,false为失败 |
- |
msg |
string |
结果消息,一般反馈给用户 |
- |
data |
boolean |
结果数据,一般反馈给前端进行处理 |
- |
Response-example:
{
"flag": true,
"msg": "返回的消息",
"data": true
}
4.19.退出账号
Type:GET
Author:Renxing
Content-Type:application/x-www-form-urlencoded;charset=utf-8
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
}