Skip to content

Commit 6c26da8

Browse files
yyyytawayyyytawa
committed
docs: 小修小改
1 parent 14f045c commit 6c26da8

10 files changed

Lines changed: 55 additions & 57 deletions

File tree

‎src/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ footer: 使用 <a href="https://theme-hope.vuejs.press/zh/" target="_blank">VueP
7373
}
7474
</style>
7575

76-
云湖已发现API及调用的非官方参考文档.目的是方便开发者进行二次开发使用.
76+
云湖已发现API及调用的非官方参考文档.方便开发者进行二次开发使用.
7777
**本文档默认你拥有相关编程基础,不解决过于小白的问题.**
78-
**所有API信息只做为公开参考**
78+
**所有API信息仅限参考**
7979
**所有API调用请遵循相关法律法规以及云湖的用户协议,本项目仅用于学习研究用途.**
8080
**由于文档的特殊性,可能会因为某些原因随时停止服务.**

‎src/api/v1/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ timeline: false
66
article: false
77
---
88

9-
这里存放的是 `v1` API 的文档.
9+
这里存放的是 `v1` 路由下的 API 的文档.
1010
无特别说明,请求域名均为 `https://chat-go.jwzhd.com/`
1111
一般为 JSON 或者是 ProtoBuf 格式.
1212
Proto 文件中的 Status 未特别备注均为下面内容:

‎src/api/v1/check.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: check
33
---
44

5-
> 未特别说明情况下请求域名均为 `https://chat-go.jwzhd.com` .
5+
未特别说明情况下请求域名均为 `https://chat-go.jwzhd.com` .
66

77
没写请求/响应项目表示不需要相关参数.
88

@@ -63,7 +63,7 @@ POST /v1/check/get-latest-version
6363
## 获取云湖新版本（Windows 版本）
6464

6565
```http request
66-
POST https://chat-go.jwzhd.com/v1/check/check-version
66+
POST /v1/check/check-version
6767
```
6868

6969
### 请求体

