Skip to content

Commit cf16f71

Browse files
icey-yuicey-yu
committed
fix: doc
1 parent 4750f85 commit cf16f71

26 files changed

Lines changed: 489 additions & 197 deletions

‎docs/restapi/apis/conversationManagement/getOwnerConversation.mdx‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
<!-- 使用表格样式 -->
2+
<style>
3+
th {
4+
background-color: #1E90FF; /* 设置表头背景颜色 */
5+
}
6+
.highlight {
7+
background-color: black;
8+
color: white;
9+
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
10+
}
11+
</style>
12+
113
---
214
sidebar_position: 8
315
title: 获取当前用户的分页会话列表
@@ -17,15 +29,14 @@ hide_title: true
1729
### 请求URL
1830
- `http://x.x.x.x:10002/conversation/get_owner_conversation`
1931

20-
### Header
2132

33+
### Header
2234
|header名|示例值|选填|类型|说明|
2335
|:---- |:------- |:--- |---|------ |
2436
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
2537
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2638

2739

28-
2940
### 请求参数示例
3041

3142

@@ -445,8 +456,8 @@ hide_title: true
445456
|参数名|类型|说明|
446457
|:---- |:------- |:--- |
447458
|errCode|int|错误码,0表示成功|
448-
|errMsg|string|错误简要信息，为空|
449-
|errDlt|errDlt|错误详细信息，为空|
459+
|errMsg|string|错误简要信息，无错误时为空|
460+
|errDlt|errDlt|错误详细信息，无错误时为空|
450461
|data|object|通用数据对象，具体结构见下方|
451462
|total|string|会话总数|
452463
|conversations|array|[会话](docs/restapi/commonFields.mdx#conversationinfo)列表|

‎docs/restapi/apis/conversationManagement/setConversations.mdx‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
<!-- 使用表格样式 -->
2+
<style>
3+
th {
4+
background-color: #1E90FF; /* 设置表头背景颜色 */
5+
}
6+
.highlight {
7+
background-color: black;
8+
color: white;
9+
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
10+
}
11+
</style>
12+
113
---
214
sidebar_position: 7
315
title: 多个用户对同一会话设置字段
@@ -22,7 +34,7 @@ hide_title: true
2234
|header名|示例值|选填|类型|说明|
2335
|:---- |:------- |:--- |---|------ |
2436
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
37+
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2638

2739

2840
### 请求参数示例
@@ -50,14 +62,15 @@ hide_title: true
5062
|字段名|选填|类型|说明|
5163
|:---- |:------- |:--- |---|
5264
|userIDs|必填|array|要设置会话字段的用户ID列表|
65+
|userIDs|必填|array|要设置会话字段的用户ID列表|
5366
|conversation|必填|object|会话对象|
5467
|conversation.conversationID|必填|string|会话ID|
5568
|conversation.conversationType|必填|int|会话类型，单聊为1，群聊为3|
5669
|conversation.userID|选填|string|会话类型为单聊时必填|
5770
|conversation.groupID|选填|string|会话类型为群聊时必填|
5871
|conversation.recvMsgOpt|选填|int|会话免打扰状态|
59-
|conversation.isPinned|选填|boolean|会话是否置顶|
6072
|conversation.attachedInfo|选填|string|会话附加信息，预留字段|
73+
|conversation.isPinned|选填|boolean|会话是否置顶|
6174
|conversation.isPrivateChat|选填|boolean|是否开启阅后即焚|
6275
|conversation.ex|选填|string|会话扩展字段|
6376
|conversation.burnDuration|选填|int|设置会话阅后即焚时间，单位秒|
@@ -78,8 +91,8 @@ hide_title: true
7891
|参数名|类型|说明|
7992
|:---- |:------- |:--- |
8093
|errCode|int|错误码,0表示成功|
81-
|errMsg|string|错误简要信息，为空|
82-
|errDlt|errDlt|错误详细信息，为空|
94+
|errMsg|string|错误简要信息，无错误时为空|
95+
|errDlt|errDlt|错误详细信息，无错误时为空|
8396
|data|object|通用数据对象，具体结构见下方|
8497
### 失败返回示例
8598

‎docs/restapi/apis/groupManagement/cancelMuteGroup.mdx‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
1+
<!-- 使用表格样式 -->
2+
<style>
3+
th {
4+
background-color: #1E90FF; /* 设置表头背景颜色 */
5+
}
6+
.highlight {
7+
background-color: black;
8+
color: white;
9+
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
10+
}
11+
</style>
12+
113
---
2-
sidebar_position: 12
14+
sidebar_position: 18
315
title: 取消群禁言
416
hide_title: true
517
---
@@ -22,7 +34,7 @@ hide_title: true
2234
|header名|示例值|选填|类型|说明|
2335
|:---- |:------- |:--- |---|------ |
2436
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
37+
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2638

2739

2840
### 请求参数示例
@@ -43,8 +55,7 @@ hide_title: true
4355
{
4456
"errCode": 0,
4557
"errMsg": "",
46-
"errDlt": "",
47-
"data": null
58+
"errDlt": ""
4859
}
4960
```
5061
### 成功返回示例的参数说明
@@ -53,8 +64,8 @@ hide_title: true
5364
|参数名|类型|说明|
5465
|:---- |:------- |:--- |
5566
|errCode|int|错误码,0表示成功|
56-
|errMsg|string|错误简要信息，为空|
57-
|errDlt|errDlt|错误详细信息，为空|
67+
|errMsg|string|错误简要信息，无错误时为空|
68+
|errDlt|errDlt|错误详细信息，无错误时为空|
5869
|data|object|通用数据对象，具体结构见下方|
5970
### 失败返回示例
6071

‎docs/restapi/apis/groupManagement/cancelMuteGroupMember.mdx‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
1+
<!-- 使用表格样式 -->
2+
<style>
3+
th {
4+
background-color: #1E90FF; /* 设置表头背景颜色 */
5+
}
6+
.highlight {
7+
background-color: black;
8+
color: white;
9+
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
10+
}
11+
</style>
12+
113
---
2-
sidebar_position: 14
14+
sidebar_position: 20
315
title: 取消禁言群成员
416
hide_title: true
517
---
@@ -22,7 +34,7 @@ hide_title: true
2234
|header名|示例值|选填|类型|说明|
2335
|:---- |:------- |:--- |---|------ |
2436
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
37+
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2638

2739

2840
### 请求参数示例
@@ -45,8 +57,7 @@ hide_title: true
4557
{
4658
"errCode": 0,
4759
"errMsg": "",
48-
"errDlt": "",
49-
"data": null
60+
"errDlt": ""
5061
}
5162
```
5263
### 成功返回示例的参数说明
@@ -55,8 +66,8 @@ hide_title: true
5566
|参数名|类型|说明|
5667
|:---- |:------- |:--- |
5768
|errCode|int|错误码,0表示成功|
58-
|errMsg|string|错误简要信息，为空|
59-
|errDlt|errDlt|错误详细信息，为空|
69+
|errMsg|string|错误简要信息，无错误时为空|
70+
|errDlt|errDlt|错误详细信息，无错误时为空|
6071
|data|object|通用数据对象，具体结构见下方|
6172
### 失败返回示例
6273

‎docs/restapi/apis/groupManagement/createGroup.mdx‎

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
<!-- 使用表格样式 -->
2+
<style>
3+
th {
4+
background-color: #1E90FF; /* 设置表头背景颜色 */
5+
}
6+
.highlight {
7+
background-color: black;
8+
color: white;
9+
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
10+
}
11+
</style>
12+
113
---
214
sidebar_position: 1
315
title: 创建群组
@@ -22,7 +34,7 @@ hide_title: true
2234
|header名|示例值|选填|类型|说明|
2335
|:---- |:------- |:--- |---|------ |
2436
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
37+
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2638

2739

2840
### 请求参数示例
@@ -53,20 +65,20 @@ hide_title: true
5365
```
5466
|字段名|选填|类型|说明|
5567
|:---- |:------- |:--- |---|
56-
|memberUserIDs|必填|array|群成员列表|
68+
|memberUserIDs|选填|array|群成员列表|
5769
|adminUserIDs|选填|array|群管理员列表|
58-
|ownerUserID|选填|string|群主|
70+
|ownerUserID|必填|string|群主|
5971
|groupInfo|必填|object|[群信息](docs/restapi/commonFields.mdx#groupinfo)列表|
6072
|groupInfo.groupID|选填|string|群ID|
6173
|groupInfo.groupName|必填|string|群名称|
62-
|groupInfo.notification|必填|string|群公告|
63-
|groupInfo.introduction|必填|string|群介绍|
64-
|groupInfo.faceURL|必填|string|群头像|
65-
|groupInfo.ex|必填|string|扩展字段|
74+
|groupInfo.notification|选填|string|群公告|
75+
|groupInfo.introduction|选填|string|群介绍|
76+
|groupInfo.faceURL|选填|string|群头像地址|
77+
|groupInfo.ex|选填|string|群扩展字段|
6678
|groupInfo.groupType|必填|int|群状态|
67-
|groupInfo.needVerification|必填|int|进群是否需要验证|
68-
|groupInfo.lookMemberInfo|必填|int|能否查看其他群成员信息|
69-
|groupInfo.applyMemberFriend|必填|int|群成员是否允许添加好友|
79+
|groupInfo.needVerification|选填|int|进群是否需要验证|
80+
|groupInfo.lookMemberInfo|选填|int|能否查看其他群成员信息|
81+
|groupInfo.applyMemberFriend|选填|int|群成员是否允许添加好友|
7082
### 成功返回示例
7183

7284

@@ -104,8 +116,8 @@ hide_title: true
104116
|参数名|类型|说明|
105117
|:---- |:------- |:--- |
106118
|errCode|int|错误码,0表示成功|
107-
|errMsg|string|错误简要信息，为空|
108-
|errDlt|errDlt|错误详细信息，为空|
119+
|errMsg|string|错误简要信息，无错误时为空|
120+
|errDlt|errDlt|错误详细信息，无错误时为空|
109121
|data|object|通用数据对象，具体结构见下方|
110122
|groupInfo|object|[群信息](docs/restapi/commonFields.mdx#groupinfo)列表|
111123
### 失败返回示例

‎docs/restapi/apis/groupManagement/dismissGroup.mdx‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
1+
<!-- 使用表格样式 -->
2+
<style>
3+
th {
4+
background-color: #1E90FF; /* 设置表头背景颜色 */
5+
}
6+
.highlight {
7+
background-color: black;
8+
color: white;
9+
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
10+
}
11+
</style>
12+
113
---
2-
sidebar_position: 13
14+
sidebar_position: 19
315
title: 解散群
416
hide_title: true
517
---
@@ -22,7 +34,7 @@ hide_title: true
2234
|header名|示例值|选填|类型|说明|
2335
|:---- |:------- |:--- |---|------ |
2436
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
37+
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2638

2739

2840
### 请求参数示例
@@ -54,8 +66,8 @@ hide_title: true
5466
|参数名|类型|说明|
5567
|:---- |:------- |:--- |
5668
|errCode|int|错误码,0表示成功|
57-
|errMsg|string|错误简要信息，为空|
58-
|errDlt|errDlt|错误详细信息，为空|
69+
|errMsg|string|错误简要信息，无错误时为空|
70+
|errDlt|errDlt|错误详细信息，无错误时为空|
5971
|data|object|通用数据对象，具体结构见下方|
6072
### 失败返回示例
6173

‎docs/restapi/apis/groupManagement/getGroupApplicationListByUserID.mdx‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
1+
<!-- 使用表格样式 -->
2+
<style>
3+
th {
4+
background-color: #1E90FF; /* 设置表头背景颜色 */
5+
}
6+
.highlight {
7+
background-color: black;
8+
color: white;
9+
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
10+
}
11+
</style>
12+
113
---
2-
sidebar_position: 22
14+
sidebar_position: 29
315
title: 获取指定用户的入群申请
416
hide_title: true
517
---
@@ -17,12 +29,12 @@ hide_title: true
1729
### 请求URL
1830
- `http://x.x.x.x:10002/group/get_group_users_req_application_list`
1931

20-
### Header
2132

33+
### Header
2234
|header名|示例值|选填|类型|说明|
2335
|:---- |:------- |:--- |---|------ |
2436
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
37+
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2638

2739

2840
### 请求参数示例
@@ -97,8 +109,8 @@ hide_title: true
97109
|参数名|类型|说明|
98110
|:---- |:------- |:--- |
99111
|errCode|int|错误码,0表示成功|
100-
|errMsg|string|错误简要信息，为空|
101-
|errDlt|errDlt|错误详细信息，为空|
112+
|errMsg|string|错误简要信息，无错误时为空|
113+
|errDlt|errDlt|错误详细信息，无错误时为空|
102114
|data|object|通用数据对象，具体结构见下方|
103115
|total|int|加群申请总数|
104116
|groupRequests|array|[入群申请对象](docs/restapi/commonFields.mdx#grouprequestinfo)列表|

0 commit comments

Comments
 (0)