Skip to content

Commit 19dc53e

Browse files
withchaowithchao
authored
Merge branch 'openimsdk:main' into main
2 parents 1995458 + 858deab commit 19dc53e

66 files changed

Lines changed: 312 additions & 330 deletions

File tree

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: 3 additions & 4 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
### 成功返回示例
@@ -57,10 +57,9 @@ hide_title: true
5757

5858
| 参数名 | 类型 | 说明 |
5959
| :------ | :----- | :--------------------------- |
60-
| errCode | int | 错误码,0 表示成功 |
60+
| errCode | int | 错误码，0 表示成功 |
6161
| errMsg | string | 错误简要信息，为空 |
6262
| errDlt | errDlt | 错误详细信息，为空 |
63-
| data | object | 通用数据对象，具体结构见下方 |
6463

6564
### 失败返回示例
6665

@@ -76,6 +75,6 @@ hide_title: true
7675

7776
| 参数名 | 类型 | 说明 |
7877
| :------ | :----- | :---------------------------- |
79-
| errCode | int | 错误码,具体查看全局错误码文档 |
78+
| errCode | int | 错误码，具体查看全局错误码文档 |
8079
| errMsg | string | 错误简要信息 |
8180
| errDlt | errDlt | 错误详细信息 |

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
22
sidebar_position: 1
3-
title: 获取用户token
3+
title: 获取管理员token
44
hide_title: true
55
---
66

77
<center>
88

9-
## 获取用户 token
9+
## 获取管理员 token
1010

1111
</center>
1212

1313
### 简要描述
1414

15-
- 获取用户或 APP 管理员 token。
15+
- 获取 APP 管理员 token。
1616

17-
⚠️ **注意**: OpenIM Server 内置了一个 APP 管理员，它的 `userID` 是`imAdmin`：
17+
⚠️ **注意**: OpenIM Server 内置了一个 APP 管理员，它的 `userID` 是`imAdmin`
1818

1919
### 请求方式
2020