‎src/api/v1/group.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1120,3 +1120,47 @@ message dismiss_group {
11201120
```
11211121

11221122
:::
1123+
1124+
## 获取语音房间列表
1125+
1126+
POST /v1/group/live-room
1127+
1128+
请求头:
1129+
1130+
| 名称 | 必须 | 备注 |
1131+
| ----- | ---- | ---- |
1132+
| token | 是 | 无 |
1133+
1134+
请求体：
1135+
1136+
```JSONC
1137+
{
1138+
"groupId": "big" // 群聊id
1139+
}
1140+
```
1141+
1142+
响应体：
1143+
1144+
```JSONC
1145+
{
1146+
"code": 1, // 请求状态码，1为正常
1147+
"data": {
1148+
"rooms": [
1149+
{
1150+
"userId": "1234567", // 用户id
1151+
"roomId": "c7552ca7c79546dd93baca4e4adxxxxx", // 房间id
1152+
"chatId": "123456789", // 房间所发起的会话id
1153+
"title": "", // 房间标题
1154+
"chatType": 2, // 房间所发起的会话类型
1155+
"status": 0, // 房间状态
1156+
"createBy": "1234567", // 发起房间的用户id
1157+
"createTime": 1775881889, // 房间创建时间戳
1158+
"nickname": "111", // 房间创建者名称
1159+
"count": 1, // 房间人数
1160+
"avatarUrl": "https://chat-img.jwznb.com/defalut-avatars/Nellie%20Bly.png" // 房间创建者头像Url
1161+
}
1162+
]
1163+
},
1164+
"msg": "success" // 返回消息
1165+
}
1166+
```

‎src/api/v1/live.md‎

Lines changed: 1 addition & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ POST /v1/live/add
3030
{
3131
"code": 1, // 请求状态码，1为正常
3232
"data": {
33-
"joinToken: ": "123123123123123123", // 语音频道进入token
33+
"joinToken": "123123123123123123", // 语音频道进入token,是 livekit 的 access_token
3434
},
3535
"msg": "success" // 返回消息
3636
}
@@ -205,47 +205,3 @@ POST /v1/live/get-calling
205205
```
206206

207207
:::
208-
209-
## 获取语音房间列表
210-
211-
POST /v1/group/live-room
212-
213-
请求头:
214-
215-
| 名称 | 必须 | 备注 |
216-
| ----- | ---- | ---- |
217-
| token | 是 | 无 |
218-
219-
请求体：
220-
221-
```JSONC
222-
{
223-
"groupId": "big" // 群聊id
224-
}
225-
```
226-
227-
响应体：
228-
229-
```JSONC
230-
{
231-
"code": 1, // 请求状态码，1为正常
232-
"data": {
233-
"rooms": [
234-
{
235-
"userId": "1234567", // 用户id
236-
"roomId": "c7552ca7c79546dd93baca4e4adxxxxx", // 房间id
237-
"chatId": "123456789", // 房间所发起的会话id
238-
"title": "", // 房间标题
239-
"chatType": 2, // 房间所发起的会话类型
240-
"status": 0, // 房间状态
241-
"createBy": "1234567", // 发起房间的用户id
242-
"createTime": 1775881889, // 房间创建时间戳
243-
"nickname": "111", // 房间创建者名称
244-
"count": 1, // 房间人数
245-
"avatarUrl": "https://chat-img.jwznb.com/defalut-avatars/Nellie%20Bly.png" // 房间创建者头像Url
246-
}
247-
]
248-
},
249-
"msg": "success" // 返回消息
250-
}
251-
```

‎src/api/v1/mount-setting.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ POST /v1/mount-setting/create
1313

1414
| 名称 | 必须 | 备注 |
1515
| ----- | ---- | ----------------- |
16-
| token | 是 | 目标群管理员token |
16+
| token | 是 | 普通用户的 token 也可(若后续改了欢迎 PR) |
1717

1818
请求体:
1919

@@ -45,7 +45,7 @@ POST /v1/mount-setting/delete
4545

4646
| 名称 | 必须 | 备注 |
4747
| ----- | ---- | ----------------- |
48-
| token | 是 | 目标群管理员token |
48+
| token | 是 | 普通用户的 token 也可(若后续改了欢迎 PR) |
4949

5050
请求体:
5151

‎src/api/v1/user.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,7 @@ POST /v1/user/module-ignore
598598

599599
```JSONC
600600
{
601-
"deviceId": "1234"
601+
"deviceId": "1234",
602602
"ignore": ",30,20,10" // 模块id，10-隐藏社区页面，20-隐藏发现页面，30-精简我的界面
603603
}
604604
```

‎src/api/web/README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,4 @@ timeline: false
99

1010
Web 端 API 文档
1111

12-
> [v1](./v1/)
13-
1412
<Catalog />

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ GET /v1/document/detail
5656

5757
| 名称 | 必须 | 备注 |
5858
| ---------- | ---- | ------------------------------ |
59-
| documentId | 是 | Id必须大写，这个参数必须带数字 |
59+
| documentId | 是 | 大小写敏感,类型必须是 int |
6060

6161
响应体：
6262

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ POST /v1/group/group-info
3535
"headcount": 112998, // 群人数
3636
"readHistory": 1, // 历史消息, 1表示允许新成员获取以前的历史消息
3737
"category": "", // 分类
38-
"uri": "http://chat.jwznb.com:8888/open-apis/v1/bot/send?token=", // 不知道干啥的
38+
"uri": "http://chat.jwznb.com:8888/open-apis/v1/bot/send?token=", // 不知道干啥的,别问为什么是 uri,我也不知道
3939
"groupBotRel": { // 也不知道干啥的
4040
"id": 0,
4141
"groupId": "",

0 commit comments

Comments
 (0)