Skip to content

Commit b693b2a

Browse files
authored
添加 /v1/group/info (#9)
* Update deploy-docs.yml * feat(docs): /v1/group/info
1 parent f0ab233 commit b693b2a

1 file changed

Lines changed: 128 additions & 0 deletions

File tree

src/api/v1/group.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,131 @@ title: group
44

55
未特别说明情况下请求域名均为 https://chat-go.jwzhd.com
66
没写请求/响应项目表示不需要相关参数.
7+
8+
## 获取群聊信息
9+
10+
POST /v1/group/info
11+
12+
请求头:
13+
14+
|名称|必须|备注|
15+
|-----|-----|-----|
16+
|token|||
17+
18+
::: warning
19+
此处响应数据部分项目需要在打开相应开关后才会出现,例如private必须打开群聊私有才能在响应数据中看到.
20+
:::
21+
22+
响应数据:
23+
```ProtoBuf
24+
status {
25+
number: 114514
26+
code: 1
27+
msg: "success"
28+
}
29+
data {
30+
id: "群聊ID"
31+
name: "群聊名称"
32+
avatar_url: "头像URL"
33+
avatar_id: 头像ID(数值)
34+
introduction: "群聊简介"
35+
member: 群人数(数值)
36+
created_by: "创建者ID"
37+
direct_join: 进群免审核,1为开启
38+
permisson_level: 权限等级(普通用户无此项,群主100,管理员2)
39+
history_msg: 历史消息,1为开启
40+
category_name: "分类名"
41+
category_id: 分类ID
42+
private: 是否私有,1为私有
43+
do_not_disturb: 免打扰,1为开启
44+
community_id: 加入社区的ID
45+
community_name: "加入社区的名称"
46+
top: 置顶会话,1为开启
47+
admin: "管理员ID,可以有多个"
48+
limited_msg_type: "被限制的消息类型,如1,2,3"
49+
owner: "群主ID"
50+
recommandation: 是否加入群推荐,1为开启
51+
tag_old: "标签"
52+
tag {
53+
id: 标签id(数值)
54+
text: "标签文字"
55+
color: "#FFFFFFFF"
56+
}
57+
}
58+
history_bot {
59+
id: "机器人ID"
60+
name: "机器人名称"
61+
order: 机器人序列(数据库中第N个用户/机器人/群组)
62+
avatar_url: "头像URL"
63+
avatar_id: 头像ID(数值)
64+
introduction: "机器人简介"
65+
created_by: "创建者ID"
66+
created_time: 创建时间戳
67+
user_number: 使用人数(数值)
68+
private: 1表示私有机器人.
69+
}
70+
```
71+
72+
::: details ProtoBuf数据结构
73+
```proto
74+
// 群聊信息
75+
message info_send {
76+
string id = 2;
77+
}
78+
79+
message info {
80+
Status status = 1;
81+
Group_data data = 2;
82+
repeated Bot_data history_bot = 3;
83+
84+
// 群聊数据
85+
message Group_data {
86+
string id = 1;
87+
string name = 2;
88+
string avatar_url = 3;
89+
uint64 avatar_id = 4; // 头像ID
90+
string introduction = 5;
91+
uint64 member = 6; // 群人数
92+
string created_by = 7;
93+
uint64 direct_join = 8; // 进群免审核
94+
uint64 permisson_level = 9; // 权限等级
95+
uint64 history_msg = 10; // 历史消息
96+
string category_name = 11; // 分类名
97+
uint64 category_id = 12; // 分类ID
98+
uint64 private = 13; // 是否为私有群聊
99+
uint64 do_not_disturb = 14; // 免打扰
100+
uint64 community_id = 15;
101+
string community_name = 16;
102+
uint64 top = 19; // 会话置顶
103+
repeated string admin = 20;
104+
string limited_msg_type = 22; // 被限制的消息类型,例如 1,2,3
105+
string owner = 23;
106+
uint64 recommandation = 24; // 是否加入群推荐
107+
repeated string tag_old = 26; // 标签(旧版)
108+
repeated Tag tag = 27;
109+
110+
// 已使用标签信息,2没啥用不解析了
111+
message Tag {
112+
uint64 id = 1; // 标签ID(貌似)
113+
string text = 3;
114+
string color = 4;
115+
}
116+
}
117+
118+
// 群聊中使用过的机器人数据
119+
message Bot_data {
120+
string id = 1;
121+
string name = 2;
122+
uint64 order = 3; // 看起来像是某种神秘递增数列
123+
string avatar_url = 4;
124+
uint64 avatar_id = 5;
125+
string introduction = 6;
126+
string created_by = 7;
127+
uint64 created_time = 8;
128+
uint64 user_number = 9; // 使用人数
129+
uint64 private = 10; // 是否为私有机器人
130+
}
131+
132+
}
133+
```
134+
:::

0 commit comments

Comments
 (0)