Skip to content

Commit 1210ac6

Browse files
icey-yuicey-yu
committed
feat: fix doc
1 parent a92633b commit 1210ac6

24 files changed

Lines changed: 163 additions & 169 deletions

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ hide_title: true
1717
### 请求URL
1818
- `http://x.x.x.x:10002/conversation/get_owner_conversation`
1919

20-
2120
### Header
21+
2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
2424
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,25 @@ hide_title: true
55
---
66

77
<center>
8-
98
## 获取排序后的会话列表
109

1110
</center>
1211

1312
### 简要描述
13+
1414
- 根据是否置顶、发消息的时间先后获取排序后的会话列表。
1515
### 请求方式
1616
- `post`
1717
### 请求URL
1818
- `http://x.x.x.x:10002/conversation/get_sorted_conversation_list`
1919

20-
2120
### Header
21+
2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
2424
|token|eyJhbxxxx3Xs|必填|string|管理员token|
2525
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|
2626

27-
2827
### 请求参数示例
2928

3029

@@ -53,9 +52,9 @@ hide_title: true
5352
"errCode": 0,
5453
"errMsg": "",
5554
"errDlt": "",
56-
"unreadTotal": 2,
57-
"conversationTotal": 2,
5855
"data": {
56+
"conversationTotal": 2,
57+
"unreadTotal": 2,
5958
"conversationElems": [
6059
{
6160
"conversationID": "si_110_114",

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ hide_title: true
3939
"userID": "4365007572",
4040
"groupID": "",
4141
"recvMsgOpt": 0,
42+
"attachedInfo": "attached",
4243
"isPinned": false,
4344
"isPrivateChat": true,
4445
"ex": "",
@@ -56,17 +57,19 @@ hide_title: true
5657
|conversation.groupID|选填|string|会话类型为群聊时必填|
5758
|conversation.recvMsgOpt|选填|int|会话免打扰状态|
5859
|conversation.isPinned|选填|boolean|会话是否置顶|
60+
|conversation.attachedInfo|选填|string|会话附加信息，预留字段|
5961
|conversation.isPrivateChat|选填|boolean|是否开启阅后即焚|
6062
|conversation.ex|选填|string|会话扩展字段|
61-
|conversation.burnDuration|选填|string|设置会话阅后即焚时间，单位秒|
63+
|conversation.burnDuration|选填|int|设置会话阅后即焚时间，单位秒|
6264
### 成功返回示例
6365

6466

6567
```json
6668
{
6769
"errCode": 0,
6870
"errMsg": "",
69-
"errDlt": ""
71+
"errDlt": "",
72+
"data": null
7073
}
7174
```
7275
### 成功返回示例的参数说明

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

Lines changed: 0 additions & 92 deletions
This file was deleted.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ hide_title: true
4343
{
4444
"errCode": 0,
4545
"errMsg": "",
46-
"errDlt": ""
46+
"errDlt": "",
47+
"data": null
4748
}
4849
```
4950
### 成功返回示例的参数说明

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ hide_title: true
4545
{
4646
"errCode": 0,
4747
"errMsg": "",
48-
"errDlt": ""
48+
"errDlt": "",
49+
"data": null
4950
}
5051
```
5152
### 成功返回示例的参数说明

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,19 +54,19 @@ hide_title: true
5454
|字段名|选填|类型|说明|
5555
|:---- |:------- |:--- |---|
5656
|memberUserIDs|必填|array|群成员列表|
57-
|adminUserIDs|必填|array|群管理员列表|
58-
|ownerUserID|必填|string|群主|
57+
|adminUserIDs|选填|array|群管理员列表|
58+
|ownerUserID|选填|string|群主|
5959
|groupInfo|必填|object|[群信息](docs/restapi/commonFields.mdx#groupinfo)列表|
60-
|groupInfo.groupID|选填|string||
61-
|groupInfo.groupName|必填|string||
62-
|groupInfo.notification|必填|string||
63-
|groupInfo.introduction|必填|string||
64-
|groupInfo.faceURL|必填|string||
65-
|groupInfo.ex|必填|string||
66-
|groupInfo.groupType|必填|int||
67-
|groupInfo.needVerification|必填|int||
68-
|groupInfo.lookMemberInfo|必填|int||
69-
|groupInfo.applyMemberFriend|必填|int||
60+
|groupInfo.groupID|选填|string|群ID|
61+
|groupInfo.groupName|必填|string|群名称|
62+
|groupInfo.notification|必填|string|群公告|
63+
|groupInfo.introduction|必填|string|群介绍|
64+
|groupInfo.faceURL|必填|string|群头像|
65+
|groupInfo.ex|必填|string|扩展字段|
66+
|groupInfo.groupType|必填|int|群状态|
67+
|groupInfo.needVerification|必填|int|进群是否需要验证|
68+
|groupInfo.lookMemberInfo|必填|int|能否查看其他群成员信息|
69+
|groupInfo.applyMemberFriend|必填|int|群成员是否允许添加好友|
7070
### 成功返回示例
7171

7272

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,16 @@ hide_title: true
3636
|字段名|选填|类型|说明|
3737
|:---- |:------- |:--- |---|
3838
|groupID|必填|string|群ID|
39+
|deleteMember|选填|boolean|是否删除群成员信息|
3940
### 成功返回示例
4041

4142

4243
```json
4344
{
4445
"errCode": 0,
4546
"errMsg": "",
46-
"errDlt": ""
47+
"errDlt": "",
48+
"data": null
4749
}
4850
```
4951
### 成功返回示例的参数说明

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ hide_title: true
1717
### 请求URL
1818
- `http://x.x.x.x:10002/group/get_group_users_req_application_list`
1919

20-
2120
### Header
21+
2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
2424
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ hide_title: true
3131
```json
3232
{
3333
"groupID": "2559217223",
34+
"keyword": "nickname",
3435
"pagination": {
3536
"pageNumber": 1,
3637
"showNumber": 100
@@ -40,6 +41,7 @@ hide_title: true
4041
|字段名|选填|类型|说明|
4142
|:---- |:------- |:--- |---|
4243
|groupID|必填|string|群ID|
44+
|keyword|选填|string|关键词，用于搜索|
4345
|pagination|必填|object|分页参数结构体|
4446
|pagination.pageNumber|必填|int|当前页码，从1开始|
4547
|pagination.showNumber|必填|int|当前页请求数量|

0 commit comments

Comments
 (0)