Skip to content

Commit f965cf8

Browse files
yyyytawayyyytawa
committed
Update
1 parent ab6e959 commit f965cf8

8 files changed

Lines changed: 235 additions & 0 deletions

File tree

‎src/.vuepress/navbar.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ export default navbar([
1515
text: "wss",
1616
link: "wss/"
1717
},
18+
{
19+
text: "web",
20+
link: "web/"
21+
},
1822
]
1923
},
2024
{

‎src/.vuepress/sidebar.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ export default sidebar(
55
"/api/v1/": "structure",
66
"/api/wss/": "structure",
77
"/云湖API吐槽/": "structure",
8+
"/api/web/v1/": "structure",
89
}
910
);

‎src/api/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,8 @@ title: API
1212

1313
> **[wss](./wss/)**
1414
> -云湖wss连接已记录的所有连接文档
15+
16+
* 3
17+
18+
> **[web](./web)**
19+
> -云湖 chat-web-go API文档

‎src/api/web/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: chat-web-go
3+
index: false
4+
article: false
5+
sitemap: false
6+
feed: false
7+
timeline: false
8+
---
9+
10+
[v1](./v1/)

‎src/api/web/v1/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: v1
3+
index: false
4+
feed: false
5+
timeline: false
6+
article: false
7+
---
8+
9+
这里存放的是 `chat-web-go.jwzhd.com` 的API文档.
10+
无特别说明,请求域名均为 `chat-web-go.jwzhd.com`.
11+
若无请求头/请求体部分表示此项无需特别填写.

‎src/api/web/v1/bot.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: bot
3+
---
4+
5+
## 获取机器人信息
6+
7+
POST /v1/bot/bot-info
8+
9+
请求体:
10+
11+
```JSON
12+
{"botId": "13972254" // 你要查询bot的ID }
13+
```
14+
15+
响应体:
16+
17+
```JSON
18+
{
19+
"code": 1,
20+
"data": {
21+
"bot": {
22+
"id": 44, // 机器人在数据库中的序列(?)
23+
"botId": "13972254", // botID
24+
"nickname": "迎宾小精灵", // 名称
25+
"nicknameId": 42878, // 名称ID
26+
"avatarId": 10959, // 头像ID
27+
"avatarUrl": "https://chat-img.jwznb.com/...", // 头像URL
28+
"token": "", // bot token(实际上就是空)
29+
"link": "", // bot订阅接口URL(实际上也是空)
30+
"introduction": "全员群机器人", // 简介
31+
"createBy": "7058262", // 创建者
32+
"createTime": 1650849911, // 创建时间
33+
"headcount": 1, // 使用人数
34+
"private": 1, // 私有
35+
"checkChatInfoRecord": {
36+
"id": 39, // 某种神秘的ID(?)
37+
"chatId": "13972254", // 对象ID
38+
"chatType": 3, // 对象类型
39+
"checkWay": "", // 也不知道干啥的
40+
"reason": "", // 原因(?)
41+
"status": 0, // 状态
42+
"createTime": 1670654316, // 创建时间
43+
"updateTime": 0, // 更新时间
44+
"delFlag": 0 // 是否被删除
45+
}
46+
}
47+
},
48+
"msg": "success"
49+
}
50+
```

