Skip to content

Commit 858deab

Browse files
mo3etmo3et
authored
docs: update docs contents. (#178)
* docs: update docs. * docs: update docs. * docs: update docs contents. * docs: update docs contents.
1 parent 3924dae commit 858deab

42 files changed

Lines changed: 107 additions & 112 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/restapi/apis/authenticationManagement/forceLogout.mdx‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ hide_title: true
4040

4141
| 字段名 | 选填 | 类型 | 说明 |
4242
| :--------- | :--- | :----- | ----------------------------------------------------------------------------------------------------------------- |
43-
| platformID | 必填 | int | 平台 ID， 1：IOS，2：Android，3：Windows，4：OSX，5：Web，6：MiniWeb，7：Linux，8：Android Pad，9：IPad，10：admin |
43+
| platformID | 必填 | int | [用户登录时的终端类型](docs/restapi/commonFields.mdx)，取值为1-9 |
4444
| userID | 必填 | string | 用户 ID |
4545

4646
### 成功返回示例
@@ -60,7 +60,6 @@ hide_title: true
6060
| errCode | int | 错误码，0 表示成功 |
6161
| errMsg | string | 错误简要信息，为空 |
6262
| errDlt | errDlt | 错误详细信息，为空 |
63-
| data | object | 通用数据对象，具体结构见下方 |
6463

6564
### 失败返回示例
6665

‎docs/restapi/apis/authenticationManagement/getToken.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ hide_title: true
4040
}
4141
```
4242

43-
| 字段名 | 选填 | 类型 | 说明 |
44-
| :--------- | :--- | :----- | ----------------------------------------------------------------------------------------------------------------- |
45-
| secret | 必填 | string | openIM 密钥，见 config/share.yaml 中 secret 字段 |
46-
| platformID | 必填 | int | 平台 ID， 1：IOS，2：Android，3：Windows，4：OSX，5：Web，6：MiniWeb，7：Linux，8：Android Pad，9：IPad，10：admin |
47-
| userID | 必填 | string | APP 管理员 ID，为`imAdmin` |
43+
| 字段名 | 选填 | 类型 | 说明 |
44+
| :--------- | :--- | :----- | ------------------------------------------------------------------ |
45+
| secret | 必填 | string | openIM 密钥，见 config/share.yaml 中 secret 字段，默认为 openIM123 |
46+
| platformID | 必填 | int | [用户登录时的终端类型](docs/restapi/commonFields.mdx)，取值为 10 |
47+
| userID | 必填 | string | APP 管理员 ID，为`imAdmin` |
4848

4949
### 成功返回示例
5050

‎docs/restapi/apis/authenticationManagement/getUserToken.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ hide_title: true
1212

1313
### 简要描述
1414

15-
- 获取用户的 token。
15+
- 获取用户的 token，需指定用户登录时所使用的终端类型。
1616

1717

1818
### 请求方式
@@ -41,7 +41,7 @@ hide_title: true
4141

4242
| 字段名 | 选填 | 类型 | 说明 |
4343
| :--------- | :--- | :----- | ----------------------------------------------------------------------------------------------------------------- |
44-
| platformID | 必填 | int | 平台 ID， 1：IOS，2：Android，3：Windows，4：OSX，5：Web，6：MiniWeb，7：Linux，8：Android Pad，9：IPad，10：admin |
44+
| platformID | 必填 | int | [用户登录时的终端类型](docs/restapi/commonFields.mdx)，取值为1-9 |
4545
| userID | 必填 | string | 用户 ID |
4646

4747
### 成功返回示例

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 8
2+
sidebar_position: 1
33
title: 获取当前用户的分页会话列表
44
hide_title: true
55
---
@@ -444,8 +444,8 @@ hide_title: true
444444
|参数名|类型|说明|
445445
|:---- |:------- |:--- |
446446
|errCode|int|错误码，0表示成功|
447-
|errMsg|string|错误简要信息，无错误时为空|
448-
|errDlt|errDlt|错误详细信息，无错误时为空|
447+
|errMsg|string|错误简要信息，为空|
448+
|errDlt|errDlt|错误详细信息，为空|
449449
|data|object|通用数据对象，具体结构见下方|
450450
|total|string|会话总数|
451451
|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
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 8
2+
sidebar_position: 2
33
title: 获取排序后的会话列表
44
hide_title: true
55
---

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 7
2+
sidebar_position: 3
33
title: 多个用户对同一会话设置字段
44
hide_title: true
55
---
@@ -79,8 +79,8 @@ hide_title: true
7979
|参数名|类型|说明|
8080
|:---- |:------- |:--- |
8181
|errCode|int|错误码，0表示成功|
82-
|errMsg|string|错误简要信息，无错误时为空|
83-
|errDlt|errDlt|错误详细信息，无错误时为空|
82+
|errMsg|string|错误简要信息，为空|
83+
|errDlt|errDlt|错误详细信息，为空|
8484
|data|object|通用数据对象，具体结构见下方|
8585
### 失败返回示例
8686

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 18
2+
sidebar_position: 17
33
title: 取消群禁言
44
hide_title: true
55
---
@@ -52,8 +52,8 @@ hide_title: true
5252
|参数名|类型|说明|
5353
|:---- |:------- |:--- |
5454
|errCode|int|错误码，0表示成功|
55-
|errMsg|string|错误简要信息，无错误时为空|
56-
|errDlt|errDlt|错误详细信息，无错误时为空|
55+
|errMsg|string|错误简要信息，为空|
56+
|errDlt|errDlt|错误详细信息，为空|
5757
|data|object|通用数据对象，具体结构见下方|
5858
### 失败返回示例
5959

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 20
2+
sidebar_position: 19
33
title: 取消禁言群成员
44
hide_title: true
55
---
@@ -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/createGroup.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -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: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 14
2+
sidebar_position: 21
33
title: 解散群
44
hide_title: true
55
---
@@ -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

0 commit comments

Comments
 (0)