Skip to content

Commit d6f9d9b

Browse files
authored
fix: doc (#188)
1 parent 580f8f7 commit d6f9d9b

8 files changed

Lines changed: 22 additions & 23 deletions

File tree

docs/restapi/apis/groupManagement/getGroupApplicationListByUserID.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
sidebar_position: 14
3-
title: 获取指定用户的入群申请
3+
title: 通过用户ID获取指定群的入群申请
44
hide_title: true
55
---
66

77
<center>
88

9-
## 获取指定用户的入群申请
9+
## 通过用户ID获取指定群的入群申请
1010

1111
</center>
1212

@@ -60,8 +60,8 @@ hide_title: true
6060
},
6161
"groupInfo": {
6262
"groupID": "3666081223",
63-
"groupName": "大群1",
64-
"notification": "v公告1",
63+
"groupName": "group1",
64+
"notification": "notification1",
6565
"introduction": "",
6666
"faceURL": "",
6767
"ownerUserID": "1054527962",
@@ -78,7 +78,7 @@ hide_title: true
7878
"notificationUserID": ""
7979
},
8080
"handleResult": 1,
81-
"reqMsg": "鹅鹅鹅",
81+
"reqMsg": "hello",
8282
"handleMsg": "reason",
8383
"reqTime": 1687747407352,
8484
"handleUserID": "",

docs/restapi/apis/groupManagement/kickGroup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ hide_title: true
1111
</center>
1212

1313
### 简要描述
14-
- 将用户从群组中移除。
14+
- 将用户从群组中移除。不能移除群主,如果移除群主,先转让群主身份。
1515
### 请求方式
1616
- `post`
1717
### 请求URL

docs/restapi/apis/groupManagement/setGroupInfo.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ hide_title: true
1111

1212
### 简要描述
1313

14-
- 修改群组信息。
14+
- 修改群组信息。仅传需要修改的字段,也支持零值。
1515

1616
### 请求方式
1717

