Skip to content

Commit 7cdc979

Browse files
lgz5689lgz5689
committed
Merge branch 'main' of github.com:openimsdk/docs
2 parents 483f13e + 866dd2c commit 7cdc979

File tree

4 files changed

+84
-82
lines changed

4 files changed

+84
-82
lines changed

‎docs/restapi/apis/conversationManagement/getConversationList.mdx‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ hide_title: true
2121
### Header
2222
|header名|示例值|选填|类型|说明|
2323
|:---- |:------- |:--- |---|------ |
24-
|token|{{token}}|是|string|管理员token|
25-
|operationID|1646445464564|是|string|operationID用于全局链路追踪|
24+
|token|eyJhbxxxx3Xs|必填|string|管理员token|
25+
|operationID|1646445464564|必填|string|operationID用于全局链路追踪|
2626

2727

2828
### 请求参数示例
@@ -35,10 +35,10 @@ hide_title: true
3535
}
3636

3737
```
38-
|字段名|选填|类型|说明|
39-
|:---- |:------- |:--- |---|
40-
|userID|是|string|当前用户ID|
41-
|conversationIDs|否|string|会话ID列表|
38+
| 字段名 | 选填 | 类型 | 说明 |
39+
|:----------------|:----|:-------|--------|
40+
| userID | 必填 | string | 当前用户ID |
41+
| conversationIDs | 选填 | string | 会话ID列表 |
4242

4343
### 成功返回示例
4444
```json
@@ -128,33 +128,33 @@ hide_title: true
128128
### 成功返回示例的参数说明
129129

130130

131-
| 字段名 | 选填 | 类型 | 说明 |
132-
|:------------------|:---------|:-------------------------------------------------------|----------------------------------------------------------------------------------|
133-
| errCode | int | 错误码,0表示成功 |
134-
| errMsg | string | 错误简要信息,无错误时为空 |
135-
| errDlt | errDlt | 错误详细信息,无错误时为空 |
136-
| data | object | 通用数据对象，具体结构见下方 |
137-
| conversationElems | array | 无 |
138-
| conversationID | string | 会话ID |
139-
| recvMsgOpt | string | 群聊消息免打扰 |
140-
| unreadCount | string | 未读消息数 |
141-
| msgInfo | object | 消息内容 |
142-
| serverMsgID | string | 服务器消息ID |
143-
| clientMsgID | string | 客户端消息ID |
144-
| sessionType | string | 会话类型，发送的消息是单聊还是群聊,单聊为1，群聊（普通写扩散）为2,大群(读扩散接口)为3，通知会话为4 |
145-
| recvID | string | 接收者ID |
146-
| SendID | string | 发送者ID |
147-
| faceURL | string | 头像URL。在单聊中，当发送者为当前用户时，该字段为好友头像URL |
148-
| senderName | string | 发送者呢称。在单聊中，当发送者为当前用户时，该字段为好友呢称。在群聊中，该字段为对应的发送者呢称 |
149-
| LatestMsgRecvTime | string | 最后一条消息的接收时间 |
150-
| msgFrom | string | 消息来源，100来源于用户发送，200来源于管理员发送或者系统广播通知等 |
151-
| content | 必填 | object | 消息的具体内容，内部是json 对象，其他消息的详细字段请参考[消息类型格式描述](docs/restapi/contentDescription.mdx)文档 |
152-
| contentType | 必填 | int | [消息类型](docs/restapi/contentDescription.mdx) |
153-
| groupID | string | 群聊ID |
154-
| groupName | string | 群聊名称 |
155-
| groupFaceURL | string | 群聊头像URL |
156-
| groupMemberCount | string | 群聊人数 |
157-
| IsPinned | string | 会话是否置顶 |
131+
| 字段名 | 类型 | 说明 |
132+
|:------------------|:---------|----------------------------------------------------------------------------------|
133+
| errCode | int | 错误码,0表示成功 |
134+
| errMsg | string | 错误简要信息,无错误时为空 |
135+
| errDlt | errDlt | 错误详细信息,无错误时为空 |
136+
| data | object | 通用数据对象，具体结构见下方 |
137+
| conversationElems | array | 无 |
138+
| conversationID | string | 会话ID |
139+
| recvMsgOpt | string | 群聊消息免打扰 |
140+
| unreadCount | string | 未读消息数 |
141+
| msgInfo | object | 消息内容 |
142+
| serverMsgID | string | 服务器消息ID |
143+
| clientMsgID | string | 客户端消息ID |
144+
| sessionType | string | 会话类型，发送的消息是单聊还是群聊,单聊为1，群聊（普通写扩散）为2,大群(读扩散接口)为3，通知会话为4 |
145+
| recvID | string | 接收者ID |
146+
| SendID | string | 发送者ID |
147+
| faceURL | string | 头像URL。在单聊中，当发送者为当前用户时，该字段为好友头像URL |
148+
| senderName | string | 发送者呢称。在单聊中，当发送者为当前用户时，该字段为好友呢称。在群聊中，该字段为对应的发送者呢称 |
149+
| LatestMsgRecvTime | string | 最后一条消息的接收时间 |
150+
| msgFrom | string | 消息来源，100来源于用户发送，200来源于管理员发送或者系统广播通知等 |
151+
| content | object | 消息的具体内容，内部是json 对象，其他消息的详细字段请参考[消息类型格式描述](docs/restapi/contentDescription.mdx)文档 |
152+
| contentType | int | [消息类型](docs/restapi/contentDescription.mdx) |
153+
| groupID | string | 群聊ID |
154+
| groupName | string | 群聊名称 |
155+
| groupFaceURL | string | 群聊头像URL |
156+
| groupMemberCount | string | 群聊人数 |
157+
| IsPinned | string | 会话是否置顶 |
158158

