Skip to content

Commit e5cca80

Browse files
committed
Create group-tag.md
1 parent dfc66de commit e5cca80

1 file changed

Lines changed: 197 additions & 0 deletions

File tree

src/api/v1/group-tag.md

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
---
2+
title: group-tag
3+
---
4+
5+
未特别说明情况下请求域名均为 `https://chat-go.jwzhd.com`
6+
没写请求/响应项目表示不需要相关参数.
7+
8+
## 获取群组标签列表
9+
10+
POST /v1/group-tag/list
11+
12+
请求头:
13+
14+
|名称|必须|备注|
15+
|---|---|---|
16+
|token|||
17+
18+
请求体:
19+
20+
```JSONC
21+
{
22+
"groupId": "123456789", //要获取的群聊ID
23+
"size": 20,// 页面总数
24+
"page": 1,//页码
25+
"tag": ""// 搜索词语
26+
}
27+
```
28+
29+
响应体:
30+
31+
```JSONC
32+
{
33+
"code": 1,
34+
"data": {
35+
"list": [
36+
{
37+
"id": 1234, // 标签ID
38+
"groupId": "123456789", // 群聊ID
39+
"tag": "一个标签", // 标签名称
40+
"color": "#E91E63", // 标签颜色
41+
"desc": "", // 描述
42+
"sort": 0, // 排序
43+
"delFlag": 0,
44+
"createTime": 1753719847 // 创建时间
45+
}
46+
]
47+
},
48+
"msg": "success"
49+
}
50+
```
51+
52+
## 关联用户标签
53+
54+
POST /v1/group-tag/relate
55+
56+
请求头:
57+
58+
|名称|必须|备注|
59+
|---|---|---|
60+
|token||必须为群聊管理员token|
61+
62+
请求体:
63+
64+
```JSONC
65+
{
66+
"userId": "1234567", // 要关联的用户ID
67+
"tagGroupId": 1145 // 要关联的标签ID
68+
}
69+
```
70+
71+
响应体:
72+
73+
```JSONC
74+
{
75+
"code": 1, // 请求状态码,1为正常
76+
"msg": "success" // 返回状态消息
77+
}
78+
```
79+
80+
## 取消关联用户标签
81+
82+
POST /v1/group-tag/relate-cancel
83+
84+
请求头:
85+
86+
|名称|必须|备注|
87+
|---|---|---|
88+
|token||必须为群聊管理员token|
89+
90+
请求体:
91+
92+
```JSONC
93+
{
94+
"userId": "1234567", // 要关联的用户ID
95+
"tagGroupId": 1145 // 要关联的标签ID
96+
}
97+
```
98+
99+
响应体:
100+
101+
```JSONC
102+
{
103+
"code": 1, // 请求状态码,1为正常
104+
"msg": "success" // 返回状态消息
105+
}
106+
```
107+
108+
## 编辑群组标签
109+
110+
POST /v1/group-tag/edit
111+
112+
请求头:
113+
114+
|名称|必须|备注|
115+
|---|---|---|
116+
|token||必须为群聊管理员token|
117+
118+
请求体:
119+
120+
```JSONC
121+
{
122+
"id": 1234, // 要更改的标签ID
123+
"groupId": "123456789", // 要更改的标签所在的群聊ID
124+
"tag": "一个标签", // 标签名称
125+
"color": "#E91E63", // 标签颜色
126+
"desc": "", //,标签描述
127+
"sort": 0 // 标签排序
128+
}
129+
```
130+
131+
响应体:
132+
133+
```JSONC
134+
{
135+
"code": 1, // 请求状态码,1为正常
136+
"msg": "success" // 返回状态消息
137+
}
138+
```
139+
140+
## 新增群组标签
141+
142+
POST /v1/group-tag/create
143+
144+
请求头:
145+
146+
|名称|必须|备注|
147+
|---|---|---|
148+
|token||必须为群聊管理员token|
149+
150+
请求体:
151+
152+
```JSONC
153+
{
154+
"groupId": "123456789", // 要创建标签的群聊ID
155+
"tag": "标签名称", // 标签名称
156+
"color": "#2196F3", // 标签颜色
157+
"desc": "", // 标签描述
158+
"sort": 0 // 标签排序
159+
}
160+
161+
```
162+
163+
响应体:
164+
165+
```JSONC
166+
{
167+
"code": 1, // 请求状态码,1为正常
168+
"msg": "success" // 返回状态消息
169+
}
170+
```
171+
172+
## 删除群组标签
173+
174+
POST /v1/group-tag/delete
175+
176+
请求头:
177+
178+
|名称|必须|备注|
179+
|---|---|---|
180+
|token||必须为群聊管理员token|
181+
182+
请求体:
183+
184+
```JSONC
185+
{
186+
"id": 1234 // 要删除的标签ID
187+
}
188+
```
189+
190+
响应体:
191+
192+
```JSONC
193+
{
194+
"code": 1, // 请求状态码,1为正常
195+
"msg": "success" // 返回状态消息
196+
}
197+
```

0 commit comments

Comments
 (0)