‎src/api/web/v1/group.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: group
3+
---
4+
5+
## 获取群聊信息
6+
7+
POST /v1/group/group-info
8+
9+
请求体:
10+
11+
```JSON
12+
{"groupId": "big" // 你要查询群组的ID }
13+
```
14+
15+
响应体:
16+
17+
```JSON
18+
{
19+
"code": 1,
20+
"data": {
21+
"group": {
22+
"id": 1, // 群聊在数据库中的序列(?)
23+
"groupId": "big", // 群聊ID
24+
"name": "全员群", // 群聊名称
25+
"introduction": "15亿用户总群\n新注册用户默认加入这个群，请不要刷屏发消息\n不想用全员群可以选择退群，退群后也可以重新加入\n玩机问题进对应手机群询问，不要在全员群询问\n\n在开始聊天前请阅读全员群规范: https://www.yhchat.com/c/p/796\n\n如有引导性消费或者不在正规平台进行交易的 请谨慎交易\n如有人称是本软件官方人员 请公开询问此群管理员或ID ", // 群聊简介
26+
"createBy": "7058262", // 创建者
27+
"createTime": 0, // 创建时间戳
28+
"avatarId": 32040, // 头像ID
29+
"avatarUrl": "https://chat-img.jwznb.com/...", // 头像URL
30+
"headcount": 112998, // 群人数
31+
"readHistory": 1, // 历史消息, 1表示允许新成员获取以前的历史消息
32+
"category": "", // 分类
33+
"uri": "http://chat.jwznb.com:8888/open-apis/v1/bot/send?token=", // 不知道干啥的
34+
"groupBotRel": { // 也不知道干啥的
35+
"id": 0,
36+
"groupId": "",
37+
"botId": "",
38+
"delFlag": 0,
39+
"createTime": 0,
40+
"updateTsime": 0,
41+
"bot": {
42+
"id": 0,
43+
"botId": "",
44+
"nickname": "",
45+
"nicknameId": 0,
46+
"avatarId": 0,
47+
"avatarUrl": "",
48+
"token": "",
49+
"link": "",
50+
"introduction": "",
51+
"createBy": "",
52+
"createTime": 0,
53+
"headcount": 0,
54+
"private": 0,
55+
"checkChatInfoRecord": {
56+
"id": 0,
57+
"chatId": "",
58+
"chatType": 0,
59+
"checkWay": "",
60+
"reason": "",
61+
"status": 0,
62+
"createTime": 0,
63+
"updateTime": 0,
64+
"delFlag": 0
65+
}
66+
}
67+
},
68+
"checkChatInfoRecord": {
69+
"id": 1160, // 似乎是某种神秘的ID
70+
"chatId": "big", // 对象ID
71+
"chatType": 2, // 对象类型
72+
"checkWay": "", // 不知道干啥的
73+
"reason": "", // 还是不知道干啥的
74+
"status": 0, // 状态?
75+
"createTime": 1670655084, // 创建时间戳
76+
"updateTime": 1748487950, // 最近更新时间戳
77+
"delFlag": 0 // 是否被删除
78+
}
79+
}
80+
},
81+
"msg": "success"
82+
}
83+
```

‎src/api/web/v1/user.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: user
3+
---
4+
5+
## 获取用户自身信息
6+
7+
GET /v1/user/info
8+
9+
请求头:
10+
11+
|名称|必须|备注|
12+
|-----|-----|-----|
13+
|token|是|无|
14+
15+
响应体:
16+
17+
```JSON
18+
{
19+
"code": 1, // 响应码,1表示正常
20+
"data": {
21+
"user": {
22+
"userId": "7356666", // 用户ID
23+
"nickname": "test", // 用户名
24+
"phone": "17588888888", // 手机号
25+
"avatarId": "11451", // 头像ID
26+
"avatarUrl": "https://...", // 头像URL
27+
"goldCoinAmount": 114.51 // 金币数
28+
}
29+
},
30+
"msg": "success"
31+
}
32+
```
33+
34+
## 获取用户主页信息
35+
36+
GET /v1/user/homepage?userId=你要查询的用户ID(例如7058262)
37+
38+
::: tip
39+
如果用户不存在/已注销仍然会返回数据,特点就是无头像,名称,注册时间戳为0等.
40+
:::
41+
42+
响应体:
43+
44+
```JSON
45+
{
46+
"code": 1,
47+
"data": {
48+
"user": {
49+
"userId": "7058262", // 用户ID
50+
"nickname": "Feng", // 用户名
51+
"avatarUrl": "https://chat-img.jwznb.com/...", // 头像URL
52+
"registerTime": 1639627226, // 注册时间(时间戳)
53+
"registerTimeText": "2021-12-16 12:00:26", // 注册时间文本
54+
"onLineDay": 1190, // 在线天数
55+
"continuousOnLineDay": 277, // 连续在线天数
56+
"medals": [
57+
{
58+
"id": 1, // 勋章ID
59+
"name": "内测用户", // 勋章名称
60+
"desc": "内测用户", // 勋章描述
61+
"imageUrl": "", // 图像URL(?)
62+
"sort": 100 // 排序
63+
},
64+
// ...
65+
],
66+
"isVip": 1 // 是否为 VIP, 1为是VIP
67+
}
68+
},
69+
"msg": "success"
70+
}
71+
```

0 commit comments

Comments
 (0)