Skip to content

Commit f103b86

Browse files
BloominggBloomingg
committed
Merge branch 'main' of https://github.com/OpenIMSDK/docs 
2 parents 4826db7 + 7ccf04d commit f103b86

24 files changed

+644
-847
lines changed

‎i18n/en/docusaurus-plugin-content-docs-restapi/current.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"description": "The label for category 关系链管理 in sidebar tutorialSidebar"
2121
},
2222
"sidebar.tutorialSidebar.category.群组管理": {
23-
"message": "群组管理",
23+
"message": "Group Managemen",
2424
"description": "The label for category 群组管理 in sidebar tutorialSidebar"
2525
},
2626
"sidebar.tutorialSidebar.category.消息管理": {

‎i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/_category_.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"position": 3,
3-
"label": "群组管理",
3+
"label": "Group Management",
44
"collapsible": true,
55
"collapsed": true
66
}

‎i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/cancelMuteGroup.mdx‎

Lines changed: 25 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,40 @@
11
---
22
sidebar_position: 12
3-
title: 取消群禁言
3+
title: cancel_mute_group
44
hide_title: true
55
---
66

77
<center>
88

9-
## 取消群禁言
9+
## cancel_mute_group
1010

1111
</center>
1212

13-
### 简要描述
14-
- 取消群禁言。
15-
### 请求方式
13+
### Brief Description
14+
- Cancel group muting.
15+
### Request Method
1616
- `post`
17-
### 请求URL
17+
### Request URL
1818
- `http://x.x.x.x:10002/group/cancel_mute_group`
1919

20-
2120
### Header
22-
|header名|示例值|选填|类型|说明|
21+
| Header Name | Example Value | Optional | Type | Description |
2322
|:---- |:------- |:--- |---|------ |
24-
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
26-
27-
28-
### 请求参数示例
23+
|operationID|1646445464564|Required|string|operationID used for global link tracking|
24+
|token|eyJhbxxxx3Xs|Required|string|Admin token|
2925

26+
### Request Parameter Example
3027

3128
```json
3229
{
3330
"groupID": "2137448827"
3431
}
3532
```
36-
|字段名|选填|类型|说明|
33+
| Field Name | Optional | Type | Description |
3734
|:---- |:------- |:--- |---|
38-
|groupID|必填|string|群ID|
39-
### 成功返回示例
35+
|groupID|Required|string|Group ID|
4036

37+
### Successful Response Example
4138

4239
```json
4340
{
@@ -46,17 +43,16 @@ hide_title: true
4643
"errDlt": ""
4744
}
4845
```
49-
### 成功返回示例的参数说明
46+
### Successful Response Parameter Description
5047

51-
52-
|参数名|类型|说明|
48+
| Parameter Name | Type | Description |
5349
|:---- |:------- |:--- |
54-
|errCode|int|错误码,0表示成功|
55-
|errMsg|string|错误简要信息,无错误时为空|
56-
|errDlt|errDlt|错误详细信息,无错误时为空|
57-
|data|object|通用数据对象，具体结构见下方|
58-
### 失败返回示例
50+
|errCode|int|Error code, 0 indicates success|
51+
|errMsg|string|Brief error message, empty when no error|
52+
|errDlt|errDlt|Detailed error message|
53+
|data|object|Generic data object, specific structure seen below|
5954

55+
### Failed Response Example
6056

6157
```json
6258
{
@@ -65,11 +61,10 @@ hide_title: true
6561
"errDlt": ": [1004]RecordNotFoundError"
6662
}
6763
```
68-
### 失败返回示例的参数说明
69-
64+
### Failed Response Parameter Description
7065

71-
|参数名|类型|说明|
66+
| Parameter Name | Type | Description |
7267
|:---- |:------- |:--- |
73-
|errCode|int|错误码,具体查看全局错误码文档|
74-
|errMsg|string|错误简要信息|
75-
|errDlt|errDlt|错误详细信息|
68+
|errCode|int|Error code, refer to the global error code documentation for specifics|
69+
|errMsg|string|Brief error message|
70+
|errDlt|errDlt|Detailed error message|

‎i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/cancelMuteGroupMember.mdx‎

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,42 @@
11
---
22
sidebar_position: 14
3-
title: 取消禁言群成员
3+
title: cancel_mute_group_member
44
hide_title: true
55
---
66

