Skip to content

Commit 192ac8e

Browse files
QianLin-JiaxiQianLin-Jiaxi
committed
Update community.md
更新了新的API
1 parent d4af18d commit 192ac8e

1 file changed

Lines changed: 173 additions & 27 deletions

File tree

‎src/api/v1/community.md‎

Lines changed: 173 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ POST /v1/community/posts/create
2323
"groupId": "123", // 文本引用群聊ID
2424
"title": "测试文章标题", // 文章标题
2525
"content": "测试文章内容", // 文章内容
26-
"contentType": 1 // 文章内容类别，1-文本，2-markdown
26+
"contentType": 1, // 文章内容类别，1-文本，2-markdown
27+
"draftId": 123 // 草稿ID，若此值不为0则云湖会删除这里设定的草稿ID所对应的草稿
2728
}
2829
```
2930

@@ -239,11 +240,11 @@ POST /v1/community/posts/post-list
239240
"data": {
240241
"posts": [
241242
{
242-
"id": 11451, // 文章id
243+
"id": 123, // 文章id
243244
"baId": 41, // 分区id
244245
"senderId": "114514", // 文章作者id
245-
"senderNicknameId": 171342, // 发送者昵称 Id
246-
"senderAvatarId": 42481, // 发送者头像 Id
246+
"senderNicknameId": 123, // 发送者昵称 Id
247+
"senderAvatarId": 123, // 发送者头像 Id
247248
"groupId": "", // 绑定该分区且从这个群聊发送文章的群聊id
248249
"title": "我是标题", // 标题
249250
"contentType": 2, // 文章类型(2是Markdown，1是普通文本)
@@ -258,7 +259,7 @@ POST /v1/community/posts/post-list
258259
"collectNum": 0, // 收藏数量
259260
"amountNum": 0, // 投币数量
260261
"senderNickname": "文章作者id",
261-
"senderAvatar": "https://chat-img.jwznb.com/225f9d692979928a7734d9b8cc0a4d74.gif", // 作者头像url
262+
"senderAvatar": "https://.。。", // 作者头像url
262263
"createTimeText": "2025-08-05 16:30:13", // 创建文章时间
263264
"group": { // 以下是绑定该分区且从这个群聊发送文章的群聊id
264265
"id": 0, //
@@ -422,13 +423,13 @@ POST /v1/community/reward-record
422423
"reason": "打赏文章扣金币", // 扣大赏者金币原因
423424
"remark": "", // 备注
424425
"post": {
425-
"id": 30506, // 文章id
426+
"id": 123, // 文章id
426427
"baId": 41, // 分区id
427428
"senderId": "123", // 文章作者id
428-
"senderNicknameId": 128769, // 发送者名字id
429+
"senderNicknameId": 123, // 发送者名字id
429430
"senderAvatarId": 84, // 发送者头像id
430431
"groupId": "", // 文章关联群组id
431-
"title": "QQ云湖消息互通机器人", // 文章标题
432+
"title": "测试文章标题", // 文章标题
432433
"contentType": 1, // 文章类型（1-Markdown，0-普通文章）
433434
"delTime": 0, // 删除时间戳
434435
"createTime": 1751721707, // 创建时间时间戳
@@ -438,16 +439,16 @@ POST /v1/community/reward-record
438439
"commentNum": 2, // 评论数量
439440
"collectNum": 6, // 收藏数量
440441
"amountNum": 0.01, // 文章投币数量
441-
"senderNickname": "那狗吧", // 文章作者昵称
442-
"senderAvatar": "https://chat-img.jwznb.com/defalut-avatars/Nellie%20Bly.png", // 文章作者头像url
442+
"senderNickname": "测试打赏者名称", // 文章作者昵称
443+
"senderAvatar": "https://...", // 文章作者头像url
443444
"createTimeText": "2025-07-05 21:21:47", // 创建文章时间
444445
"auditStatus": 0
445446
},
446447
"sender": {
447448
"id": 106634, // 打赏id
448449
"user_id": "123", // 打赏者id
449450
"nickname": "测试打赏者昵称", // 打赏者昵称
450-
"avatar_url": "https://chat-img.jwznb.com/1523c36f6d5b0a73dfb0fe4d3494c1f2.jpg" // 打赏者头像url
451+
"avatar_url": "https://..." // 打赏者头像url
451452
},
452453
"comment": {
453454
"id": 0,
@@ -491,8 +492,8 @@ POST /v1/community/comment/comment
491492

492493
```JSONC
493494
{
494-
"postId": 31108, // 文章id
495-
"commentId": 6051, // 评论id（若直接评论文章那id=0）
495+
"postId": 123, // 文章id
496+
"commentId": 123, // 评论id（若直接评论文章那id=0）
496497
"content": "🤣" // 评论内容
497498
}
498499
```
@@ -534,12 +535,12 @@ POST /v1/community/comment/comment-list
534535
"data": {
535536
"comments": [
536537
{
537-
"id": 6173, // 评论id
538-
"postId": 31153, // 文章id
538+
"id": 123, // 评论id
539+
"postId": 123, // 文章id
539540
"parentId": 0, // 父id
540541
"senderId": "114514", //发送者id
541-
"sender_nicknameId": 178312, // 发送者名称id
542-
"sender_avatarUd": 87, // 发送者头像id
542+
"sender_nicknameId": 123, // 发送者名称id
543+
"sender_avatarUd": 123, // 发送者头像id
543544
"content": "？", // 评论内容
544545
"delTime": 0, // 删除时间戳
545546
"createTime": 1754746982, // 发送时间戳
@@ -548,8 +549,8 @@ POST /v1/community/comment/comment-list
548549
"amountNum": 0, // 该评论的投币数
549550
"auditStatus": 0, // 审核状态
550551
"replies": [], // 评论内容
551-
"senderNickname": "22928kkkk", // 发送者昵称
552-
"senderAvatar": "https://chat-img.jwznb.com/defalut-avatars/Pearl%20Kendrick.png", // 发送者头像url
552+
"senderNickname": "测试评论发送者名称", // 发送者昵称
553+
"senderAvatar": "https://...", // 发送者头像url
553554
"createTimeText": "2025-08-09 21:43:02", // 评论时间
554555
"isLiked": "0", // 是否点赞(1-是，0-否)
555556
"isReward": 0, // 是否投币(1-是，0-否)
@@ -766,11 +767,11 @@ POST /v1/community/posts/post-detail
766767
},
767768
"isAdmin": 0, // 文章作者是否为管理员
768769
"post": {
769-
"id": 31622, // 文章id
770+
"id": 123, // 文章id
770771
"baId": 41, // 该文章所处的分区id
771772
"senderId": "7384288", // 文章作者id
772-
"senderNicknameId": 185792, // 文章作者名称id
773-
"senderAvatarId": 46626, // 文章作者头像id
773+
"senderNicknameId": 123, // 文章作者名称id
774+
"senderAvatarId": 123, // 文章作者头像id
774775
"groupId": "", // 该文章所处的群聊id
775776
"title": "文章标题", // 文章标题
776777
"contentType": 2, // 文章类型，1-普通文字，2-Markdown
@@ -783,9 +784,11 @@ POST /v1/community/posts/post-detail
783784
"likeNum": 0, // 文章点赞数量
784785
"commentNum": 0, // 文章评论数量
785786
"collectNum": 0, // 文章收藏数量
787+
"isDraft": 0, // 是否为草稿，0-不是，1-是
788+
"isSticky": 0, // 置顶时间戳，若不是置顶则为0
786789
"amountNum": 0, // 文章投币数量
787790
"senderNickname": "作者名称", // 文章作者名称
788-
"senderAvatar": "https://chat-img.jwznb.com/14ee9ecc8856e34e9f3fdd115e5139b6.jpg", // 文章作者头像url
791+
"senderAvatar": "https://c...", // 文章作者头像url
789792
"createTimeText": "2025-09-13 17:29:14", // 文章发送时间
790793
"group": { // 该文章下绑定的群聊信息
791794
"id": 0, // 会话类型id
@@ -856,11 +859,11 @@ POST /v1/community/posts/my-post-list
856859
"data": {
857860
"posts": [ // 帖子相关
858861
{
859-
"id": 31635, // 文章id
862+
"id": 123, // 文章id
860863
"baId": 49, // 文章所属分区id
861864
"senderId": "1659829", // 文章作者
862-
"senderNicknameId": 177154, // 作者名称id
863-
"senderAvatarId": 46580, // 作者头像id
865+
"senderNicknameId": 123, // 作者名称id
866+
"senderAvatarId": 123, // 作者头像id
864867
"groupId": "", // 文章所属群聊id
865868
"title": "test", // 文章标题
866869
"contentType": 1, // 文章类型，1-普通文字，2-Markdown
@@ -873,9 +876,11 @@ POST /v1/community/posts/my-post-list
873876
"likeNum": 0, // 文章赞数
874877
"commentNum": 0, // 文章评论数量
875878
"collectNum": 0, // 文章收藏数量
879+
"isDraft": 0, // 是否为草稿，0-不是，1-是
880+
"isSticky": 0, // 置顶时间戳，若不是置顶则为0
876881
"amountNum": 0, // 文章投币数量
877882
"senderNickname": "作者", // 文章作者名称
878-
"senderAvatar": "https://chat-img.jwznb.com/aa117e6f7a237926ea75426fd707f915.jpg", // 文章作者头像url
883+
"senderAvatar": "https://...", // 文章作者头像url
879884
"createTimeText": "2025-09-14 10:47:58", // 文章发布时间
880885
"group": { // 文章绑定群聊相关
881886
"id": 0, // 文章所属群聊的类型id
@@ -1140,3 +1145,144 @@ POST /v1/community/ba/delete
11401145
"msg": "success" // 返回消息
11411146
}
11421147
```
1148+
1149+
## 创建文章草稿
1150+
1151+
POST /v1/community/posts/create-draft
1152+
1153+
请求头:
1154+
1155+
|名称|必须|备注|
1156+
|-----|-----|-----|
1157+
|token|是|无|
1158+
1159+
请求体：
1160+
1161+
```JSONC
1162+
{
1163+
"baId": 0, // 草稿所在分区ID
1164+
"title": "测试完整草稿标题", // 草稿标题
1165+
"content": "测试文章草稿内容", // 草稿内容
1166+
"contentType": 1, // 草稿类别，1-文本，2-Markdown
1167+
"draftId": 0 // 草稿ID，若此值不为0云湖将会删除这里设定的草稿ID所对应的草稿，以此实现草稿编辑
1168+
}
1169+
```
1170+
1171+
响应体：
1172+
1173+
```JSONC
1174+
{
1175+
"code": 1, // 请求状态码，1为正常
1176+
"data": {
1177+
"id": 123 // 草稿ID
1178+
},
1179+
"msg": "success" // 返回消息
1180+
}
1181+
```
1182+
1183+
## 获取文章草稿信息
1184+
1185+
POST /v1/community/posts/get-draft
1186+
1187+
请求头:
1188+
1189+
|名称|必须|备注|
1190+
|-----|-----|-----|
1191+
|token|是|无|
1192+
1193+
请求体：
1194+
1195+
```JSONC
1196+
{
1197+
"baId": 0, // 草稿所处文章分区ID，一般为0
1198+
"draftId": 123 // 草稿ID
1199+
}
1200+
```
1201+
1202+
响应体：
1203+
1204+
```JSONC
1205+
{
1206+
"code": 1, // 请求状态码，1为正常
1207+
"data": {
1208+
"posts": { // 帖子相关
1209+
"id": 123, // 文章id
1210+
"baId": 41, // 文章所属分区id
1211+
"senderId": "123", // 文章作者
1212+
"senderNicknameId": 123, // 作者名称id
1213+
"senderAvatarId": 123, // 作者头像id
1214+
"groupId": "", // 文章所属群聊id
1215+
"title": "test", // 文章标题
1216+
"contentType": 1, // 文章类型，1-普通文字，2-Markdown
1217+
"content": "内容", // 文章内容
1218+
"delTime": 0, // 删除时间
1219+
"createTime": 1757818078, // 文章发布时间戳
1220+
"updateTime": 0, // 文章更新时间戳
1221+
"editTime": 0, // 文章编辑时间戳
1222+
"lastActive": 1757818078, // 文章上次活跃时间
1223+
"likeNum": 0, // 文章赞数
1224+
"commentNum": 0, // 文章评论数量
1225+
"collectNum": 0, // 文章收藏数量
1226+
"isDraft": 0, // 是否为草稿，0-不是，1-是
1227+
"isSticky": 0, // 置顶时间戳，若不是置顶则为0
1228+
"amountNum": 0, // 文章投币数量
1229+
"senderNickname": "作者", // 文章作者名称
1230+
"senderAvatar": "https://...", // 文章作者头像url
1231+
"createTimeText": "2025-09-14 10:47:58", // 文章发布时间
1232+
"group": { // 文章绑定群聊相关
1233+
"id": 0, // 文章所属群聊的类型id
1234+
"groupId": "", // 文章所属群聊id
1235+
"name": "", // 群聊名称
1236+
"introduction": "", // 群聊简介
1237+
"createBy": "", // 群聊群主id
1238+
"createTime": 0, // 群聊创建时间戳
1239+
"avatarId": 0, // 群聊头像id
1240+
"del_flag": 0,
1241+
"avatarUrl": "", // 群聊头像url
1242+
"headcount": 0, // 群聊人数
1243+
"readHistory": 0, // 是否开启聊天历史记录，0-没有，1-开了
1244+
"alwaysAgree": 0, // 新成员是否直接进入群聊，0-没有，1-开了
1245+
"categoryId": 0, // 群聊类型id
1246+
"category": "", // 群聊类型
1247+
"private": 0, // 群聊是否私有，0-没有，1-开了
1248+
"banId": 0, // 被banid
1249+
"gag": 0, // 被禁言者id
1250+
"gagBy": "", // 禁言者id
1251+
"msgTypeLimit": "" // 消息类型限制
1252+
},
1253+
"isLiked": "0", // (你)是否点赞该文章，0-没有，1-点了
1254+
"isCollected": 0, // (你)是否收藏该文章，0-没有，1-点了
1255+
"isReward": 0, // (你)是否投币该文章，0-没有，1-点了
1256+
"isVip": 0 // 暂时不清楚
1257+
}
1258+
},
1259+
"msg": "success" // 返回消息
1260+
}
1261+
```
1262+
1263+
## 删除文章草稿
1264+
1265+
POST /v1/community/posts/cancel-draft
1266+
1267+
请求头:
1268+
1269+
|名称|必须|备注|
1270+
|-----|-----|-----|
1271+
|token|是|必须为草稿创建者|
1272+
1273+
请求体：
1274+
1275+
```JSONC
1276+
{
1277+
"draftId": 123 // 草稿ID
1278+
}
1279+
```
1280+
1281+
响应体：
1282+
1283+
```JSONC
1284+
{
1285+
"code": 1, // 请求状态码，1为正常
1286+
"msg": "success" // 返回消息
1287+
}
1288+
```

0 commit comments

Comments
 (0)