Skip to content

Commit 4b4fe2f

Browse files
skiffer-gitskiffer-git
authored
Merge pull request #176 from icey-yu/server
fix: Server doc
2 parents a00bcd7 + c5bf743 commit 4b4fe2f

29 files changed

Lines changed: 173 additions & 189 deletions

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,14 @@ hide_title: true
1717
### 请求URL
1818
- `{API_ADDRESS}/conversation/get_owner_conversation`
1919

20-
### Header
2120

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

2727

28-
2928
### 请求参数示例
3029

3130

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ hide_title: true
2121

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

2727
### 请求参数示例
2828

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ hide_title: true
2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
2424
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
25+
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2626

2727

2828
### 请求参数示例
@@ -50,14 +50,15 @@ hide_title: true
5050
|字段名|选填|类型|说明|
5151
|:---- |:------- |:--- |---|
5252
|userIDs|必填|array|要设置会话字段的用户ID列表|
53+
|userIDs|必填|array|要设置会话字段的用户ID列表|
5354
|conversation|必填|object|会话对象|
5455
|conversation.conversationID|必填|string|会话ID|
5556
|conversation.conversationType|必填|int|会话类型，单聊为1，群聊为3|
5657
|conversation.userID|选填|string|会话类型为单聊时必填|
5758
|conversation.groupID|选填|string|会话类型为群聊时必填|
5859
|conversation.recvMsgOpt|选填|int|会话免打扰状态|
59-
|conversation.isPinned|选填|boolean|会话是否置顶|
6060
|conversation.attachedInfo|选填|string|会话附加信息，预留字段|
61+
|conversation.isPinned|选填|boolean|会话是否置顶|
6162
|conversation.isPrivateChat|选填|boolean|是否开启阅后即焚|
6263
|conversation.ex|选填|string|会话扩展字段|
6364
|conversation.burnDuration|选填|int|设置会话阅后即焚时间，单位秒|
@@ -78,8 +79,8 @@ hide_title: true
7879
|参数名|类型|说明|
7980
|:---- |:------- |:--- |
8081
|errCode|int|错误码,0表示成功|
81-
|errMsg|string|错误简要信息，为空|
82-
|errDlt|errDlt|错误详细信息，为空|
82+
|errMsg|string|错误简要信息，无错误时为空|
83+
|errDlt|errDlt|错误详细信息，无错误时为空|
8384
|data|object|通用数据对象，具体结构见下方|
8485
### 失败返回示例
8586

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 12
2+
sidebar_position: 18
33
title: 取消群禁言
44
hide_title: true
55
---
@@ -22,7 +22,7 @@ hide_title: true
2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
2424
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
25+
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2626

2727

2828
### 请求参数示例
@@ -43,8 +43,7 @@ hide_title: true
4343
{
4444
"errCode": 0,
4545
"errMsg": "",
46-
"errDlt": "",
47-
"data": null
46+
"errDlt": ""
4847
}
4948
```
5049
### 成功返回示例的参数说明
@@ -53,8 +52,8 @@ hide_title: true
5352
|参数名|类型|说明|
5453
|:---- |:------- |:--- |
5554
|errCode|int|错误码,0表示成功|
56-
|errMsg|string|错误简要信息，为空|
57-
|errDlt|errDlt|错误详细信息，为空|
55+
|errMsg|string|错误简要信息，无错误时为空|
56+
|errDlt|errDlt|错误详细信息，无错误时为空|
5857
|data|object|通用数据对象，具体结构见下方|
5958
### 失败返回示例
6059

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 14
2+
sidebar_position: 20
33
title: 取消禁言群成员
44
hide_title: true
55
---
@@ -22,7 +22,7 @@ hide_title: true
2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
2424
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
25+
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2626

2727

2828
### 请求参数示例
@@ -45,8 +45,7 @@ hide_title: true
4545
{
4646
"errCode": 0,
4747
"errMsg": "",
48-
"errDlt": "",
49-
"data": null
48+
"errDlt": ""
5049
}
5150
```
5251
### 成功返回示例的参数说明
@@ -55,8 +54,8 @@ hide_title: true
5554
|参数名|类型|说明|
5655
|:---- |:------- |:--- |
5756
|errCode|int|错误码,0表示成功|
58-
|errMsg|string|错误简要信息，为空|
59-
|errDlt|errDlt|错误详细信息，为空|
57+
|errMsg|string|错误简要信息，无错误时为空|
58+
|errDlt|errDlt|错误详细信息，无错误时为空|
6059
|data|object|通用数据对象，具体结构见下方|
6160
### 失败返回示例
6261

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ hide_title: true
2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
2424
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
25+
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2626

2727