docs/restapi/apis/messageManagement/batchSendMessage.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ hide_title: true
3434
"9371245179"
3535
],
3636
"sendID": "3473643418",
37-
"senderNickname": "杜平",
37+
"senderNickname": "Alice",
3838
"senderFaceURL": "http://nvpydodr.ae/ylyqu",
3939
"senderPlatformID": 2,
4040
"content": {
@@ -62,14 +62,14 @@ hide_title: true
6262
|sendID|必填|string|发送者ID(可以为管理员ID,可以为用户ID)|
6363
|senderNickname|选填|string|发送者昵称|
6464
|senderFaceURL|选填|string|发送者头像|
65-
|senderPlatformID|选填|int|发送者平台号,模拟用户发送时填写, 1-&gt;IOS,2-&gt;Android,3-&gt;Windows,4-&gt;OSX,5-&gt;Web,5-&gt;MiniWeb,7-&gt;Linux,8-&gt;AndroidPad,9-&gt;IPad|
66-
|content|必填|object|消息的具体内容,内部是json 对象,其他消息的详细字段请参考消息类型格式描述文档|
67-
|contentType|必填|int|消息类型,101表示文本,102表示图片..详细参考消息类型格式描述文档|
68-
|sessionType|必填|int|会话类型,发送的消息是单聊还是群聊,单聊为1,群聊(普通写扩散)为2,大群(读扩散接口)为3,通知会话为4|
65+
|senderPlatformID|选填|int|消息发送者的[终端类型](docs/restapi/commonFields.mdx/#通用字段说明),模拟用户发送时填写|
66+
|content|必填|object|消息的具体内容,内部是json 对象,其他消息的详细字段请参考[消息类型格式描述文档](docs/restapi/contentDescription.mdx/#content-具体内容-)|
67+
|contentType|必填|int|[消息类型](docs/restapi/contentDescription.mdx)|
68+
|sessionType|必填|int|[会话类型](docs/restapi/commonFields.mdx/#通用字段说明)|
6969
|isOnlineOnly|选填|boolean|该字段设置为true时候,发送的消息服务器不会存储,接收者在线才会收到,不在线该消息丢失|
7070
|notOfflinePush|选填|string|该字段设置为true时候,发送的消息在用户离线时将不会进行离线推送|
7171
|sendTime|选填|int|发送消息时间戳,单位毫秒|
72-
|offlinePushInfo|选填|object|离线推送的具体内容,如果不填写,使用服务器默认推送标题|
72+
|offlinePushInfo|选填|object|离线推送的具体内容,如果不填写,使用服务器默认推送标题。notOfflinePush为true时该字段不会使用。|
7373
|offlinePushInfo.title|选填|string|推送的标题|
7474
|offlinePushInfo.desc|选填|string|推送的具体描述|
7575
|offlinePushInfo.ex|选填|string|扩展字段|

docs/restapi/apis/messageManagement/sendMessage.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,20 +56,20 @@ hide_title: true
5656
```
5757
|字段名|选填|类型|说明|
5858
|:---- |:------- |:--- |---|
59-
|sendID|必填|string|发送者ID(APP管理员ID或用户ID)|
59+
|sendID|必填|string|系统通知号ID,或用户ID|
6060
|recvID|选填|string|接收者ID,sessionType1或者4时必填,如果是群聊则不填|
61-
|groupID|选填|string|群ID,sessionType2或者3时必填,如果为单聊则不填|
61+
|groupID|选填|string|群ID,sessionType3时必填,如果为单聊则不填|
6262
|senderNickname|选填|string|消息发送者昵称|
6363
|senderFaceURL|选填|string|消息发送者头像|
64-
|senderPlatformID|选填|int|消息发送者的终端类型,模拟用户发送时填写,取值为1-9|
65-
|content|必填|object|消息的具体内容,内部是json 对象,其他消息的详细字段请参考[消息类型格式描述](docs/restapi/contentDescription.mdx)文档|
64+
|senderPlatformID|选填|int|消息发送者的[终端类型](docs/restapi/commonFields.mdx/#通用字段说明),模拟用户发送时填写,取值为1-9|
65+
|content|必填|object|消息的具体内容,内部是json 对象,其他消息的详细字段请参考[消息类型格式描述文档](docs/restapi/contentDescription.mdx/#content-具体内容-)|
6666
|content.content|必填|string|消息内容|
6767
|contentType|必填|int|[消息类型](docs/restapi/contentDescription.mdx)|
68-
|sessionType|必填|int|会话类型,1:单聊,3:群聊,4:系统通知|
68+
|sessionType|必填|int|[会话类型](docs/restapi/commonFields.mdx/#通用字段说明)|
6969
|isOnlineOnly|选填|boolean|接收者在线才能收到,否则将会丢失|
7070
|notOfflinePush|选填|boolean|不进行离线推送|
7171
|sendTime|选填|int|消息发送时间,仅导入消息时填写,单位毫秒|
72-
|offlinePushInfo|选填|object|离线推送的具体内容,如果不填写,使用服务器默认推送标题|
72+
|offlinePushInfo|选填|object|离线推送的具体内容,如果不填写,使用服务器默认推送标题。notOfflinePush为true时该字段不会使用。|
7373
|offlinePushInfo.title|选填|string|推送的标题|
7474
|offlinePushInfo.desc|选填|string|推送的具体描述|
7575
|offlinePushInfo.ex|选填|string|扩展字段|

docs/restapi/commonFields.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ title: 常用结构体说明
1616
| operationID | string | | 操作 ID,用于定位问题,保持唯一,建议用当前时间、随机数和 userID | 字符串 |
1717
| operatorUserID | string | 64 | 操作者,具体含义视上下文而定 | 字符串 |
1818
| groupID | string | 64 | 群 ID ,保证 IM 内唯一 | 字符串 |
19+
| sessionType | int | | 会话类型 | 1:单聊,3:群聊,4:系统通知 |
1920

2021
## PublicUserInfo
2122

docs/restapi/contentDescription.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,10 +293,10 @@ toc_max_heading_level: 4
293293
{
294294
...,
295295
"content": {
296-
"notificationName": "公文管理",
296+
"notificationName": "notification",
297297
"notificationFaceURL": "http://www.head1.com",
298298
"notificationType": 1,
299-
"text": "大家好,今天是...",
299+
"text": "hello!",
300300
"externalUrl":"",
301301
"mixType": 0,
302302
"pictureElem": {

docs/restapi/webhooks/example.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,6 @@ func (m *ChatApi) CallbackExample(c *gin.Context) {
8484
}
8585
```
8686

87-
详细代码参考 [链接](https://github.com/openimsdk/chat/blob/main/example/callback/callback.go)
88-
8987
## 4. 效果展示
9088

9189
![PC Web Interface](./assets/result.png)

0 commit comments

Comments
 (0)