159159

160160
### 失败返回示例

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ hide_title: true
4040
```
4141
|字段名|选填|类型|说明|
4242
|:---- |:------- |:--- |---|
43-
|userID|必填|string|系统通知号ID|
44-
|nickName|必填|string|系统通知号名称|
43+
|userID|选填|string|系统通知号ID|
44+
|nickName|选填|string|系统通知号名称|
4545
|pagination|必填|object|分页参数结构体|
4646
|pagination.pageNumber|必填|int|当前页码，从1开始|
4747
|pagination.showNumber|必填|int|当前页请求数量|

‎i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getConversationList.mdx‎

Lines changed: 47 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
1-
21
---
3-
sidebar_position: 8
4-
title: Getting a Sorted List of Sessions
2+
sidebar_position: 15
3+
title: get_conversationList
54
hide_title: true
65
---
76

87
<center>
9-
## Getting a Sorted List of Sessions
8+
9+
## get_conversationList
10+
1011
</center>
1112

1213
### Brief Description
13-
- Obtain a sorted list of conversations based on whether they are pinned and the time messages were sent
14+
- Retrieve a sorted list of conversations based on whether they are pinned and the order of message sending time.
1415

1516
### Request Method
1617
- `post`
18+
1719
### Request URL
1820
- `http://x.x.x.x:10002/conversation/get_conversations_list`
1921

2022
### Header
21-
| Header Name | Example Value | Optional | Type | Description |
22-
|:------------|:--------------|:---------|:--------|:--------------------|
23-
| token | {{token}} | Yes | string | Admin token |
24-
| operationID | 1646445464564 | Yes | string | Used for global traceability |
23+
| Header Name | Example Value | Optional | Type | Description |
24+
|:------------|:--------------|:---------|:-------|:------------------|
25+
| token | eyJhbxxxx3Xs | Required | string | Administrator token |
26+
| operationID | 1646445464564 | Required | string | operationID for global link tracking |
2527

2628
### Request Parameters Example
2729

