Skip to content

Commit 9211dfe

Browse files
committed
Update: /api/v1/group
1 parent 8638ef4 commit 9211dfe

1 file changed

Lines changed: 88 additions & 2 deletions

File tree

src/api/v1/group.md

Lines changed: 88 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ history_bot {
7575
```proto
7676
// 群聊信息
7777
message info_send {
78-
string id = 2;
78+
string group_id = 2;
7979
}
8080
8181
message info {
@@ -85,7 +85,7 @@ message info {
8585
8686
// 群聊数据
8787
message Group_data {
88-
string id = 1;
88+
string group_id = 1;
8989
string name = 2;
9090
string avatar_url = 3;
9191
uint64 avatar_id = 4; // 头像ID
@@ -135,6 +135,92 @@ message info {
135135

136136
:::
137137

138+
## 获取群成员列表
139+
140+
POST /v1/group/list-member
141+
142+
请求头:
143+
144+
|名称|必须|备注|
145+
|-----|----|----|
146+
|token|||
147+
148+
请求体:
149+
150+
```ProtoBuf
151+
data {
152+
size: 50 // 分页大小
153+
page: 1 // 页数
154+
}
155+
group_id: "big" // 群聊ID
156+
```
157+
158+
::: details ProtoBuf数据结构
159+
160+
```proto
161+
message list_member_send {
162+
Data data = 2;
163+
164+
message Data {
165+
int32 size = 1; // 分页大小
166+
int32 page = 2; // 页数
167+
}
168+
169+
string group_id = 3;
170+
}
171+
```
172+
173+
:::
174+
175+
响应体:
176+
177+
```ProtoBuf
178+
status {
179+
number: 114514
180+
code: 1
181+
msg: "success"
182+
}
183+
user {
184+
group_id: "big" // 所属群聊ID
185+
user_info {
186+
user_id: "7356666" // 用户ID
187+
name: "Feng" // 用户名
188+
avatar_url: "https://..." // 头像URL
189+
}
190+
permission_level: 100 // 权限等级, 群主100 管理员2 普通用户无/0
191+
gag_time: 123456 // 禁言时间戳
192+
is_gag: 0 // 是否处于禁言状态
193+
}
194+
// 可以有多个
195+
// ...
196+
```
197+
198+
::: details ProtoBuf数据结构
199+
200+
```proto
201+
message list_member {
202+
Status status = 1;
203+
repeated User user = 2;
204+
205+
message User {
206+
string group_id = 1;
207+
User_info user_info = 2;
208+
209+
message User_info {
210+
string user_id = 1;
211+
string name = 2;
212+
string avatar_url = 4;
213+
}
214+
215+
int32 permission_level = 3;
216+
uint64 gag_time = 4; // 禁言时间
217+
int32 is_gag = 5; // 是否被禁言
218+
}
219+
}
220+
```
221+
222+
:::
223+
138224
## 获取群聊语音房间
139225

140226
POST /v1/group/live-room

0 commit comments

Comments
 (0)