Skip to content

Commit 843d591

Browse files
skiffer-gitskiffer-git
committed
doc
1 parent 54a8214 commit 843d591

1 file changed

Lines changed: 87 additions & 105 deletions

File tree

‎docs/restapi/contentDescription.mdx‎

Lines changed: 87 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
sidebar_position: 10
3-
title: 消息详细类型描述文档
3+
title: 消息详细类型描述文档
44
toc_max_heading_level: 4
55
---
66

7-
## ContentType
7+
## ContentType 📄
88

99
### **简要描述**
1010

11-
- msg/send_msg API 请求字段中 contentType 支持的消息类型说明以及消息 content 的具体字段说明。
11+
- `msg/send_msg` API 请求字段中 `contentType` 支持的消息类型说明以及消息 `content` 的具体字段说明。
1212

1313
### **ContentType 消息类型说明**
1414

@@ -19,16 +19,16 @@ toc_max_heading_level: 4
1919
| 103 | 音频消息 |
2020
| 104 | 视频消息 |
2121
| 105 | 文件消息 |
22-
| 106 | @消息 |
22+
| 106 | @消息 |
2323
| 109 | 位置消息 |
2424
| 110 | 自定义消息 |
2525
| 1400 | 系统通知类型消息 |
2626

27-
### **Content 具体内容**
27+
### **Content 具体内容** 📋
2828

29-
- content 内部为具体的 json 对象，不同的消息类型是不同的 json 对象
29+
- `content` 内部为具体的 json 对象，不同的消息类型是不同的 json 对象
3030

31-
#### **文本消息**
31+
#### **文本消息** 📜
3232

