API地址：https://[网站域名]/api.php
支持的登录认证方式：Session、Cookie、Authorization
?请求方式: GET
响应内容:
{
"status": "success",
"message": "Hello <UserName>"
}
?action=get-captcha-url请求方式: GET
响应内容:
{
"status": "success",
"captcha_token": "string",
"captcha_url": "string"
}
?action=login请求参数:
nick=<string>&password=<string>&aut_save=<int>
参数说明：nick -> 用户名、password -> 密码、aut_save -> 是否记住密码（可选，值为“1”就记住密码）
响应内容:
{
"status": "success",
"message": "login successful",
"data": {
"user_id": "int",
"login_id": "int",
"token": "string", // JWT token
"expiration": "int"
}
}
可能的报错内容:
用户名或密码错误:
{
"status": "error",
"message": "Incorrect username or password"
}
缺少nick或password参数:
```json { “status”: “error”, “message”: “Missing required parameters” }
?action=register请求参数:
reg_nick=<string>&password=<string>&captcha=<string>&captcha_token=<string>&email=<string>&pol=<1 or 0>
# pol参数为可选项
响应内容:
{
"status": "success",
"message": "registration successful",
"data": {
"user_id": "int",
}
}
如果开启了影响验证：
{
"status": "success",
"message": "verification email sent",
"data": {
"user_id": "int",
}
}
可能的报错内容:
已关闭注册:
{
"status": "error",
"message": "registration is closed"
}
缺少验证码:
{
"status": "error",
"message": "verification code is required"
}
captcha_token 格式错误:
{
"status": "error",
"message": "captcha_token format error"
}
captcha_token 已过期:
{
"status": "error",
"message": "captcha_token expired"
}
captcha_token 无效或已使用:
{
"status": "error",
"message": "captcha_token invalid or used"
}
验证码错误:
{
"status": "error",
"message": "incorrect verification code"
}
缺少昵称:
{
"status": "error",
"message": "nick is missing"
}
缺少密码:
{
"status": "error",
"message": "password is missing"
}
缺少电子邮箱参数:
{
"status": "error",
"message": "email is missing"
}
邮箱地址格式错误:
{
"status": "error",
"message": "invalid email address"
}
昵称含有非法字符:
{
"status": "error",
"message": "invalid characters in nick"
}
昵称短于3个字符:
{
"status": "error",
"message": "nick too short"
}
昵称长度超过32个字符:
{
"status": "error",
"message": "nick too long"
}
用户名已注册:
{
"status": "error",
"message": "nick already registered"
}
电子邮件已注册:
{
"status": "error",
"message": "email already registered"
}
密码长度不能短于6个字符:
{
"status": "error",
"message": "password too short"
}
密码长度超过32个字符:
{
"status": "error",
"message": "password too long"
}
注册验证邮件已发送:
{
"status": "success",
"message": "verification email sent"
}
验证邮件发送失败:
{
"status": "error",
"message": "email sending failed: <错误原因>"
}
?action=logout响应内容:
{
"status": "success"
}
?action=forgot-password请求参数:
nick=<string>&email=<string>&captcha=<string>&captcha_token=<string>
响应内容:
{
"status": "success",
"message": "password reset email sent",
"data": {
"email": "<string>"
}
}
可能的报错内容:
邮件发送失败:
{
"status": "error",
"message": "email sending failed: <错误原因>"
}
邮箱地址错误:
{
"status": "error",
"message": "invalid email address"
}
昵称不存在:
{
"status": "error",
"message": "nick not found"
}
缺少参数:
{
"status": "error",
"message": "missing parameters"
}
?action=reset-password请求参数:
nick=<string>&email=<string>&token=<string>&password=<string>
响应内容:
{
"status": "success",
"message": "reset password successfully",
"data": {
"user_id": "<int>"
}
}
?action=online-users请求方式: GET
响应内容:
{
"status": "success",
"users": [
{
"id": "<int>",
"last_online": "<Y-m-d H:i:s>"
},
{...}
]
}
?action=user-info&id=<int>请求方式: GET
响应内容:
{
"status": "success",
"data": [
{
"id": "<int>",
"nick": "<string>",
"date_reg": "<int>",
"balls": "<int>",
"browser": "<string>",
"money": "<int>",
"group_name": "<string>",
"pol": "<int>",
"date_last": "<int>"
}
]
}
id: 用户ID，nick: 用户昵称，date_reg: 注册时间，balls: 积分？，browser: 浏览器类型，money: 硬币，pol: 性别，date_last: 最后在线时间
?action=guest-msg-list&page=<int>请求方式: GET
响应内容:
{
"status": "success",
"data": [
{
"id": "<int>",
"id_user": "<int>",
"time": "<int>",
"msg": "<string>"
},
{...}
],
"all_pages": "<int>"
}
?action=guest-msg-add请求方式: POST
请求参数(已登录):
msg=<string>
请求参数(未登录):
msg=<string>&captcha=<string>&captcha_token=<string>
响应内容:
{
"status": "success",
"id": "<int>"
}
可能的报错内容:
缺少信息内容:
{
"status": "error",
"message": "msg not found"
}
在信息文本中发现了一个禁止字符:
{
"status": "error",
"message": "forbidden strings: <string>"
}
内容过长:
{
"status": "error",
"message": "content too long"
}
内容过短:
{
"status": "error",
"message": "content too short"
}
需要登录:
{
"status": "error",
"message": "not login"
}
?action=guest-users-list&page=<int>响应内容:
{
"status": "success",
"data": [
{
"id_user": "<int>",
"last_online": "<Y-m-d H:i:s>"
},
{...}
],
"all_pages": "<int>"
}
?action=guest-msg-delete请求方式: POST
请求参数:
id=<int>
响应内容:
{
"status": "success"
}
可能的报错内容:
需要登录:
{
"status": "error",
"message": "not login"
}
无权限:
{
"status": "error",
"message": "no permissions"
}
缺少 id 参数:
{
"status": "error",
"message": "msg id not found"
}
消息不存在:
{
"status": "error",
"message": "msg not exist"
}
?action=chat-rooms-list响应内容:
{
"status": "success",
"data": [
{
"id": "<int>",
"pos": "<int>",
"name": "<string>",
"umnik": "<string>",
"shutnik": "<string>",
"opis": "<string>"
},
{...}
]
}
id: 聊天室ID，pos: 排序ID，name: 聊天室名称，umnik：是否启用答题机器人，shutnik: 是否启用笑话机器人，opis: 聊天室描述
?action=chat-msg-list&room=<int>&page=<int>请求方式: GET
响应内容:
{
"status": "success",
"data": [
{
"id": "<int>",
"room": "<int>",
"id_user": "<int>",
"time": "<int>",
"msg": "<string>",
"vopros": "<int>",
"umnik_st": "<string>",
"shutnik": "<string>",
"privat": "<int>"
},
{...}
],
"all_pages": "<int>"
}
id: 信息ID，id_user: 用户ID，umnik_st：答题机器人的信息，shutnik: 笑话机器人的信息，privat: 私聊对象
可能的报错内容:
缺少room参数:
{
"status": "error",
"message": "room id not found"
}
请求的聊天室ID无效:
{
"status": "error",
"message": "room not found"
}
?action=chat-msg-get&room=<int>&id=<int>请求方式: GET
响应内容:
{
"status": "success",
"data": [
{
"id": "<int>",
"room": "<int>",
"id_user": "<int>",
"time": "<int>",
"msg": "<string>",
"vopros": "<int>",
"umnik_st": "<string>",
"shutnik": "<string>",
"privat": "<int>"
},
{...}
]
}
可能的报错内容:
缺少room参数:
{
"status": "error",
"message": "room id not found"
}
请求的聊天室ID无效:
{
"status": "error",
"message": "room not found"
}
缺少id参数:
{
"status": "error",
"message": "msg id not found"
}
?action=chat-msg-add&room=<int>请求方式: POST
请求参数:
msg=<string>
响应内容:
{
"status": "success",
"id": "<int>"
}
可能的报错内容:
缺少信息内容:
{
"status": "error",
"message": "msg not found"
}
在信息文本中发现了一个禁止字符:
{
"status": "error",
"message": "forbidden strings: <string>"
}
内容过长:
{
"status": "error",
"message": "content too long"
}
内容过短:
{
"status": "error",
"message": "content too short"
}
需要登录:
{
"status": "error",
"message": "not login"
}