2828
### 请求参数示例
@@ -53,20 +53,20 @@ hide_title: true
5353
```
5454
|字段名|选填|类型|说明|
5555
|:---- |:------- |:--- |---|
56-
|memberUserIDs|必填|array|群成员列表|
56+
|memberUserIDs|选填|array|群成员列表|
5757
|adminUserIDs|选填|array|群管理员列表|
58-
|ownerUserID|选填|string|群主|
58+
|ownerUserID|必填|string|群主|
5959
|groupInfo|必填|object|[群信息](docs/restapi/commonFields.mdx#groupinfo)列表|
6060
|groupInfo.groupID|选填|string|群ID|
6161
|groupInfo.groupName|必填|string|群名称|
62-
|groupInfo.notification|必填|string|群公告|
63-
|groupInfo.introduction|必填|string|群介绍|
64-
|groupInfo.faceURL|必填|string|群头像|
65-
|groupInfo.ex|必填|string|扩展字段|
62+
|groupInfo.notification|选填|string|群公告|
63+
|groupInfo.introduction|选填|string|群介绍|
64+
|groupInfo.faceURL|选填|string|群头像地址|
65+
|groupInfo.ex|选填|string|群扩展字段|
6666
|groupInfo.groupType|必填|int|群状态|
67-
|groupInfo.needVerification|必填|int|进群是否需要验证|
68-
|groupInfo.lookMemberInfo|必填|int|能否查看其他群成员信息|
69-
|groupInfo.applyMemberFriend|必填|int|群成员是否允许添加好友|
67+
|groupInfo.needVerification|选填|int|进群是否需要验证|
68+
|groupInfo.lookMemberInfo|选填|int|能否查看其他群成员信息|
69+
|groupInfo.applyMemberFriend|选填|int|群成员是否允许添加好友|
7070
### 成功返回示例
7171

7272

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

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ hide_title: true
1515
### 请求方式
1616
- `post`
1717
### 请求URL
18-
- `{API_ADDRESS}/group/dismiss_group`
18+
- `{API_ADDRESS}/group/dismiss_group`
1919

2020

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

2727

2828
### 请求参数示例
@@ -54,8 +54,8 @@ hide_title: true
5454
|参数名|类型|说明|
5555
|:---- |:------- |:--- |
5656
|errCode|int|错误码,0表示成功|
57-
|errMsg|string|错误简要信息，为空|
58-
|errDlt|errDlt|错误详细信息，为空|
57+
|errMsg|string|错误简要信息，无错误时为空|
58+
|errDlt|errDlt|错误详细信息，无错误时为空|
5959
|data|object|通用数据对象，具体结构见下方|
6060
### 失败返回示例
6161

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 22
2+
sidebar_position: 29
33
title: 获取指定用户的入群申请
44
hide_title: true
55
---
@@ -17,12 +17,12 @@ hide_title: true
1717
### 请求URL
1818
- `{API_ADDRESS}/group/get_group_users_req_application_list`
1919

20-
### Header
2120

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

2727

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

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ hide_title: true
1515
### 请求方式
1616
- `post`
1717
### 请求URL
18-
- `{API_ADDRESS}/group/get_group_member_list`
18+
- `{API_ADDRESS}/group/get_group_member_list`
1919

2020

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

2727

2828
### 请求参数示例
@@ -31,7 +31,7 @@ hide_title: true
3131
```json
3232
{
3333
"groupID": "2559217223",
34-
"keyword": "nickname",
34+
"keyword":"userID",
3535
"pagination": {
3636
"pageNumber": 1,
3737
"showNumber": 100
@@ -41,7 +41,7 @@ hide_title: true
4141
|字段名|选填|类型|说明|
4242
|:---- |:------- |:--- |---|
4343
|groupID|必填|string|群ID|
44-
|keyword|选填|string|关键词，用于搜索|
44+
|keyword|选填|string|群成员的 userID 或 nickname，不填时返回对应分页的数据|
4545
|pagination|必填|object|分页参数结构体|
4646
|pagination.pageNumber|必填|int|当前页码，从1开始|
4747
|pagination.showNumber|必填|int|当前页请求数量|
@@ -136,8 +136,8 @@ hide_title: true
136136
|参数名|类型|说明|
137137
|:---- |:------- |:--- |
138138
|errCode|int|错误码,0表示成功|
139-
|errMsg|string|错误简要信息，为空|
140-
|errDlt|errDlt|错误详细信息，为空|
139+
|errMsg|string|错误简要信息，无错误时为空|
140+
|errDlt|errDlt|错误详细信息，无错误时为空|
141141
|data|object|通用数据对象，具体结构见下方|
142142
|total|int|群成员总数|
143143
|members|array|[群成员信息](docs/restapi/commonFields.mdx#groupmemberinfo)列表|

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 6
2+
sidebar_position: 11
33
title: 获取指定群成员
44
hide_title: true
55
---
@@ -22,7 +22,7 @@ hide_title: true
2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
2424
|operationID|1646445464564|必填|string|用于全局链路追踪，建议使用时间戳，在每个请求中独立|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
25+
|token|eyJhbxxxx3Xs|必填|string|[管理员 token](docs/restapi/apis/authenticationManagement/getToken.mdx)|
2626

2727

2828
### 请求参数示例
@@ -86,8 +86,8 @@ hide_title: true
8686
|参数名|类型|说明|
8787
|:---- |:------- |:--- |
8888
|errCode|int|错误码,0表示成功|
89-
|errMsg|string|错误简要信息，为空|
90-
|errDlt|errDlt|错误详细信息，为空|
89+
|errMsg|string|错误简要信息，无错误时为空|
90+
|errDlt|errDlt|错误详细信息，无错误时为空|
9191
|data|object|通用数据对象，具体结构见下方|
9292
|members|array|[群成员信息](docs/restapi/commonFields.mdx#groupmemberinfo)列表|
9393
### 失败返回示例

0 commit comments

Comments
 (0)