3333
```json
3434
{
@@ -44,7 +44,7 @@ toc_max_heading_level: 4
4444
| :-----: | :--: | :----: | :----------------- |
4545
| content | 是 | string | 文本消息的具体内容 |
4646

47-
#### **名片消息**
47+
#### **名片消息** 🏷️
4848

4949
```json
5050
{
@@ -60,13 +60,13 @@ toc_max_heading_level: 4
6060
```
6161

6262
| 参数名 | 必选 | 类型 | 说明 |
63-
| :------: | :----: | :--: | :------- | --- |
64-
| userID | string | 是 | 用户 ID | |
65-
| nickname | string | 是 | 用户名 | |
66-
| faceURL | int | 是 | 用户头像 |
67-
| ex | string | 否 | 扩展字段 |
63+
| :------: | :----: | :--: | :------- |
64+
| userID | 是 | string | 用户 ID |
65+
| nickname | 是 | string | 用户名 |
66+
| faceURL | 是 | string | 用户头像 |
67+
| ex | 否 | string | 扩展字段 |
6868

69-
#### **图片消息**
69+
#### **图片消息** 📷
7070

7171
```json
7272
{
@@ -104,18 +104,18 @@ toc_max_heading_level: 4
104104

105105
| 参数名 | 必选 | 类型 | 说明 |
106106
| :-------------: | :----: | :--: | :--------------- |
107-
| sourcePath | string | 否 | 图片文件本地路径 |
108-
| sourcePicture | object | 是 | 原图信息 |
109-
| bigPicture | object | 是 | 大图信息 |
110-
| snapshotPicture | object | 是 | 缩略图信息 |
111-
| uuid | string | 否 | 图片文件唯一 ID |
112-
| type | string | 是 | 图片文件类型 |
113-
| size | int | 否 | 图片文件大小 |
114-
| width | int | 是 | 图片宽度 |
115-
| height | int | 是 | 图片高度 |
116-
| url | string | 是 | 图片下载地址 |
117-
118-
#### **语音消息**
107+
| sourcePath | 否 | string | 图片文件本地路径 |
108+
| sourcePicture | 是 | object | 原图信息 |
109+
| bigPicture | 是 | object | 大图信息 |
110+
| snapshotPicture | 是 | object | 缩略图信息 |
111+
| uuid | 否 | string | 图片文件唯一 ID |
112+
| type | 是 | string | 图片文件类型 |
113+
| size | 否 | int | 图片文件大小 |
114+
| width | 是 | int | 图片宽度 |
115+
| height | 是 | int | 图片高度 |
116+
| url | 是 | string | 图片下载地址 |
117+
118+
#### **语音消息** 🎤
119119

120120
```json
121121
{
@@ -134,14 +134,14 @@ toc_max_heading_level: 4
134134

135135
| 参数名 | 必选 | 类型 | 说明 |
136136
| :-------: | :----: | :--: | :----------------- |
137-
| uuid | string | 否 | 语音文件唯一 ID |
138-
| soundPath | string | 否 | 语音文件的本地路径 |
139-
| sourceUrl | string | 是 | 语音文件下载地址 |
140-
| dataSize | int | 否 | 语音文件大小 |
141-
| duration | int | 是 | 语音时长 |
142-
| soundType | string | 否 | 语音文件类型 |
137+
| uuid | 否 | string | 语音文件唯一 ID |
138+
| soundPath | 否 | string | 语音文件的本地路径 |
139+
| sourceUrl | 是 | string | 语音文件下载地址 |
140+
| dataSize | 否 | int | 语音文件大小 |
141+
| duration | 是 | int | 语音时长 |
142+
| soundType | 否 | string | 语音文件类型 |
143143

144-
#### **视频消息**
144+
#### **视频消息** 📹
145145

146146
```json
147147
{
@@ -166,20 +166,20 @@ toc_max_heading_level: 4
166166

167167
| 参数名 | 必选 | 类型 | 说明 |
168168
| :------------: | :----: | :--: | :--------------------- |
169-
| videoPath | string | 否 | 视频文件本地路径 |
170-
| videoUUID | string | 否 | 视频文件唯一 ID |
171-
| videoUrl | string | 否 | 视频文件下载地址 |
172-
| videoType | string | 是 | 视频文件类型 |
173-
| videoSize | int | 是 | 视频文件大小 |
174-
| duration | int | 是 | 视频时长 |
175-
| snapshotPath | string | 否 | 视频封面图文件本地路径 |
176-
| snapshotUUID | string | 否 | 视频封面图唯一 ID |
177-
| snapshotSize | int | 否 | 视频封面图文件大小 |
178-
| snapshotUrl | string | 是 | 视频封面图文件下载地址 |
179-
| snapshotWidth | int | 是 | 视频封面图宽度 |
180-
| snapshotHeight | int | 是 | 视频封面图高度 |
181-
182-
#### **文件消息**
169+
| videoPath | 否 | string | 视频文件本地路径 |
170+
| videoUUID | 否 | string | 视频文件唯一 ID |
171+
| videoUrl | 是 | string | 视频文件下载地址 |
172+
| videoType | 是 | string | 视频文件类型 |
173+
| videoSize | 是 | int | 视频文件大小 |
174+
| duration | 是 | int | 视频时长 |
175+
| snapshotPath | 否 | string | 视频封面图文件本地路径 |
176+
| snapshotUUID | 否 | string | 视频封面图唯一 ID |
177+
| snapshotSize | 否 | int | 视频封面图文件大小 |
178+
| snapshotUrl | 是 | string | 视频封面图文件下载地址 |
179+
| snapshotWidth | 是 | int | 视频封面图宽度 |
180+
| snapshotHeight | 是 | int | 视频封面图高度 |
181+
182+
#### **文件消息** 📁
183183

184184
```json
185185
{
@@ -198,14 +198,14 @@ toc_max_heading_level: 4
198198

199199
| 参数名 | 必选 | 类型 | 说明 |
200200
| :-------: | :----: | :--: | :----------- |
201-
| filePath | string | 否 | 文件本地路径 |
202-
| uuid | string | 否 | 文件唯一 ID |
203-
| sourceUrl | string | 是 | 文件下载地址 |
204-
| fileName | string | 是 | 文件名称 |
205-
| fileSize | int | 是 | 文件大小 |
206-
| fileType | string | 否 | 文件类型 |
201+
| filePath | 否 | string | 文件本地路径 |
202+
| uuid | 否 | string | 文件唯一 ID |
203+
| sourceUrl | 是 | string | 文件下载地址 |
204+
| fileName | 是 | string | 文件名称 |
205+
| fileSize | 是 | int | 文件大小 |
206+
| fileType | 否 | string | 文件类型 |
207207

208-
#### **表情消息**
208+
#### **表情消息** 😄
209209

210210
```json
211211
{
@@ -220,10 +220,10 @@ toc_max_heading_level: 4
220220

221221
| 参数名 | 必选 | 类型 | 说明 |
222222
| :----: | :----: | :--: | :------------------- |
223-
| index | int | 是 | 表情索引 |
224-
| data | string | 否 | 表情自定义 json 数据 |
223+
| index | 是 | int | 表情索引 |
224+
| data | 否 | string | 表情自定义 json 数据 |
225225

226-
#### **位置消息**
226+
#### **位置消息** 📍
227227

228228
```json
229229
{
@@ -237,13 +237,13 @@ toc_max_heading_level: 4
237237
}
238238
```
239239

240-
| 参数名 | 必选 | 类型 | 说明 |
241-
| :---------: | :----: | :--: | :------- |
242-
| description | string | 否 | 位置描述 |
243-
| longitude | double | 是 | 定位经度 |
244-
| latitude | double | 是 | 定位纬度 |
240+
| 参数名 | 必选 | 类型 | 说明 |
241+
| :---------: | :--: | :---------: | :------- |
242+
| description | 否 | string | 位置描述 |
243+
| longitude | 是 | double | 定位经度 |
244+
| latitude | 是 | double | 定位纬度 |
245245

246-
#### **@消息**
246+
#### **@消息** 📢
247247

248248
```json
249249
{
@@ -259,31 +259,13 @@ toc_max_heading_level: 4
259259

260260
| 参数名 | 必选 | 类型 | 说明 |
261261
| :---------: | :--: | :---------: | :---------------------------------------------------- |
262-
| text | 否 | json string | 消息 |
263-
| atUserList | 是 | json string[] | @的用户列表 |
264-
| isAtSelf | 否 | json string | 是否@自己 |
262+
| text | 否 | string | 消息文本内容 |
263+
| atUserList | 是 | array | @的用户列表 |
264+
| isAtSelf | 否 | boolean | 是否@自己 |
265265

266-
267-
#### **位置消息**
268-
```json
269-
{
270-
...,
271-
"content": {
272-
"description": "",
273-
"longitude": 1.1,
274-
"latitude": 1.1
275-
},
276-
....
277-
}
278-
```
279-
280-
| 参数名 | 必选 | 类型 | 说明 |
281-
| :---------: | :--: | :---------: | :---------------------------------------------------- |
282-
| description | 否 | json string | 扩展的描述信息为 json 对象转换后的 string |
283-
| longitude | 是 | json number |经度 |
284-
| latitude | 是 | json number | 纬度 |
266+
#### **
285267

286-
#### **自定义消息**
268+
自定义消息** 🖌️
287269

288270
```json
289271
{
@@ -299,13 +281,13 @@ toc_max_heading_level: 4
299281

300282
| 参数名 | 必选 | 类型 | 说明 |
301283
| :---------: | :--: | :---------: | :---------------------------------------------------- |
302-
| data | 是 | json string | 用户自定义的消息为 json 对象转换后的 string |
303-
| description | 否 | json string | 扩展的描述信息为 json 对象转换后的 string，可以不使用 |
304-
| extension | 否 | json string | 扩展字段，暂时不使用 |
284+
| data | 是 | string | 用户自定义的消息内容 |
285+
| description | 否 | string | 扩展的描述信息 |
286+
| extension | 否 | string | 扩展字段 |
305287

306-
#### **系统通知消息**
288+
#### **系统通知消息** 📢
307289

308-
> 系统通知消息作为一种特别的自定义通知消息，客户端会产生一个独立的会话，固定的会话类型为 4，其中发送者 ID 必须为为后台 config 文件中配置的管理员 ID 中一个。
290+
> 系统通知消息作为一种特别的自定义通知消息，客户端会产生一个独立的会话，固定的会话类型为 4，其中发送者 ID 为通知号userID。
309291
310292
```json
311293
{
@@ -380,17 +362,17 @@ toc_max_heading_level: 4
380362

381363
| 参数名 | 必选 | 类型 | 说明 |
382364
| :-----------------: | :----: | :--: | :------------------------------------------------------------------------------------------------------------------------------------------------ |
383-
| notificationName | string | 是 | 通知标题 |
384-
| notificationFaceURL | string | 否 | 通知头像 |
385-
| notificationType | int | 是 | 通知类型，如：1 代表入职通知，2 代表离职通知... |
386-
| text | string | 是 | 通知正文 e |
387-
| externalUrl | string | 否 | 通知点击后需要跳转到的地址链接(不填则无需跳转) |
388-
| mixType | int | 是 | 通知混合类型<br/>0：纯文字通知<br/>1：文字+图片通知<br/>2：文字+视频通知<br/>3：文字+文件通知<br/>4: 文字+语音通知<br/>5: 文字+语音+图片通知<br/> |
389-
| pictureElem | object | 否 | 图片元素对象 |
390-
| sourcePicture | object | 否 | 原图 |
391-
| bigPicture | object | 否 | 大图 |
392-
| snapshotPicture | object | 否 | 缩略图 |
393-
| soundElem | object | 否 | 声音元素 |
394-
| videoElem | object | 否 | 视频元素 |
395-
| fileElem | object | 否 | 文件元素 |
396-
| ex | string | 否 | 扩展字段 |
365+
| notificationName | 是 | string | 通知标题 |
366+
| notificationFaceURL | 否 | string | 通知头像 |
367+
| notificationType | 是 | int | 通知类型，如：1 代表入职通知，2 代表离职通知... |
368+
| text | 是 | string | 通知正文 |
369+
| externalUrl | 否 | string | 通知点击后需要跳转到的地址链接(不填则无需跳转) |
370+
| mixType | 是 | int | 通知混合类型<br/>0：纯文字通知<br/>1：文字+图片通知<br/>2：文字+视频通知<br/>3：文字+文件通知<br/>4: 文字+语音通知<br/>5: 文字+语音+图片通知<br/> |
371+
| pictureElem | 否 | object | 图片元素对象 |
372+
| sourcePicture | 否 | object | 原图 |
373+
| bigPicture | 否 | object | 大图 |
374+
| snapshotPicture | 否 | object | 缩略图 |
375+
| soundElem | 否 | object | 声音元素 |
376+
| videoElem | 否 | object | 视频元素 |
377+
| fileElem | 否 | object | 文件元素 |
378+
| ex | 否 | string | 扩展字段 |

0 commit comments

Comments
 (0)