@@ -32,10 +34,10 @@ hide_title: true
3234
}
3335
```
3436

35-
| Field Name | Optional | Type | Description |
36-
|:----------------|:---------|:-------|:--------------|
37-
| userID | Yes | string | Current user ID|
38-
| conversationIDs | No | string | List of conversation IDs |
37+
| Field Name | Optional | Type | Description |
38+
|:-----------------|:---------|:-------|:--------------|
39+
| userID | Required | string | Current user ID |
40+
| conversationIDs | Optional | string | List of conversation IDs |
3941

4042
### Successful Return Example
4143

@@ -125,33 +127,33 @@ hide_title: true
125127

126128
### Successful Return Parameters Explanation
127129

128-
| Field Name | Optional | Type | Description |
129-
|:------------------|:---------|:-------|:------------|
130-
| errCode | No | int | Error code, 0 indicates success |
131-
| errMsg | No | string | Brief error message, empty if no error |
132-
| errDlt | No | string | Detailed error message,empty if no error |
133-
| data | No | object | General data object, see structure below |
134-
| conversationElems | No | array | - |
135-
| conversationID | No | string | Conversation ID |
136-
| recvMsgOpt | No | string | Group chat message do not disturb |
137-
| unreadCount | No | string | Unread message count |
138-
| msgInfo | No | object | Message content |
139-
| serverMsgID | No | string | Server message ID |
140-
| clientMsgID | No | string | Client message ID |
141-
| sessionType | No | string | Session type, 1 for individual chat, 2 for group chat (normal spread), 3 for large group (spread through reading interface), 4 for notification session |
142-
| recvID | No | string | Receiver ID |
143-
| SendID | No | string | Sender ID |
144-
| faceURL | No | string | Avatar URL. In individual chat, when the sender is the current user, this field is the friend's avatar URL |
145-
| senderName | No | string | Sender's nickname. In individual chat, when the sender is the current user, this field is the friend's nickname. In group chat, this field is the corresponding sender's nickname |
146-
| LatestMsgRecvTime | No | string | Last message's receive time |
147-
| msgFrom | No | string | Message origin, 100 from user sent, 200 from admin sent or system broadcast notifications etc. |
148-
| content | Yes | object | Detailed content of the message, internal is a json object, for other message details refer to [Message Type Format Description](/restapi/contentDescription) document |
149-
| contentType | Yes | int | [Message Type](/restapi/contentDescription) |
150-
| groupID | No | string | Group chat ID |
151-
| groupName | No | string | Group chat name |
152-
| groupFaceURL | No | string | Group chat avatar URL |
153-
| groupMemberCount | No | string | Group chat member count |
154-
| IsPinned | No | string | Whether the conversation is pinned |
130+
| Field Name | Type | Description |
131+
|:--------------------|:-------|:----------------------------------------------------------------------------------------------|
132+
| errCode | int | Error code, 0 means success |
133+
| errMsg | string | Brief error message, empty if no error |
134+
| errDlt | string | Detailed error message, empty if no error |
135+
| data| object | Common data object, see below for specific structure |
136+
| conversationElems | array | - |
137+
| conversationID | string | Conversation ID |
138+
| recvMsgOpt | int | Group chat message do not disturb |
139+
| unreadCount | int | Number of unread messages |
140+
| msgInfo | object | Message content |
141+
| serverMsgID | string | Server message ID |
142+
| clientMsgID | string | Client message ID |
143+
| sessionType | int | Session type, 1 for individual chat, 2 for group chat, 3 for large group, 4 for notification session |
144+
| recvID | string | Receiver ID |
145+
| sendID | string | Sender ID |
146+
| faceURL | string | Avatar URL. In individual chat, this field is the friend's avatar URL when the sender is the current user |
147+
| senderName | string | Sender's nickname. In individual chat, this field is the friend's nickname when the sender is the current user. In group chat, it is the corresponding sender's nickname |
148+
| LatestMsgRecvTime | long | Time of receiving the last message |
149+
| msgFrom | int | Message source, 100 from user, 200 from admin or system broadcast notification |
150+
| content | object | Detailed content of the message, internal is a json object, for other message details refer to [Message Type Format Description](/restapi/contentDescription) document |
151+
| contentType | int | [Message Type](/restapi/contentDescription) |
152+
| groupID | string | Group chat ID |
153+
| groupName | string | Group chat name |
154+
| groupFaceURL | string | Group chat avatar URL |
155+
| groupMemberCount | int | Number of group chat members |
156+
| IsPinned | bool | Whether the conversation is pinned |
155157

156158
### Failure Return Example
157159

@@ -165,8 +167,8 @@ hide_title: true
165167

166168
### Failure Return Parameters Explanation
167169

168-
| Parameter | Type | Description |
169-
|:----------|:-------|:-------------------------------------|
170-
| errCode | int | Error code, see global error code document for details |
171-
| errMsg | string | Brief error message |
172-
| errDlt | string | Detailed error message |
170+
| Parameter Name | Type | Description |
171+
|:---------------|:-------|:--------------------------------|
172+
| errCode | int | Error code, refer to global error code document for specifics |
173+
| errMsg | string | Brief error message |
174+
| errDlt | string | Detailed error message |

‎i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/userManagement/searchNotificationAccount.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ hide_title: true
4040
```
4141
|Field Name|Optional|Type|Description|
4242
|:---- |:------- |:--- |---|
43-
|userID|Required|string|System notification account ID|
44-
|nickName|Required|string|System notification account name|
43+
|userID|Option|string|System notification account ID|
44+
|nickName|Option|string|System notification account name|
4545
|pagination|Required|object|Structure for pagination parameters|
4646
|pagination.pageNumber|Required|int|Current page number, starting from 1|
4747
|pagination.showNumber|Required|int|Number of requests per page|

0 commit comments

Comments
 (0)