77
<center>
88

9-
## 取消禁言群成员
9+
## cancel_mute_group_member
1010

1111
</center>
1212

13-
### 简要描述
14-
- 取消禁言群成员，此成员恢复在群里正常发送消息。
15-
### 请求方式
13+
### Brief Description
14+
- Cancel mute for a group member, allowing the member to resume sending messages normally within the group.
15+
### Request Method
1616
- `post`
17-
### 请求URL
17+
### Request URL
1818
- `http://x.x.x.x:10002/group/cancel_mute_group_member`
1919

20-
2120
### Header
22-
|header名|示例值|选填|类型|说明|
21+
| Header Name | Example Value | Optional | Type | Description |
2322
|:---- |:------- |:--- |---|------ |
24-
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
26-
27-
28-
### 请求参数示例
23+
|operationID|1646445464564|Required|string|operationID used for global link tracking|
24+
|token|eyJhbxxxx3Xs|Required|string|Admin token|
2925

26+
### Request Parameter Example
3027

3128
```json
3229
{
3330
"groupID": "889944039",
3431
"userID": "2824146701"
3532
}
3633
```
37-
|字段名|选填|类型|说明|
34+
| Field Name | Optional | Type | Description |
3835
|:---- |:------- |:--- |---|
39-
|groupID|必填|string|群ID|
40-
|userID|必填|string|群成员ID|
41-
### 成功返回示例
36+
|groupID|Required|string|Group ID|
37+
|userID|Required|string|Group Member ID|
4238

39+
### Successful Response Example
4340

4441
```json
4542
{
@@ -48,17 +45,16 @@ hide_title: true
4845
"errDlt": ""
4946
}
5047
```
51-
### 成功返回示例的参数说明
48+
### Successful Response Parameter Description
5249

53-
54-
|参数名|类型|说明|
50+
| Parameter Name | Type | Description |
5551
|:---- |:------- |:--- |
56-
|errCode|int|错误码,0表示成功|
57-
|errMsg|string|错误简要信息,无错误时为空|
58-
|errDlt|errDlt|错误详细信息,无错误时为空|
59-
|data|object|通用数据对象，具体结构见下方|
60-
### 失败返回示例
52+
|errCode|int|Error code, 0 indicates success|
53+
|errMsg|string|Brief error message, empty when no error|
54+
|errDlt|errDlt|Detailed error message|
55+
|data|object|Generic data object, specific structure seen below|
6156

57+
### Failed Response Example
6258

6359
```json
6460
{
@@ -67,11 +63,10 @@ hide_title: true
6763
"errDlt": ": [1004]RecordNotFoundError"
6864
}
6965
```
70-
### 失败返回示例的参数说明
71-
66+
### Failed Response Parameter Description
7267

73-
|参数名|类型|说明|
68+
| Parameter Name | Type | Description |
7469
|:---- |:------- |:--- |
75-
|errCode|int|错误码,具体查看全局错误码文档|
76-
|errMsg|string|错误简要信息|
77-
|errDlt|errDlt|错误详细信息|
70+
|errCode|int|Error code, refer to the global error code documentation for specifics|
71+
|errMsg|string|Brief error message|
72+
|errDlt|errDlt|Detailed error message|

‎i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/createGroup.mdx‎

Lines changed: 42 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,31 @@
11
---
22
sidebar_position: 1
3-
title: 创建群组
3+
title: create_group
44
hide_title: true
55
---
66

77
<center>
88

9-
## 创建群组
9+
## create_group
1010

1111
</center>
1212

13-
### 简要描述
14-
- 创建群组。
15-
### 请求方式
13+
### Brief Description
14+
- Create a group.
15+
### Request Method
1616
- `post`
17-
### 请求URL
17+
### Request URL
1818
- `http://x.x.x.x:10002/group/create_group`
1919

2020

2121
### Header
22-
|header名|示例值|选填|类型|说明|
22+
| Header Name | Example Value | Optional | Type | Description |
2323
|:---- |:------- |:--- |---|------ |
24-
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|
25-
|token|eyJhbxxxx3Xs|必填|string|管理员token|
24+
|operationID|1646445464564|Required|string|operationID used for global link tracking|
25+
|token|eyJhbxxxx3Xs|Required|string|Admin token|
2626

