Skip to content

Commit 5f62d40

Browse files
committed
Update community.md
更新了几个文章分区的API
1 parent 345be20 commit 5f62d40

1 file changed

Lines changed: 150 additions & 0 deletions

File tree

src/api/v1/community.md

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -990,3 +990,153 @@ POST /v1/community/ba/group-list
990990
"msg": "success" // 返回状态消息
991991
}
992992
```
993+
994+
## 分享文章分区
995+
996+
POST /v1/community/ba/forward
997+
998+
请求头:
999+
1000+
|名称|必须|备注|
1001+
|-----|-----|-----|
1002+
|token|||
1003+
1004+
请求体:
1005+
1006+
```JSONC
1007+
{
1008+
"baId": 0,
1009+
"receive": [
1010+
{
1011+
"chatId": "123", // 对象ID
1012+
"chatType": 2 // 对象列表,1-用户,2-群聊,3-机器人
1013+
}
1014+
// ...
1015+
]
1016+
}
1017+
```
1018+
1019+
响应体:
1020+
1021+
```JSONC
1022+
{
1023+
"code": 1, // 请求状态码,1为正常
1024+
"msg": "success" // 返回消息
1025+
}
1026+
```
1027+
1028+
## 管理文章分区
1029+
1030+
POST /v1/community/ba/manage
1031+
1032+
请求头:
1033+
1034+
|名称|必须|备注|
1035+
|-----|-----|-----|
1036+
|token||必须为文章分区所有者|
1037+
1038+
请求体:
1039+
1040+
```JSONC
1041+
{
1042+
"baId": 0, // 分区ID
1043+
"visibleRange": 0, // 分区可见状态,0-所有人可见,1-只有分区所有者可见
1044+
"publishAuthority": 0 // 分区开放度,0-所有人都可以发文章和评论,1-仅分区所有者可以发文章任何人都可以评论,2-仅分区所有者可以发文章和评论
1045+
}
1046+
```
1047+
1048+
响应体:
1049+
1050+
```JSONC
1051+
{
1052+
"code": 1, // 请求状态码,1为正常
1053+
"msg": "success" // 返回消息
1054+
}
1055+
```
1056+
1057+
## 创建文章分区
1058+
1059+
POST /v1/community/ba/create
1060+
1061+
请求头:
1062+
1063+
|名称|必须|备注|
1064+
|-----|-----|-----|
1065+
|token|||
1066+
1067+
请求体:
1068+
1069+
```JSONC
1070+
{
1071+
"name": "1111111111", // 分区名称,最多10字
1072+
"avatar": "https://..." // 分区头像
1073+
}
1074+
```
1075+
1076+
响应体:
1077+
1078+
```JSONC
1079+
{
1080+
"code": 1, // 请求状态码,1为正常
1081+
"data": {
1082+
"id": 0 // 分区ID
1083+
},
1084+
"msg": "success" // 返回消息
1085+
}
1086+
```
1087+
1088+
## 编辑文章分区
1089+
1090+
POST /v1/community/ba/edit
1091+
1092+
请求头:
1093+
1094+
|名称|必须|备注|
1095+
|-----|-----|-----|
1096+
|token||必须为文章分区所有者|
1097+
1098+
请求体:
1099+
1100+
```JSONC
1101+
{
1102+
"baId": 0, // 分区ID
1103+
"name": "1111111111", // 分区名称,最多10字
1104+
"avatar": "https://..." // 分区头像
1105+
}
1106+
```
1107+
1108+
响应体:
1109+
1110+
```JSONC
1111+
{
1112+
"code": 1, // 请求状态码,1为正常
1113+
"msg": "success" // 返回消息
1114+
}
1115+
```
1116+
1117+
## 删除文章分区
1118+
1119+
POST /v1/community/ba/delete
1120+
1121+
请求头:
1122+
1123+
|名称|必须|备注|
1124+
|-----|-----|-----|
1125+
|token||必须为文章分区所有者|
1126+
1127+
请求体:
1128+
1129+
```JSONC
1130+
{
1131+
"baId": 0 // 分区ID
1132+
}
1133+
```
1134+
1135+
响应体:
1136+
1137+
```JSONC
1138+
{
1139+
"code": 1, // 请求状态码,1为正常
1140+
"msg": "success" // 返回消息
1141+
}
1142+
```

0 commit comments

Comments
 (0)