Skip to content

Commit ced7d98

Browse files
icey-yuicey-yu
committed
feat: notification doc
1 parent 459c3f2 commit ced7d98

4 files changed

Lines changed: 66 additions & 52 deletions

File tree

‎docs/restapi/apis/userManagement/addNotificationAccount.mdx‎

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22
sidebar_position: 13
3-
title: 增加系统通知号
3+
title: 增加系统号
44
hide_title: true
55
---
66

77
<center>
8-
9-
## 增加系统通知号
8+
## 增加系统号
109

1110
</center>
1211

1312
### 简要描述
1413

15-
- 增加系统通知号，管理员可以以系统通知号身份发送通知消息。
14+
- 增加系统号，管理员可以以系统号身份发送通知消息。
15+
- 系统号**无法获取token**
1616

1717
### 请求方式
1818

@@ -35,23 +35,31 @@ hide_title: true
3535
{
3636
"userID": "userID",
3737
"nickName": "notification1",
38-
"faceURL": "url"
38+
"faceURL": "url",
39+
"appMangerLevel": 3
3940
}
4041
```
4142

42-
| 字段名 | 选填 | 类型 | 说明 |
43-
| :------- | :--- | :----- | -------------- |
44-
| userID | 选填 | string | 系统通知号 ID |
45-
| nickName | 必填 | string | 系统通知号昵称 |
46-
| faceURL | 必填 | string | 系统通知号头像 |
43+
| 字段名 | 选填 | 类型 | 说明 |
44+
| :------------- | :--- | :----- | ------------------------------------------------ |
45+
| userID | 选填 | string | 系统号 ID |
46+
| nickName | 必填 | string | 系统号昵称 |
47+
| faceURL | 必填 | string | 系统号头像 |
48+
| appMangerLevel | 必填 | int | [系统号类型](docs/restapi/apis/commonFields.mdx) |
4749

4850
### 成功返回示例
4951

5052
```json
5153
{
52-
"errCode": 0,
53-
"errMsg": "",
54-
"errDlt": ""
54+
"errCode": 0,
55+
"errMsg": "",
56+
"errDlt": "",
57+
"data": {
58+
"userID": "userID",
59+
"faceURL": "url",
60+
"nickName": "notification1",
61+
"appMangerLevel": 3
62+
}
5563
}
5664
```
5765

@@ -62,6 +70,7 @@ hide_title: true
6270
| errCode | int | 错误码，0 表示成功 |
6371
| errMsg | string | 错误简要信息，为空 |
6472
| errDlt | errDlt | 错误详细信息，为空 |
73+
| data | object | 系统号信息 |
6574

6675
### 失败返回示例
6776

‎docs/restapi/apis/userManagement/searchNotificationAccount.mdx‎

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
---
22
sidebar_position: 12
3-
title: 获取系统通知号
3+
title: 获取系统号
44
hide_title: true
55
---
66

77
<center>
8-
9-
## 获取系统通知号
8+
## 获取系统号
109

1110
</center>
1211

1312
### 简要描述
1413

15-
- 管理员可以获取所创建的系统通知号列表，包括 ID、头像和名称。
14+
- 管理员可以获取所创建的系统号列表，包括 ID、头像和名称。
1615

1716
### 请求方式
1817

@@ -41,12 +40,12 @@ hide_title: true
4140
}
4241
```
4342

44-
| 字段名 | 选填 | 类型 | 说明 |
45-
| :-------------------- | :--- | :----- | ----------------------------------------------------------- |
46-
| keyword | 选填 | string | 填写 userID 或 nickname，不填时默认返回对应分页的系统通知号 |
47-
| pagination | 必填 | object | 分页参数结构体 |
48-
| pagination.pageNumber | 必填 | int | 当前页码，从 1 开始 |
49-
| pagination.showNumber | 必填 | int | 当前页请求数量 |
43+
| 字段名 | 选填 | 类型 | 说明 |
44+
| :-------------------- | :--- | :----- | ------------------------------------------------------- |
45+
| keyword | 选填 | string | 填写 userID 或 nickname，不填时默认返回对应分页的系统号 |
46+
| pagination | 必填 | object | 分页参数结构体 |
47+
| pagination.pageNumber | 必填 | int | 当前页码，从 1 开始 |
48+
| pagination.showNumber | 必填 | int | 当前页请求数量 |
5049

5150
### 成功返回示例
5251

