Skip to content

Commit 2f8eef2

Browse files
icey-yuicey-yu
committed
fix: comma and title
1 parent 077a1b0 commit 2f8eef2

8 files changed

Lines changed: 18 additions & 18 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
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 | 平台 ID， 1：IOS，2：Android，3：Windows，4：OSX，5：Web，6：MiniWeb，7：Linux，8：Android Pad，9：IPad，10：admin |
4444
| userID | 必填 | string | 用户 ID |
4545

4646
### 成功返回示例

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ hide_title: true
4343
| 字段名 | 选填 | 类型 | 说明 |
4444
| :--------- | :--- | :----- | ----------------------------------------------------------------------------------------------------------------- |
4545
| 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 |
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 |
4747
| userID | 必填 | string | APP 管理员 ID，为`imAdmin` |
4848

4949
### 成功返回示例

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

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

4242
| 字段名 | 选填 | 类型 | 说明 |
4343
| :--------- | :--- | :----- | ----------------------------------------------------------------------------------------------------------------- |
44-
| 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 | 平台 ID， 1：IOS，2：Android，3：Windows，4：OSX，5：Web，6：MiniWeb，7：Linux，8：Android Pad，9：IPad，10：admin |
4545
| userID | 必填 | string | 用户 ID |
4646

4747
### 成功返回示例

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ hide_title: true
4444
| :----------- | :--- | :----- | --------------------------- |
4545
| fromUserID | 必填 | string | 添加者 |
4646
| toUserID | 必填 | string | 被添加者 |
47-
| handleResult | 必填 | int | 处理结果. 1: 同意；-1: 拒绝 |
47+
| handleResult | 必填 | int | 处理结果。 1：同意；-1：拒绝 |
4848
| handleMsg | 必填 | string | 处理信息 |
4949

5050
### 成功返回示例

‎docs/restapi/apis/messageManagement/batchSendMessage.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ hide_title: true
6565
|senderPlatformID|选填|int|发送者平台号，模拟用户发送时填写， 1->IOS,2->Android,3->Windows,4->OSX,5->Web,5->MiniWeb,7->Linux,8->AndroidPad,9->IPad|
6666
|content|必填|object|消息的具体内容，内部是json 对象，其他消息的详细字段请参考消息类型格式描述文档|
6767
|contentType|必填|int|消息类型，101表示文本，102表示图片..详细参考消息类型格式描述文档|
68-
|sessionType|必填|int|会话类型，发送的消息是单聊还是群聊,单聊为1，群聊（普通写扩散）为2,大群(读扩散接口)为3，通知会话为4|
68+
|sessionType|必填|int|会话类型，发送的消息是单聊还是群聊，单聊为1，群聊（普通写扩散）为2，大群(读扩散接口)为3，通知会话为4|
6969
|isOnlineOnly|选填|boolean|该字段设置为true时候，发送的消息服务器不会存储，接收者在线才会收到，不在线该消息丢失|
7070
|notOfflinePush|选填|string|该字段设置为true时候，发送的消息在用户离线时将不会进行离线推送|
7171
|sendTime|选填|int|发送消息时间戳，单位毫秒|

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ hide_title: true
8484
| userID | string | 用户 ID |
8585
| status | string | 在线状态，在线：online，离线：offline |
8686
| detailPlatformStatus | array | 详细的各个平台的在线情况 |
87-
| detailPlatformStatus.platform | string | 平台 ID, 1：IOS，2：Android，3：Windows，4：OSX，5：Web，6：MiniWeb，7：Linux，8：Android Pad，9：IPad，10：admin |
87+
| detailPlatformStatus.platform | string | 平台 ID， 1：IOS，2：Android，3：Windows，4：OSX，5：Web，6：MiniWeb，7：Linux，8：Android Pad，9：IPad，10：admin |
8888
| detailPlatformStatus.status | string | 在线状态，在线：online，离线：offline |
8989
| detailPlatformStatus.connID | string | 连接 ID |
9090
| detailPlatformStatus.isBackground | boolean | app 是否处于后台 |

‎docs/restapi/commonFields.mdx‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ title: 常用结构体说明
4040
| ex | string | | 扩展字段 | |
4141
| createTime | int | | 创建时间 | |
4242
| appMangerLevel | int | | 内部字段，可忽略 | |
43-
| globalRecvMsgOpt | int | | 全局是否接收离线推送 | 0：接收、2：不接收 |
43+
| globalRecvMsgOpt | int | | 全局是否接收离线推送 | 0：接收；2：不接收 |
4444

4545
## FriendInfo
4646

@@ -84,12 +84,12 @@ title: 常用结构体说明
8484
| createTime | int | | 创建时间 | |
8585
| memberCount | int | | 群成员数量 | |
8686
| ex | string | | 群扩展字段 | |
87-
| status | int | | 群状态 | 0：正常状态、1：被封禁（暂未用）、2：被解散、3：处于全体禁言状态 |
87+
| status | int | | 群状态 | 0：正常状态；1：被封禁（暂未用）；2：被解散；3：处于全体禁言状态 |
8888
| creatorUserID | string | | 群创建者 ID | |
8989
| groupType | int | | 群类型 | 固定为 2 |
90-
| needVerification | int | | 进群是否需要验证 | 0：申请加入群需要同意，成员邀请可直接进群、1：所有人进群需要验证，除了群主管理员邀请进群、2：直接进群 |
91-
| lookMemberInfo | int | | 是否能查看其他群成员信息 | 0：允许查看群成员信息、1：不允许查看群成员信息 |
92-
| applyMemberFriend | int | | 群成员是否能添加好友 | 0：允许从群成员处添加好友、1：不允许添加 |
90+
| needVerification | int | | 进群是否需要验证 | 0：申请加入群需要同意，成员邀请可直接进群；1：所有人进群需要验证，除了群主管理员邀请进群；2：直接进群 |
91+
| lookMemberInfo | int | | 是否能查看其他群成员信息 | 0：允许查看群成员信息；1：不允许查看群成员信息 |
92+
| applyMemberFriend | int | | 群成员是否能添加好友 | 0：允许从群成员处添加好友；1：不允许添加 |
9393
| notificationUpdateTime | int | | 群公告最后更新时间 | |
9494
| notificationUserID | string | | 群公告最后设置用户 ID | |
9595

