Skip to content

Commit 968d7e0

Browse files
committed
Merge: main
2 parents cf16f71 + a00bcd7 commit 968d7e0

84 files changed

Lines changed: 519 additions & 4930 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/getToken.mdx

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

77
<center>
88

9-
## 以 secret 获取 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

@@ -26,8 +26,8 @@ hide_title: true
2626

2727
### Header
2828

29-
| header 名 | 示例值 | 选填 | 类型 | 说明 |
30-
| :---------- | :------------ | :--- | ------ | ---------------------------- |
29+
| header 名 | 示例值 | 选填 | 类型 | 说明 |
30+
| :---------- | :------------ | :--- | ------ | -------------------------------------------------- |
3131
| operationID | 1646445464564 | 必填 | string | 用于全局链路追踪,建议使用时间戳,在每个请求中独立 |
3232

3333
### 请求参数示例
@@ -36,15 +36,15 @@ hide_title: true
3636
{
3737
"secret": "openIM123",
3838
"platformID": 1,
39-
"userID": "111111"
39+
"userID": "imAdmin"
4040
}
4141
```
4242

4343
| 字段名 | 选填 | 类型 | 说明 |
4444
| :--------- | :--- | :----- | ----------------------------------------------------------------------------------------------------------------- |
4545
| secret | 必填 | string | openIM 密钥,见 config/share.yaml 中 secret 字段 |
4646
| 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` |
47+
| userID | 必填 | string | APP 管理员 ID,`imAdmin` |
4848

4949
### 成功返回示例
5050

@@ -65,8 +65,8 @@ hide_title: true
6565
| 参数名 | 类型 | 说明 |
6666
| :---------------- | :----- | :--------------------------- |
6767
| errCode | int | 错误码,0 表示成功 |
68-
| errMsg | string | 错误简要信息,为空 |
69-
| errDlt | errDlt | 错误详细信息,为空 |
68+
| errMsg | string | 错误简要信息,为空 |
69+
| errDlt | errDlt | 错误详细信息,为空 |
7070
| data | object | 通用数据对象,具体结构见下方 |
7171
| token | string | 获取到的用户 token |
7272
| expireTimeSeconds | string | token 的过期时间(单位秒) |

docs/restapi/apis/authenticationManagement/getUserToken.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
2-
sidebar_position: 1
3-
title: 获取普通用户token
2+
sidebar_position: 2
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

docs/restapi/apis/conversationManagement/getOwnerConversation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ hide_title: true
2727
### 请求方式
2828
- `post`
2929
### 请求URL
30-
- `http://x.x.x.x:10002/conversation/get_owner_conversation`
30+
- `{API_ADDRESS}/conversation/get_owner_conversation`
3131

3232

3333
### Header

docs/restapi/apis/conversationManagement/getSortedConversationList.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ hide_title: true
1515
### 请求方式
1616
- `post`
1717
### 请求URL
18-
- `http://x.x.x.x:10002/conversation/get_sorted_conversation_list`
18+
- `{API_ADDRESS}/conversation/get_sorted_conversation_list`
1919

2020
### Header
2121

docs/restapi/apis/conversationManagement/setConversations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ hide_title: true
2727
### 请求方式
2828
- `post`
2929
### 请求URL
30-
- `http://x.x.x.x:10002/conversation/set_conversations`
30+
- `{API_ADDRESS}/conversation/set_conversations`
3131

3232

3333
### Header

docs/restapi/apis/friendsManagement/addBlackList.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 12
2+
sidebar_position: 21
33
title: 添加黑名单
44
hide_title: true
55
---

docs/restapi/apis/friendsManagement/checkFriend.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 1
2+
sidebar_position: 14
33
title: 检查好友关系
44
hide_title: true
55
---

docs/restapi/apis/friendsManagement/deleteBlackList.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 13
2+
sidebar_position: 22
33
title: 移除黑名单
44
hide_title: true
55
---

docs/restapi/apis/friendsManagement/deleteFriend.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 15
33
title: 删除好友
44
hide_title: true
55
---

docs/restapi/apis/friendsManagement/getBlackList.mdx

Lines changed: 1 addition & 1 deletion
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
---

0 commit comments

Comments
 (0)