@@ -61,22 +60,26 @@ hide_title: true
6160
{
6261
"userID": "1974356875",
6362
"faceURL": "url",
64-
"nickName": "notification1111111"
63+
"nickName": "notification1111111",
64+
"appMangerLevel": 3
6565
},
6666
{
6767
"userID": "8719627904",
6868
"faceURL": "",
69-
"nickName": "notification1"
69+
"nickName": "notification1",
70+
"appMangerLevel": 3
7071
},
7172
{
7273
"userID": "4208409642",
7374
"faceURL": "",
74-
"nickName": "notification1"
75+
"nickName": "notification1",
76+
"appMangerLevel": 3
7577
},
7678
{
7779
"userID": "2776836221",
7880
"faceURL": "",
79-
"nickName": "notification1"
81+
"nickName": "robot",
82+
"appMangerLevel": 4
8083
}
8184
]
8285
}
@@ -91,11 +94,12 @@ hide_title: true
9194
| errMsg | string | 错误简要信息，为空 |
9295
| errDlt | errDlt | 错误详细信息，为空 |
9396
| data | object | 通用数据对象，具体结构见下方 |
94-
| total | int | 系统通知号总数 |
95-
| notificationAccounts | array | 系统通知号列表 |
96-
| userID | string | 系统通知号 ID |
97-
| faceURL | string | 系统通知号头像 |
98-
| nickName | string | 系统通知号名称 |
97+
| total | int | 系统号总数 |
98+
| notificationAccounts | array | 系统号列表 |
99+
| userID | string | 系统号 ID |
100+
| faceURL | string | 系统号头像 |
101+
| nickName | string | 系统号名称 |
102+
| appMangerLevel | int | [系统号类型](docs/restapi/apis/commonFields.mdx) |
99103

100104
### 失败返回示例
101105

‎docs/restapi/apis/userManagement/updateNotificationAccount.mdx‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22
sidebar_position: 16
3-
title: 修改系统通知号信息
3+
title: 修改系统号信息
44
hide_title: true
55
---
66

77
<center>
88

9-
## 修改系统通知号信息
9+
## 修改系统号信息
1010

1111
</center>
1212

1313
### 简要描述
1414

15-
- 修改系统通知号信息，包括头像和名称。
15+
- 修改系统号信息，包括头像和名称。
1616

1717
### 请求方式
1818

@@ -39,11 +39,11 @@ hide_title: true
3939
}
4040
```
4141

42-
| 字段名 | 选填 | 类型 | 说明 |
43-
| :------- | :--- | :----- | -------------- |
44-
| userID | 必填 | string | 系统通知号 ID |
45-
| nickName | 必填 | string | 系统通知号名称 |
46-
| faceURL | 必填 | string | 系统通知号头像 |
42+
| 字段名 | 选填 | 类型 | 说明 |
43+
| :------- | :--- | :----- | ---------- |
44+
| userID | 必填 | string | 系统号 ID |
45+
| nickName | 必填 | string | 系统号名称 |
46+
| faceURL | 必填 | string | 系统号头像 |
4747

4848
### 成功返回示例
4949

‎docs/restapi/commonFields.mdx‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,19 @@ title: 常用字段说明
55

66
## 通用字段说明
77

8-
| 字段名 | 类型 | 字符串长度限制 | 说明 | 取值说明 |
9-
| -------------- | ------ | -------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
10-
| secret | string | 32 | OpenIM 秘钥，服务端 config/share.yml 的 secret 字段 | 字符串 |
11-
| platformID | int | | 用户登录时的终端类型 | 1：iOS，2：Android，3：Windows，4：OSX，5：WEB，6：小程序，7：linux，8：AndroidPad，9：IPad，10：Admin|
12-
| userID | string | 64 | 用户 ID，保证 IM 内唯一 | 字符串 |
13-
| nickname | string | 255 | 昵称 | 字符串 |
14-
| faceURL | string | 255 | 头像URL | URL 链接 |
15-
| ex | string | 1024 | 扩展字段，可自行扩展，建议封装成 JSON 字符串 | 字符串/JSON |
16-
| operationID | string | | 操作 ID，用于定位问题，保持唯一，建议用当前时间、随机数和 userID | 字符串 |
17-
| operatorUserID | string | 64 | 操作者，具体含义视上下文而定 | 字符串 |
18-
| groupID | string | 64 | 群 ID ，保证 IM 内唯一 | 字符串 |
19-
| sessionType | int | | 会话类型 | 1：单聊，3：群聊，4：系统通知 |
8+
| 字段名 | 类型 | 字符串长度限制 | 说明 | 取值说明 |
9+
| -------------- | ------ | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
10+
| secret | string | 32 | OpenIM 秘钥，服务端 config/share.yml 的 secret 字段 | 字符串 |
11+
| platformID | int | | 用户登录时的终端类型 | 1：iOS，2：Android，3：Windows，4：OSX，5：WEB，6：小程序，7：linux，8：AndroidPad，9：IPad，10：Admin |
12+
| userID | string | 64 | 用户 ID，保证 IM 内唯一 | 字符串 |
13+
| nickname | string | 255 | 昵称 | 字符串 |
14+
| faceURL | string | 255 | 头像URL | URL 链接 |
15+
| ex | string | 1024 | 扩展字段，可自行扩展，建议封装成 JSON 字符串 | 字符串/JSON |
16+
| operationID | string | | 操作 ID，用于定位问题，保持唯一，建议用当前时间、随机数和 userID | 字符串 |
17+
| operatorUserID | string | 64 | 操作者，具体含义视上下文而定 | 字符串 |
18+
| groupID | string | 64 | 群 ID ，保证 IM 内唯一 | 字符串 |
19+
| sessionType | int | | 会话类型 | 1：单聊，3：群聊，4：系统通知 |
20+
| appMangerLevel | int | | 系统号类型 | 3：系统通知号；4：机器人账号； |
2021

2122
## PublicUserInfo
2223

0 commit comments

Comments
 (0)