@@ -36,15 +36,15 @@ hide_title: true
3636
{
3737
"secret": "openIM123",
3838
"platformID": 1,
39-
"userID": "111111"
39+
"userID": "imAdmin"
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 | 用户 ID 或管理员 ID， 如生成管理员 token， 需填写 `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

@@ -64,7 +64,7 @@ hide_title: true
6464

6565
| 参数名 | 类型 | 说明 |
6666
| :---------------- | :----- | :--------------------------- |
67-
| errCode | int | 错误码,0 表示成功 |
67+
| errCode | int | 错误码，0 表示成功 |
6868
| errMsg | string | 错误简要信息，为空 |
6969
| errDlt | errDlt | 错误详细信息，为空 |
7070
| data | object | 通用数据对象，具体结构见下方 |
@@ -85,6 +85,6 @@ hide_title: true
8585

8686
| 参数名 | 类型 | 说明 |
8787
| :------ | :----- | :---------------------------- |
88-
| errCode | int | 错误码,具体查看全局错误码文档 |
88+
| errCode | int | 错误码，具体查看全局错误码文档 |
8989
| errMsg | string | 错误简要信息 |
9090
| errDlt | errDlt | 错误详细信息 |

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
sidebar_position: 2
3-
title: 管理员获取用户token
3+
title: 获取用户token
44
hide_title: true
55
---
66

77
<center>
88

9-
## 管理员获取用户 token
9+
## 获取用户 token
1010

1111
</center>
1212

1313
### 简要描述
1414

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

17-
⚠️ **注意**: OpenIM Server 内置了一个 APP 管理员，它的 `userID` 是`imAdmin`：
1817

1918
### 请求方式
2019

@@ -42,7 +41,7 @@ hide_title: true
4241

4342
| 字段名 | 选填 | 类型 | 说明 |
4443
| :--------- | :--- | :----- | ----------------------------------------------------------------------------------------------------------------- |
45-
| 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 |
4645
| userID | 必填 | string | 用户 ID |
4746

4847
### 成功返回示例
@@ -63,7 +62,7 @@ hide_title: true
6362

6463
| 参数名 | 类型 | 说明 |
6564
| :---------------- | :----- | :--------------------------- |
66-
| errCode | int | 错误码,0 表示成功 |
65+
| errCode | int | 错误码，0 表示成功 |
6766
| errMsg | string | 错误简要信息，为空 |
6867
| errDlt | errDlt | 错误详细信息，为空 |
6968
| data | object | 通用数据对象，具体结构见下方 |
@@ -84,6 +83,6 @@ hide_title: true
8483

8584
| 参数名 | 类型 | 说明 |
8685
| :------ | :----- | :---------------------------- |
87-
| errCode | int | 错误码,具体查看全局错误码文档 |
86+
| errCode | int | 错误码，具体查看全局错误码文档 |
8887
| errMsg | string | 错误简要信息 |
8988
| errDlt | errDlt | 错误详细信息 |

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

Lines changed: 4 additions & 5 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
---
@@ -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

@@ -444,7 +443,7 @@ hide_title: true
444443

445444
|参数名|类型|说明|
446445
|:---- |:------- |:--- |
447-
|errCode|int|错误码,0表示成功|
446+
|errCode|int|错误码，0表示成功|
448447
|errMsg|string|错误简要信息，为空|
449448
|errDlt|errDlt|错误详细信息，为空|
450449
|data|object|通用数据对象，具体结构见下方|
@@ -465,6 +464,6 @@ hide_title: true
465464

466465
|参数名|类型|说明|
467466
|:---- |:------- |:--- |
468-
|errCode|int|错误码,具体查看全局错误码文档|
467+
|errCode|int|错误码，具体查看全局错误码文档|
469468
|errMsg|string|错误简要信息|
470469
|errDlt|errDlt|错误详细信息|

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
sidebar_position: 8
2+
sidebar_position: 2
33
title: 获取排序后的会话列表
44
hide_title: true
55
---
66

77
<center>
8+
89
## 获取排序后的会话列表
910

1011
</center>
@@ -21,8 +22,8 @@ hide_title: true
2122

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

2728
### 请求参数示例
2829

@@ -116,7 +117,7 @@ hide_title: true
116117

117118
| 字段名 | 类型 | 说明 |
118119
|:------------------|:---------|----------------------------------------------------------------------------------|
119-
| errCode | int | 错误码,0表示成功 |
120+
| errCode | int | 错误码，0表示成功 |
120121
| errMsg | string | 错误简要信息，为空 |
121122
| errDlt | errDlt | 错误详细信息，为空 |
122123
| unreadTotal | string |未读数总数 |
@@ -159,6 +160,6 @@ hide_title: true
159160

160161
|参数名|类型|说明|
161162
|:---- |:------- |:--- |
162-
|errCode|int|错误码,具体查看全局错误码文档|
163+
|errCode|int|错误码，具体查看全局错误码文档|
163164
|errMsg|string|错误简要信息|
164165
|errDlt|errDlt|错误详细信息|

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

Lines changed: 6 additions & 5 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
---
@@ -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|设置会话阅后即焚时间，单位秒|
@@ -77,7 +78,7 @@ hide_title: true
7778

7879
|参数名|类型|说明|
7980
|:---- |:------- |:--- |
80-
|errCode|int|错误码,0表示成功|
81+
|errCode|int|错误码，0表示成功|
8182
|errMsg|string|错误简要信息，为空|
8283
|errDlt|errDlt|错误详细信息，为空|
8384
|data|object|通用数据对象，具体结构见下方|
@@ -96,6 +97,6 @@ hide_title: true
9697

9798
|参数名|类型|说明|
9899
|:---- |:------- |:--- |
99-
|errCode|int|错误码,具体查看全局错误码文档|
100+
|errCode|int|错误码，具体查看全局错误码文档|
100101
|errMsg|string|错误简要信息|
101102
|errDlt|errDlt|错误详细信息|

‎docs/restapi/apis/friendsManagement/addBlackList.mdx‎

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

6060
| 参数名 | 类型 | 说明 |
6161
| :------ | :----- | :--------------------------- |
62-
| errCode | int | 错误码,0 表示成功 |
62+
| errCode | int | 错误码，0 表示成功 |
6363
| errMsg | string | 错误简要信息，为空 |
6464
| errDlt | errDlt | 错误详细信息，为空 |
6565
| data | object | 通用数据对象，具体结构见下方 |
@@ -78,6 +78,6 @@ hide_title: true
7878

7979
| 参数名 | 类型 | 说明 |
8080
| :------ | :----- | :---------------------------- |
81-
| errCode | int | 错误码,具体查看全局错误码文档 |
81+
| errCode | int | 错误码，具体查看全局错误码文档 |
8282
| errMsg | string | 错误简要信息 |
8383
| errDlt | errDlt | 错误详细信息 |

‎docs/restapi/apis/friendsManagement/checkFriend.mdx‎

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

6262
| 参数名 | 类型 | 说明 |
6363
| :------------- | :------ | :------------------------------------ |
64-
| errCode | int | 错误码,0 表示成功 |
64+
| errCode | int | 错误码，0 表示成功 |
6565
| errMsg | string | 错误简要信息，为空 |
6666
| errDlt | errDlt | 错误详细信息，为空 |
6767
| data | object | 通用数据对象，具体结构见下方 |
@@ -82,6 +82,6 @@ hide_title: true
8282

8383
| 参数名 | 类型 | 说明 |
8484
| :------ | :----- | :---------------------------- |
85-
| errCode | int | 错误码,具体查看全局错误码文档 |
85+
| errCode | int | 错误码，具体查看全局错误码文档 |
8686
| errMsg | string | 错误简要信息 |
8787
| errDlt | errDlt | 错误详细信息 |

‎docs/restapi/apis/friendsManagement/deleteBlackList.mdx‎

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

5858
| 参数名 | 类型 | 说明 |
5959
| :------ | :----- | :--------------------------- |
60-
| errCode | int | 错误码,0 表示成功 |
60+
| errCode | int | 错误码，0 表示成功 |
6161
| errMsg | string | 错误简要信息，为空 |
6262
| errDlt | errDlt | 错误详细信息，为空 |
6363
| data | object | 通用数据对象，具体结构见下方 |
@@ -76,6 +76,6 @@ hide_title: true
7676

7777
| 参数名 | 类型 | 说明 |
7878
| :------ | :----- | :---------------------------- |
79-
| errCode | int | 错误码,具体查看全局错误码文档 |
79+
| errCode | int | 错误码，具体查看全局错误码文档 |
8080
| errMsg | string | 错误简要信息 |
8181
| errDlt | errDlt | 错误详细信息 |

‎docs/restapi/apis/friendsManagement/deleteFriend.mdx‎

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

5858
| 参数名 | 类型 | 说明 |
5959
| :------ | :----- | :--------------------------- |
60-
| errCode | int | 错误码,0 表示成功 |
60+
| errCode | int | 错误码，0 表示成功 |
6161
| errMsg | string | 错误简要信息，为空 |
6262
| errDlt | errDlt | 错误详细信息，为空 |
6363
| data | object | 通用数据对象，具体结构见下方 |
@@ -76,6 +76,6 @@ hide_title: true
7676

7777
| 参数名 | 类型 | 说明 |
7878
| :------ | :----- | :---------------------------- |
79-
| errCode | int | 错误码,具体查看全局错误码文档 |
79+
| errCode | int | 错误码，具体查看全局错误码文档 |
8080
| errMsg | string | 错误简要信息 |
8181
| errDlt | errDlt | 错误详细信息 |

0 commit comments

Comments
 (0)