@@ -101,12 +101,12 @@ title: 常用结构体说明
101101
| -------------- | ------ | ------------------ | ----------------- | ------------------------------------------------------ |
102102
| groupID | string | | 群 ID | |
103103
| userID | string | | 群成员 ID | |
104-
| roleLevel | int | | 群成员等级 | 100：群主、60：管理员、20：普通成员 |
104+
| roleLevel | int | | 群成员等级 | 100：群主；60：管理员；20：普通成员 |
105105
| joinTime | int | | 群成员加群时间 | |
106106
| nickname | string | | 群成员群昵称 | |
107107
| faceURL | string | | 群成员群头像 | |
108108
| appMangerLevel | int | | 内部字段，可忽略 | |
109-
| joinSource | int | | 加群来源 | 1：管理员邀请、2：群成员邀请、3：搜索加入、4：扫码加入 |
109+
| joinSource | int | | 加群来源 | 1：管理员邀请；2：群成员邀请；3：搜索加入；4：扫码加入 |
110110
| operatorUserID | string | | 操作加群的用户 ID | |
111111
| ex | string | | 群成员扩展字段 | |
112112
| muteEndTime | int | | 封禁结束时间 | |
@@ -124,7 +124,7 @@ title: 常用结构体说明
124124
| toUserID | string | | 接收申请者的用户 ID | |
125125
| toNickname | string | | 接收申请者的用户名 | |
126126
| toFaceURL | string | | 接收申请者的头像 | |
127-
| handleResult | int | | 好友申请处理状态 | 1：同意、0：未处理、-1：拒绝 |
127+
| handleResult | int | | 好友申请处理状态 | 1：同意；0：未处理；-1：拒绝 |
128128
| reqMsg | string | | 申请的信息 | |
129129
| createTime | int | | 创建时间 | |
130130
| handlerUserID | string | | 处理者的 ID | |
@@ -140,14 +140,14 @@ title: 常用结构体说明
140140
| ------------- | --------------------------------- | ------------------ | ------------------ | ------------------------------------------------------ |
141141
| userInfo | [PublicUserInfo](#publicuserinfo) | | 申请加群的用户信息 | |
142142
| groupInfo | [GroupInfo](#groupinfo) | | 群组信息 | |
143-
| handleResult | int | | 处理结果 | 1：同意、0：未处理、-1：拒绝 |
143+
| handleResult | int | | 处理结果 | 1：同意；0：未处理；-1：拒绝 |
144144
| reqMsg | string | | 申请加群的消息 | |
145145
| handleMsg | string | | 处理的信息 | |
146146
| reqTime | int | | 申请时间 | |
147147
| handleUserID | string | | 处理的用户 ID | |
148148
| handleTime | int | | 处理的时间 | |
149149
| ex | string | | 群申请扩展字段 | |
150-
| joinSource | int | | 加群来源 | 1：管理员邀请、2：群成员邀请、3：搜索加入、4：扫码加入 |
150+
| joinSource | int | | 加群来源 | 1：管理员邀请；2：群成员邀请；3：搜索加入；4：扫码加入 |
151151
| inviterUserID | string | | 被邀请者的 ID |
152152

153153
## PictureBaseInfo
@@ -170,7 +170,7 @@ title: 常用结构体说明
170170
| --------------------- | ------- | ------------------ | ------------------------------------------------------------------------- | -------- |
171171
| ownerUserID | string | | 会话的拥有者用户 ID |
172172
| conversationID | string | | 会话 ID |
173-
| recvMsgOpt | int | | 接收消息参数，0 为接收消息，1 为不接收消息，2 为接收消息但不提醒 |
173+
| recvMsgOpt | int | | 接收消息参数，0 为接收消息；1 为不接收消息；2 为接收消息但不提醒 |
174174
| conversationType | int | | 会话类型，1 为单聊，3 为群聊 |
175175
| userID | string | | 会话用户 ID，当会话类型为 1 时，此字段生效 |
176176
| groupID | string | | 会话的群 ID，当会话类型为 3 时，此字段生效 |

‎docs/restapi/contentDescription.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ toc_max_heading_level: 4
364364
| :-----------------: | :--: | :----: | :------------------------------------------------------------------------------------------------------------------------------------------------ |
365365
| notificationName | 是 | string | 通知标题 |
366366
| notificationFaceURL | 否 | string | 通知头像 |
367-
| notificationType | 是 | int | 通知类型，如：1 代表入职通知，2 代表离职通知... |
367+
| notificationType | 是 | int | 通知类型，如：1 代表入职通知；2 代表离职通知... |
368368
| text | 是 | string | 通知正文 |
369369
| externalUrl | 否 | string | 通知点击后需要跳转到的地址链接(不填则无需跳转) |
370370
| mixType | 是 | int | 通知混合类型<br/>0：纯文字通知<br/>1：文字+图片通知<br/>2：文字+视频通知<br/>3：文字+文件通知<br/>4: 文字+语音通知<br/>5: 文字+语音+图片通知<br/> |

0 commit comments

Comments
 (0)