2727

28-
### 请求参数示例
29-
28+
### Request Parameter Example
3029

3130
```json
3231
{
@@ -39,7 +38,7 @@ hide_title: true
3938
"ownerUserID": "1054527962",
4039
"groupInfo": {
4140
"groupID": "xadxwr24",
42-
"groupName": "yourg group name",
41+
"groupName": "your group name",
4342
"notification": "notification",
4443
"introduction": "introduction",
4544
"faceURL": "faceURL url",
@@ -51,24 +50,24 @@ hide_title: true
5150
}
5251
}
5352
```
54-
|字段名|选填|类型|说明|
53+
| Field Name | Optional | Type | Description |
5554
|:---- |:------- |:--- |---|
56-
|memberUserIDs|必填|array|群成员列表|
57-
|adminUserIDs|必填|array|群管理员列表|
58-
|ownerUserID|必填|string|群主|
59-
|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||
70-
### 成功返回示例
71-
55+
|memberUserIDs|Required|array|Group member list|
56+
|adminUserIDs|Required|array|Group admin list|
57+
|ownerUserID|Required|string|Group owner|
58+
|groupInfo|Required|object|[Group Information](docs/restapi/commonFields.mdx#groupinfo) list|
59+
|groupInfo.groupID|Optional|string||
60+
|groupInfo.groupName|Required|string||
61+
|groupInfo.notification|Required|string||
62+
|groupInfo.introduction|Required|string||
63+
|groupInfo.faceURL|Required|string||
64+
|groupInfo.ex|Required|string||
65+
|groupInfo.groupType|Required|int||
66+
|groupInfo.needVerification|Required|int||
67+
|groupInfo.lookMemberInfo|Required|int||
68+
|groupInfo.applyMemberFriend|Required|int||
69+
70+
### Successful Response Example
7271

7372
```json
7473
{
@@ -78,7 +77,7 @@ hide_title: true
7877
"data": {
7978
"groupInfo": {
8079
"groupID": "xadxwr24",
81-
"groupName": "yourg group name",
80+
"groupName": "your group name",
8281
"notification": "notification",
8382
"introduction": "introduction",
8483
"faceURL": "faceURL url",
@@ -98,18 +97,17 @@ hide_title: true
9897
}
9998
}
10099
```
101-
### 成功返回示例的参数说明
100+
### Successful Response Parameter Description
102101

103-
104-
|参数名|类型|说明|
102+
| Parameter Name | Type | Description |
105103
|:---- |:------- |:--- |
106-
|errCode|int|错误码,0表示成功|
107-
|errMsg|string|错误简要信息,无错误时为空|
108-
|errDlt|errDlt|错误详细信息,无错误时为空|
109-
|data|object|通用数据对象，具体结构见下方|
110-
|groupInfo|object|[群信息](docs/restapi/commonFields.mdx#groupinfo)列表|
111-
### 失败返回示例
104+
|errCode|int|Error code, 0 indicates success|
105+
|errMsg|string|Brief error message, empty when no error|
106+
|errDlt|errDlt|Detailed error message|
107+
|data|object|Generic data object, specific structure as below|
108+
|groupInfo|object|[Group Information](docs/restapi/commonFields.mdx#groupinfo) list|
112109

110+
### Failed Response Example
113111

114112
```json
115113
{
@@ -118,11 +116,10 @@ hide_title: true
118116
"errDlt": "group id existed xadxwr24: [1202]GroupIDExisted"
119117
}
120118
```
121-
### 失败返回示例的参数说明
122-
119+
### Failed Response Parameter Description
123120

124-
|参数名|类型|说明|
121+
| Parameter Name | Type | Description |
125122
|:---- |:------- |:--- |
126-
|errCode|int|错误码,具体查看全局错误码文档|
127-
|errMsg|string|错误简要信息|
128-
|errDlt|errDlt|错误详细信息|
123+
|errCode|int|Error code, refer to global error code documentation for specifics|
124+
|errMsg|string|Brief error message|
125+
|errDlt|errDlt|Detailed error message|

0 commit comments

Comments
 (0)