From 50a6c69107ba2147ca22b6465c28f9c9668fafb8 Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Wed, 7 Aug 2024 12:14:45 +0800 Subject: [PATCH 01/12] feat: updat common fields. --- docs/restapi/commonFields.mdx | 109 +++++++++++------- .../current/commonFields.mdx | 31 +++-- 2 files changed, 85 insertions(+), 55 deletions(-) diff --git a/docs/restapi/commonFields.mdx b/docs/restapi/commonFields.mdx index 4a62f9a3e9..2c23e137d8 100644 --- a/docs/restapi/commonFields.mdx +++ b/docs/restapi/commonFields.mdx @@ -4,18 +4,18 @@ title: 常用结构体说明 --- ## 通用字段说明 -| 字段名 | 类型 | 字符串长度限制 | 说明 | 取值说明 | -|------------------|----------|--------------------|--------------------------------------------------------------|-----------------------------------------------------------------------------------------------| -| secret | string | 32 | OpenIM 秘钥，服务端config/share.yml 的 secret 字段 | 字符串 | -| platformID | int | | 用户登录时的终端类型 | iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6，linux 7, AndroidPad 8, IPad 9, Admin 10 | -| userID | string | 64 | 用户 ID，保证 IM 内唯一 | 字符串 | -| nickname | string | 255 | 昵称 | 字符串 | -| faceURL | string | 255 | 头像链接地址 | URL链接 | -| ex | string | 1024 | 扩展字段，可自行扩展，建议封装成 JSON 字符串 | 字符串/JSON | -| operationID | string | | 操作 ID，用于定位问题，保持唯一，建议用当前时间、随机数和userID | 字符串 | -| operatorUserID | string | 64 | 操作者，具体含义视上下文而定 | 字符串 | -| groupID | string | 64 | 群 ID ,保证 IM 内唯一 | 字符串 | +| 字段名 | 类型 | 字符串长度限制 | 说明 | 取值说明 | +| -------------- | ------ | -------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| secret | string | 32 | OpenIM 秘钥，服务端 config/share.yml 的 secret 字段 | 字符串 | +| platformID | int | | 用户登录时的终端类型 | iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6，linux 7, AndroidPad 8, IPad 9, Admin 10 | +| userID | string | 64 | 用户 ID，保证 IM 内唯一 | 字符串 | +| nickname | string | 255 | 昵称 | 字符串 | +| faceURL | string | 255 | 头像链接地址 | URL 链接 | +| ex | string | 1024 | 扩展字段，可自行扩展，建议封装成 JSON 字符串 | 字符串/JSON | +| operationID | string | | 操作 ID，用于定位问题，保持唯一，建议用当前时间、随机数和 userID | 字符串 | +| operatorUserID | string | 64 | 操作者，具体含义视上下文而定 | 字符串 | +| groupID | string | 64 | 群 ID ,保证 IM 内唯一 | 字符串 | ## PublicUserInfo @@ -23,30 +23,30 @@ title: 常用结构体说明 | 字段名 | 类型 | 最大字符串长度限制 | 说明 | | -------- | ------ | ------------------ | -------- | -| userID | string | 64 | 用户 ID | -| nickname | string | 255 | 用户名 | -| faceURL | string | 255 | 用户头像 | -| ex | string | 1024 | 扩展字段 | +| userID | string | 64 | 用户 ID | +| nickname | string | 255 | 用户名 | +| faceURL | string | 255 | 用户头像 | +| ex | string | 1024 | 扩展字段 | ## UserInfo > 用户信息对象 -| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | +| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | | ---------------- | ------ | ------------------ | -------------------- | ------------------ | | userID | string | | 用户 ID | | | nickname | string | | 用户名 | | | faceURL | string | | 用户头像 | | | ex | string | | 扩展字段 | | | createTime | int | | 创建时间 | | -| appMangerLevel | int | | 内部字段，可忽略 | | +| appMangerLevel | int | | 内部字段，可忽略 | | | globalRecvMsgOpt | int | | 全局是否接收离线推送 | 0：接收、2：不接收 | ## FriendInfo > 好友信息对象 -| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | +| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | | -------------- | --------------------- | ------------------ | ------------ | -------- | | ownerUserID | string | | 用户 ID | | | remark | string | | 备注 | | @@ -60,20 +60,20 @@ title: 常用结构体说明 > 黑名单信息对象 -| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | +| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | | -------------- | --------------------------------- | ------------------ | -------------- | -------- | | ownerUserID | string | | 用户 ID | | | createTime | int | | 拉黑时间 | | | blackUserInfo | [PublicUserInfo](#publicuserinfo) | | 被拉黑用户信息 | | | addSource | int | | 拉黑来源 | | | operatorUserID | string | | 操作者 ID | | -| ex | string | | 扩展字段 | | +| ex | string | | 扩展字段 | | ## GroupInfo > 群信息对象 -| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | +| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | | ---------------------- | ------ | ------------------ | ------------------------ | ----------------------------------------------------------------------------------------------------- | | groupID | string | | 群 ID | | | groupName | string | | 群名称 | | @@ -97,26 +97,26 @@ title: 常用结构体说明 > 群成员信息对象 -| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | -| -------------- | ------ | ------------------ | ---------------------- | ------------------------------------------------------ | -| groupID | string | | 群 ID | | -| userID | string | | 群成员 ID | | -| roleLevel | int | | 群成员等级 | 100：群主、60：管理员、20：普通成员 | -| joinTime | int | | 群成员加群时间 | | -| nickname | string | | 群成员群昵称 | | -| faceURL | string | | 群成员群头像 | | -| appMangerLevel | int | | 内部字段，可忽略 | | -| joinSource | int | | 加群来源 | 1：管理员邀请、2：群成员邀请、3：搜索加入、4：扫码加入 | -| operatorUserID | string | | 操作加群的用户 ID | | -| ex | string | | 群成员扩展字段 | | -| muteEndTime | int | | 封禁结束时间 | | -| inviterUserID | string | | 邀请进群的人的 ID | | +| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | +| -------------- | ------ | ------------------ | ----------------- | ------------------------------------------------------ | +| groupID | string | | 群 ID | | +| userID | string | | 群成员 ID | | +| roleLevel | int | | 群成员等级 | 100：群主、60：管理员、20：普通成员 | +| joinTime | int | | 群成员加群时间 | | +| nickname | string | | 群成员群昵称 | | +| faceURL | string | | 群成员群头像 | | +| appMangerLevel | int | | 内部字段，可忽略 | | +| joinSource | int | | 加群来源 | 1：管理员邀请、2：群成员邀请、3：搜索加入、4：扫码加入 | +| operatorUserID | string | | 操作加群的用户 ID | | +| ex | string | | 群成员扩展字段 | | +| muteEndTime | int | | 封禁结束时间 | | +| inviterUserID | string | | 邀请进群的人的 ID | | ## FriendRequestInfo > 好友申请对象 -| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | +| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | | ------------- | ------ | ------------------ | ------------------- | ---------------------------- | | fromUserID | string | | 发出申请者的用户 ID | | | fromNickname | string | | 发出申请者的用户名 | | @@ -136,7 +136,7 @@ title: 常用结构体说明 > 入群申请对象 -| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | +| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值说明 | | ------------- | --------------------------------- | ------------------ | ------------------ | ------------------------------------------------------ | | userInfo | [PublicUserInfo](#publicuserinfo) | | 申请加群的用户信息 | | | groupInfo | [GroupInfo](#groupinfo) | | 群组信息 | | @@ -154,10 +154,31 @@ title: 常用结构体说明 > 图片基本信息 -| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值范围 | -| ------------- | --------------------------------- | ------------------ | ------------------ | ------------------------------------------------------ | -| uuid| string | | 图片唯一uuid| -| type| string | | 图片类型 | -| size| int | | 图片大小 | -| width| int | | 图片宽度 | -| height| int | | 图片高度 | \ No newline at end of file +| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值范围 | +| ------ | ------ | ------------------ | ------------- | -------- | +| uuid | string | | 图片唯一 uuid | +| type | string | | 图片类型 | +| size | int | | 图片大小 | +| width | int | | 图片宽度 | +| height | int | | 图片高度 | + +## ConversationInfo + +> 会话信息 + +| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值范围 | +| ---------------- | ------- | ------------------ | ----------------------------------------------------------------- | -------- | +| ownerUserID | string | | 会话的拥有者用户 ID | +| conversationID | string | | 会话 ID | +| recvMsgOpt | int | | 接收消息参数，0 为接收消息，1 为不接收消息，2 为接收消息但不提醒 | +| conversationType | int | | 会话类型，1 为单聊，3 为群聊 | +| userID | string | | 会话用户 ID，当会话类型为 1 时，此字段生效 | +| groupID | string | | 会话的群 ID，当会话类型为 3 时，此字段生效 | +| isPinned | boolean | | 会话是否置顶 | +| attachedInfo | string | | openIM 使用的拓展字段 | +| isPrivateChat | boolean | | 是否开启阅后即焚 | +| groupAtType | int | | 群会话公告强提示类型，群公告有人**@ownerUserID** , **@全体** 的特殊标识符 | +| ex | string | | 用户使用的拓展字段 | +| burnDuration | int | | 阅后即焚消息持续时间 | +| minSeq | int | | 该用户在该会话能拉取到的最小seq | +| maxSeq | int | | 该用户在该会话能拉取到的最大seq | diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx index 0552b1db4e..cc354ca92d 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx @@ -150,14 +150,23 @@ title: Common Struct Descriptions | joinSource | int | | Source of Joining | 1: Invited by Admin, 2: Invited by Member, 3: Joined by Search, 4: Joined by QR Code | | inviterUserID | string | | ID of the Inviter | -## PictureBaseInfo - -> Basic Picture Information - -| Field Name | Type | Max String Length Limit | Description | Value Range | -| ---------- | ------ | ----------------------- | ------------------- | ----------- | -| uuid | string | | Unique Picture UUID | | -| type | string | | Picture Type | | -| size | int | | Picture Size | | -| width | int | | Picture Width | | -| height | int | | Picture Height | | +## ConversationInfo + +> Conversation Information + +| Field Name | Type | Maximum String Length | Description | Range | +| ---------------- | ------- | --------------------- | ------------------------------------------------------------------------------------------------ | ---------- | +| ownerUserID | string | | Owner user ID of the conversation | +| conversationID | string | | Conversation ID | +| recvMsgOpt | int | | Receive message options: 0 to receive messages, 1 to not receive messages, 2 to receive messages but not notify | +| conversationType | int | | Conversation type: 1 for single chat, 3 for group chat | +| userID | string | | User ID of the conversation, valid when the conversation type is 1 | +| groupID | string | | Group ID of the conversation, valid when the conversation type is 3 | +| isPinned | boolean | | Whether the conversation is pinned | +| attachedInfo | string | | Extended field used by openIM | +| isPrivateChat | boolean | | Whether self-destructing messages are enabled | +| groupAtType | int | | Group conversation announcement strong alert type, special identifier for group announcements **@ownerUserID**, **@all** | +| ex | string | | Extended field used by the user | +| burnDuration | int | | Duration of self-destructing messages | +| minSeq | int | | Minimum sequence number the user can retrieve in the conversation | +| maxSeq | int | | Maximum sequence number the user can retrieve in the conversation | From 8f8885e02303367ce507a57fec1d92b4a290a13b Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Wed, 7 Aug 2024 12:15:29 +0800 Subject: [PATCH 02/12] docs format. --- .../current/commonFields.mdx | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx index cc354ca92d..feeb549f42 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx @@ -154,19 +154,19 @@ title: Common Struct Descriptions > Conversation Information -| Field Name | Type | Maximum String Length | Description | Range | -| ---------------- | ------- | --------------------- | ------------------------------------------------------------------------------------------------ | ---------- | -| ownerUserID | string | | Owner user ID of the conversation | -| conversationID | string | | Conversation ID | -| recvMsgOpt | int | | Receive message options: 0 to receive messages, 1 to not receive messages, 2 to receive messages but not notify | -| conversationType | int | | Conversation type: 1 for single chat, 3 for group chat | -| userID | string | | User ID of the conversation, valid when the conversation type is 1 | -| groupID | string | | Group ID of the conversation, valid when the conversation type is 3 | -| isPinned | boolean | | Whether the conversation is pinned | -| attachedInfo | string | | Extended field used by openIM | -| isPrivateChat | boolean | | Whether self-destructing messages are enabled | +| Field Name | Type | Maximum String Length | Description | Range | +| ---------------- | ------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------ | ----- | +| ownerUserID | string | | Owner user ID of the conversation | +| conversationID | string | | Conversation ID | +| recvMsgOpt | int | | Receive message options: 0 to receive messages, 1 to not receive messages, 2 to receive messages but not notify | +| conversationType | int | | Conversation type: 1 for single chat, 3 for group chat | +| userID | string | | User ID of the conversation, valid when the conversation type is 1 | +| groupID | string | | Group ID of the conversation, valid when the conversation type is 3 | +| isPinned | boolean | | Whether the conversation is pinned | +| attachedInfo | string | | Extended field used by openIM | +| isPrivateChat | boolean | | Whether self-destructing messages are enabled | | groupAtType | int | | Group conversation announcement strong alert type, special identifier for group announcements **@ownerUserID**, **@all** | -| ex | string | | Extended field used by the user | -| burnDuration | int | | Duration of self-destructing messages | -| minSeq | int | | Minimum sequence number the user can retrieve in the conversation | -| maxSeq | int | | Maximum sequence number the user can retrieve in the conversation | +| ex | string | | Extended field used by the user | +| burnDuration | int | | Duration of self-destructing messages | +| minSeq | int | | Minimum sequence number the user can retrieve in the conversation | +| maxSeq | int | | Maximum sequence number the user can retrieve in the conversation | From 3bb600f3c39cfbb13743ad73939af6f5169fe07f Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Wed, 7 Aug 2024 12:17:20 +0800 Subject: [PATCH 03/12] revert docs. --- .../current/commonFields.mdx | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx index feeb549f42..df0b5e738b 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx @@ -150,6 +150,18 @@ title: Common Struct Descriptions | joinSource | int | | Source of Joining | 1: Invited by Admin, 2: Invited by Member, 3: Joined by Search, 4: Joined by QR Code | | inviterUserID | string | | ID of the Inviter | +## PictureBaseInfo + +> Basic Picture Information + +| Field Name | Type | Max String Length Limit | Description | Value Range | +| ---------- | ------ | ----------------------- | ------------------- | ----------- | +| uuid | string | | Unique Picture UUID | | +| type | string | | Picture Type | | +| size | int | | Picture Size | | +| width | int | | Picture Width | | +| height | int | | Picture Height | | + ## ConversationInfo > Conversation Information From dfafcb60f45b081f0459c9e4bb9a5c8519d40b55 Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Wed, 7 Aug 2024 14:25:31 +0800 Subject: [PATCH 04/12] docs: update docs contents. --- docs/restapi/commonFields.mdx | 35 ++++++++++--------- .../current/commonFields.mdx | 35 ++++++++++--------- 2 files changed, 38 insertions(+), 32 deletions(-) diff --git a/docs/restapi/commonFields.mdx b/docs/restapi/commonFields.mdx index 2c23e137d8..0ed19decf5 100644 --- a/docs/restapi/commonFields.mdx +++ b/docs/restapi/commonFields.mdx @@ -166,19 +166,22 @@ title: 常用结构体说明 > 会话信息 -| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值范围 | -| ---------------- | ------- | ------------------ | ----------------------------------------------------------------- | -------- | -| ownerUserID | string | | 会话的拥有者用户 ID | -| conversationID | string | | 会话 ID | -| recvMsgOpt | int | | 接收消息参数，0 为接收消息，1 为不接收消息，2 为接收消息但不提醒 | -| conversationType | int | | 会话类型，1 为单聊，3 为群聊 | -| userID | string | | 会话用户 ID，当会话类型为 1 时，此字段生效 | -| groupID | string | | 会话的群 ID，当会话类型为 3 时，此字段生效 | -| isPinned | boolean | | 会话是否置顶 | -| attachedInfo | string | | openIM 使用的拓展字段 | -| isPrivateChat | boolean | | 是否开启阅后即焚 | -| groupAtType | int | | 群会话公告强提示类型，群公告有人**@ownerUserID** , **@全体** 的特殊标识符 | -| ex | string | | 用户使用的拓展字段 | -| burnDuration | int | | 阅后即焚消息持续时间 | -| minSeq | int | | 该用户在该会话能拉取到的最小seq | -| maxSeq | int | | 该用户在该会话能拉取到的最大seq | +| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值范围 | +| --------------------- | ------- | ------------------ | ------------------------------------------------------------------------- | -------- | +| ownerUserID | string | | 会话的拥有者用户 ID | +| conversationID | string | | 会话 ID | +| recvMsgOpt | int | | 接收消息参数，0 为接收消息，1 为不接收消息，2 为接收消息但不提醒 | +| conversationType | int | | 会话类型，1 为单聊，3 为群聊 | +| userID | string | | 会话用户 ID，当会话类型为 1 时，此字段生效 | +| groupID | string | | 会话的群 ID，当会话类型为 3 时，此字段生效 | +| isPinned | boolean | | 会话是否置顶 | +| attachedInfo | string | | openIM 使用的拓展字段 | +| isPrivateChat | boolean | | 是否开启阅后即焚 | +| groupAtType | int | | 群会话公告强提示类型，群公告有人**@ownerUserID** , **@全体** 的特殊标识符 | +| ex | string | | 用户使用的拓展字段 | +| burnDuration | int | | 阅后即焚消息持续时间 | +| minSeq | int | | 该用户在该会话能拉取到的最小 seq | +| maxSeq | int | | 该用户在该会话能拉取到的最大 seq | +| msgDestructTime | int | | 消息销毁间隔时间 | +| latestMsgDestructTime | int | | 消息最后销毁时间 | +| isMsgDestruct | boolean | | 是否开启消息定时销毁 | diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx index df0b5e738b..7274ce0db5 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/commonFields.mdx @@ -166,19 +166,22 @@ title: Common Struct Descriptions > Conversation Information -| Field Name | Type | Maximum String Length | Description | Range | -| ---------------- | ------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------ | ----- | -| ownerUserID | string | | Owner user ID of the conversation | -| conversationID | string | | Conversation ID | -| recvMsgOpt | int | | Receive message options: 0 to receive messages, 1 to not receive messages, 2 to receive messages but not notify | -| conversationType | int | | Conversation type: 1 for single chat, 3 for group chat | -| userID | string | | User ID of the conversation, valid when the conversation type is 1 | -| groupID | string | | Group ID of the conversation, valid when the conversation type is 3 | -| isPinned | boolean | | Whether the conversation is pinned | -| attachedInfo | string | | Extended field used by openIM | -| isPrivateChat | boolean | | Whether self-destructing messages are enabled | -| groupAtType | int | | Group conversation announcement strong alert type, special identifier for group announcements **@ownerUserID**, **@all** | -| ex | string | | Extended field used by the user | -| burnDuration | int | | Duration of self-destructing messages | -| minSeq | int | | Minimum sequence number the user can retrieve in the conversation | -| maxSeq | int | | Maximum sequence number the user can retrieve in the conversation | +| Field Name | Type | Maximum String Length | Description | Range | +| --------------------- | ------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ----- | +| ownerUserID | string | | Owner user ID of the conversation | +| conversationID | string | | Conversation ID | +| recvMsgOpt | int | | Receive message options: 0 to receive messages, 1 to not receive messages, 2 to receive messages but not notify | +| conversationType | int | | Conversation type: 1 for single chat, 3 for group chat | +| userID | string | | User ID of the conversation, valid when the conversation type is 1 | +| groupID | string | | Group ID of the conversation, valid when the conversation type is 3 | +| isPinned | boolean | | Whether the conversation is pinned | +| attachedInfo | string | | Extended field used by openIM | +| isPrivateChat | boolean | | Whether self-destructing messages are enabled | +| groupAtType | int | | Group conversation announcement strong alert type, special identifier for group announcements **@ownerUserID**, **@all** | +| ex | string | | Extended field used by the user | +| burnDuration | int | | Duration of self-destructing messages | +| minSeq | int | | Minimum sequence number the user can retrieve in the conversation | +| maxSeq | int | | Maximum sequence number the user can retrieve in the conversation | +| msgDestructTime | int | Message destruction interval | +| latestMsgDestructTime | int | Latest message destruction time | +| isMsgDestruct | boolean | Whether timed message destruction is enabled | From 94c2413e64fcc47e3c54457c099be9e0dd01d0c1 Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Fri, 16 Aug 2024 18:08:29 +0800 Subject: [PATCH 05/12] feat: update api docs to v3.8 --- .../getFullConversationIDs.mdx | 98 ++++ .../getIncrementalConversations.mdx | 172 +++++++ .../getOwnerConversation.mdx | 470 ++++++++++++++++++ .../setConversations.mdx | 98 ++++ .../getDesignatedFriends.mdx | 102 ++++ .../apis/friendsManagement/getFriendId.mdx | 82 +++ .../friendsManagement/getFullFriendUserId.mdx | 99 ++++ .../getIncrementalFriends.mdx | 151 ++++++ .../friendsManagement/getSentApplication.mdx | 2 +- .../apis/friendsManagement/importFriend.mdx | 2 +- .../friendsManagement/processApplication.mdx | 2 +- .../friendsManagement/sendApplication.mdx | 2 +- .../friendsManagement/updateFriendRemark.mdx | 2 +- .../getFullGroupMemberUserIds.mdx | 98 ++++ .../groupManagement/getFullJoinGroupIds.mdx | 89 ++++ .../groupManagement/getGroupMemberUserId.mdx | 85 ++++ .../getIncrementalGroupMembers.mdx | 131 +++++ .../getIncrementalGroupMembersBatch.mdx | 143 ++++++ .../getIncrementalJoinGroups.mdx | 135 +++++ .../apis/messageManagement/batchSendMsg.mdx | 105 ++++ .../apis/messageManagement/searchMsg.mdx | 370 ++++++++++++++ docs/restapi/commonFields.mdx | 2 +- 22 files changed, 2434 insertions(+), 6 deletions(-) create mode 100644 docs/restapi/apis/conversationManagement/getFullConversationIDs.mdx create mode 100644 docs/restapi/apis/conversationManagement/getIncrementalConversations.mdx create mode 100644 docs/restapi/apis/conversationManagement/getOwnerConversation.mdx create mode 100644 docs/restapi/apis/conversationManagement/setConversations.mdx create mode 100644 docs/restapi/apis/friendsManagement/getDesignatedFriends.mdx create mode 100644 docs/restapi/apis/friendsManagement/getFriendId.mdx create mode 100644 docs/restapi/apis/friendsManagement/getFullFriendUserId.mdx create mode 100644 docs/restapi/apis/friendsManagement/getIncrementalFriends.mdx create mode 100644 docs/restapi/apis/groupManagement/getFullGroupMemberUserIds.mdx create mode 100644 docs/restapi/apis/groupManagement/getFullJoinGroupIds.mdx create mode 100644 docs/restapi/apis/groupManagement/getGroupMemberUserId.mdx create mode 100644 docs/restapi/apis/groupManagement/getIncrementalGroupMembers.mdx create mode 100644 docs/restapi/apis/groupManagement/getIncrementalGroupMembersBatch.mdx create mode 100644 docs/restapi/apis/groupManagement/getIncrementalJoinGroups.mdx create mode 100644 docs/restapi/apis/messageManagement/batchSendMsg.mdx create mode 100644 docs/restapi/apis/messageManagement/searchMsg.mdx diff --git a/docs/restapi/apis/conversationManagement/getFullConversationIDs.mdx b/docs/restapi/apis/conversationManagement/getFullConversationIDs.mdx new file mode 100644 index 0000000000..a74d529c40 --- /dev/null +++ b/docs/restapi/apis/conversationManagement/getFullConversationIDs.mdx @@ -0,0 +1,98 @@ +--- +sidebar_position: 2 +title: 获取全量会话ID列表 +hide_title: true +--- + +
+ +## 获取全量会话ID列表 + +
+ +### 简要描述 +- 获取指定用户的全量会话ID列表。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/conversation/get_full_conversation_ids` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + +### 请求参数示例 + + +```json +{ + "idhash": 3228175501, + "userID": "2268888073" +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|idhash|必填|int|用户ID Hash| +|userID|必填|string|用户ID| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "version": 15804284030727883000, + "versionID": "669a229c3cd5e8fc6530ecb2", + "equal": false, + "conversationIDs": [ + "sg_291798782", + "sg_3187706596", + "sg_570135126", + "si_1695766238_2268888073", + "si_2268888073_2839845469", + "si_2268888073_2882899447", + "si_2268888073_3418577436", + "si_2268888073_4918276559", + "si_2268888073_7497605401", + "si_2268888073_9169530932" + ] + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|version|string|ID Hash| +|versionID|string|当前版本表ID| +|equal|string|Hash 是否相等| +|conversationIDs|string|会话ID列表| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/conversationManagement/getIncrementalConversations.mdx b/docs/restapi/apis/conversationManagement/getIncrementalConversations.mdx new file mode 100644 index 0000000000..1ecbb237fd --- /dev/null +++ b/docs/restapi/apis/conversationManagement/getIncrementalConversations.mdx @@ -0,0 +1,172 @@ +--- +sidebar_position: 3 +title: 获取增量会话列表 +hide_title: true +--- + +
+ +## 获取增量会话列表 + +
+ +### 简要描述 +- 获取指定用户的指定版本间的会话变化列表。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/conversation/get_incremental_conversations` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + + +### 请求参数示例 + + +```json +{ + "userID": "4084688351", + "versionID": "669a20773cd5e8fc6530ec99", + "version": 10 +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|userID|必填|string|用户ID| +|versionID|必填|string|会话增量版本表ID| +|version|必填|string|当前版本号| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "version": 18, + "versionID": "669a20773cd5e8fc6530ec99", + "full": false, + "delete": null, + "insert": [ + { + "ownerUserID": "4084688351", + "conversationID": "sg_570135126", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "570135126", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 0, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 0, + "latestMsgDestructTime": -62135596800000, + "isMsgDestruct": false + } + ], + "update": [ + { + "ownerUserID": "4084688351", + "conversationID": "si_2839845469_4084688351", + "recvMsgOpt": 0, + "conversationType": 1, + "userID": "2839845469", + "groupID": "", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 0, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 0, + "latestMsgDestructTime": -62135596800000, + "isMsgDestruct": false + }, + { + "ownerUserID": "4084688351", + "conversationID": "sg_3187706596", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "3187706596", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 0, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 0, + "latestMsgDestructTime": -62135596800000, + "isMsgDestruct": false + }, + { + "ownerUserID": "4084688351", + "conversationID": "sg_291798782", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "291798782", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 4, + "ex": "", + "burnDuration": 0, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 0, + "latestMsgDestructTime": -62135596800000, + "isMsgDestruct": false + } + ] + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|version|string|群组增量版本表| +|versionID|string|当前版本号| +|full|boolean|是否全量同步| +|delete|string|被删除群成员ID列表| +|insert|array|插入的[会话](docs/restapi/commonFields.mdx#conversationinfo)列表| +|update|array|更新的[会话](docs/restapi/commonFields.mdx#conversationinfo)列表| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/conversationManagement/getOwnerConversation.mdx b/docs/restapi/apis/conversationManagement/getOwnerConversation.mdx new file mode 100644 index 0000000000..04a144c8a9 --- /dev/null +++ b/docs/restapi/apis/conversationManagement/getOwnerConversation.mdx @@ -0,0 +1,470 @@ +--- +sidebar_position: 8 +title: 获取当前用户的分页会话列表 +hide_title: true +--- + +
+ +## 获取当前用户的分页会话列表 + +
+ +### 简要描述 +- 获取当前用户的分页会话列表 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/conversation/get_owner_conversation` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + + +### 请求参数示例 + + +```json +{ + "userID": "1008432211", + "pagination": { + "pageNumber": 1, + "showNumber": 20 + } +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|userID|必填|string|当前用户ID| +|pagination|必填|object|分页参数结构体| +|pagination.pageNumber|必填|string|当前页码，从1开始| +|pagination.showNumber|必填|string|当前页请求数量| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "total": 38, + "conversations": [ + { + "ownerUserID": "1008432211", + "conversationID": "sg_1012900607", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "1012900607", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 0, + "minSeq": 0, + "maxSeq": 184, + "msgDestructTime": 0, + "latestMsgDestructTime": -62135596800000, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_1084800774", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "1084800774", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1695265099982, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_1300152726", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "1300152726", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1700464579733, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_1760150676", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "1760150676", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1694565537524, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_1959004809", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "1959004809", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1693526134219, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_198075251", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "198075251", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 0, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 0, + "latestMsgDestructTime": -62135596800000, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_198617661", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "198617661", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 0, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 0, + "latestMsgDestructTime": -62135596800000, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_2211210937", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "2211210937", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1698321453986, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_2338619613", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "2338619613", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 4, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 268, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1695175479581, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_2590740935", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "2590740935", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1694565650924, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_2849984129", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "2849984129", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1695175496783, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_2978362440", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "2978362440", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 5, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1694569026129, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_3140024257", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "3140024257", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1695175468085, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_3179761042", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "3179761042", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1693525753518, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_3187706596", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "3187706596", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 4, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1693364218123, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_3327367899", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "3327367899", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1694375242097, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_3419642055", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "3419642055", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1700445790936, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_3561750878", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "3561750878", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1695175484281, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_3710129094", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "3710129094", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 3, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1697081735129, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_3905809684", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "3905809684", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 2, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1695622938140, + "isMsgDestruct": false + } + ] + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|total|string|会话总数| +|conversations|array|(会话](docs/restapi/commonFields.mdx#conversationinfo)列表| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/conversationManagement/setConversations.mdx b/docs/restapi/apis/conversationManagement/setConversations.mdx new file mode 100644 index 0000000000..1d298211fd --- /dev/null +++ b/docs/restapi/apis/conversationManagement/setConversations.mdx @@ -0,0 +1,98 @@ +--- +sidebar_position: 7 +title: 多个用户对同一会话设置字段 +hide_title: true +--- + +
+ +## 多个用户对同一会话设置字段 + +
+ +### 简要描述 +- 多个用户对同一会话可选择性的设置字段。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/conversation/set_conversations` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + +### 请求参数示例 + + +```json +{ + "userIDs": [ + "6965946400" + ], + "conversation": { + "conversationID": "si_4365007572_6965946400", + "conversationType": 1, + "userID": "4365007572", + "groupID": "", + "recvMsgOpt": 0, + "isPinned": false, + "isPrivateChat": true, + "ex": "", + "burnDuration": 30 + } +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|userIDs|必填|array|要设置会话字段的用户ID列表| +|conversation|必填|object|会话对象| +|conversation.conversationID|必填|string|会话ID| +|conversation.conversationType|必填|int|会话类型，单聊为1，群聊为3| +|conversation.userID|选填|string|会话类型为单聊时必填| +|conversation.groupID|选填|string|会话类型为群聊时必填| +|conversation.recvMsgOpt|选填|int|会话免打扰状态| +|conversation.isPinned|选填|boolean|会话是否置顶| +|conversation.isPrivateChat|选填|boolean|是否开启阅后即焚| +|conversation.ex|选填|string|会话扩展字段| +|conversation.burnDuration|选填|string|设置会话阅后即焚时间，单位秒| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "" +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/friendsManagement/getDesignatedFriends.mdx b/docs/restapi/apis/friendsManagement/getDesignatedFriends.mdx new file mode 100644 index 0000000000..cc467b9ce8 --- /dev/null +++ b/docs/restapi/apis/friendsManagement/getDesignatedFriends.mdx @@ -0,0 +1,102 @@ +--- +sidebar_position: 5 +title: 获取特定好友列表 +hide_title: true +--- + +
+ +## 获取特定好友列表 + +
+ +### 简要描述 +- 分页获取指定用户的特定好友列表，如果无结果不返回错误。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/friend/get_designated_friends` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + +### 请求参数示例 + + +```json +{ + "ownerUserID": "1001978187", + "friendUserIDs": [ + "xxxxxx" + ] +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|ownerUserID|必填|string|指定的用户ID| +|friendUserIDs|必填|object|指定的好友ID列表| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "friendsInfo": [ + { + "ownerUserID": "11000000", + "remark": "", + "createTime": 1695252063, + "friendUser": { + "userID": "11111111", + "nickname": "Your Name", + "faceURL": "Your URL", + "ex": "", + "createTime": 0, + "appMangerLevel": 0, + "globalRecvMsgOpt": 0 + }, + "addSource": 1, + "operatorUserID": "1111111", + "ex": "", + "isPinned": false + } + ] + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|friendsInfo|array|[好友信息](docs/restapi/commonFields.mdx#friendinfo)列表| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/friendsManagement/getFriendId.mdx b/docs/restapi/apis/friendsManagement/getFriendId.mdx new file mode 100644 index 0000000000..39e3cb100a --- /dev/null +++ b/docs/restapi/apis/friendsManagement/getFriendId.mdx @@ -0,0 +1,82 @@ +--- +sidebar_position: 6 +title: 获取好友ID列表 +hide_title: true +--- + +
+ +## 获取好友ID列表 + +
+ +### 简要描述 +- 获取指定用户的好友ID列表。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/friend/get_friend_id` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + +### 请求参数示例 + + +```json +{ + "userID": "1231233" +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|userID|必填|string|用户ID| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "friendIDs": [ + "1111111", + "2222222" + ] + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|friendIDs|string|好友ID列表| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/friendsManagement/getFullFriendUserId.mdx b/docs/restapi/apis/friendsManagement/getFullFriendUserId.mdx new file mode 100644 index 0000000000..40574f2ebf --- /dev/null +++ b/docs/restapi/apis/friendsManagement/getFullFriendUserId.mdx @@ -0,0 +1,99 @@ +--- +sidebar_position: 8 +title: 获取全量好友ID列表 +hide_title: true +--- + +
+ +## 获取全量好友ID列表 + +
+ +### 简要描述 +- 获取指定用户的全量好友ID列表。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/friend/get_full_friend_user_ids` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + +### 请求参数示例 + + +```json +{ +"idhash":123123, + "userID": "5099153716" +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|idhash|必填|int|用户id Hash| +|userID|必填|string|用户ID| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "version": 16201896299926272000, + "versionID": "66a1bf782429d1e700ee3789", + "equal": false, + "userIDs": [ + "1695766238", + "2725451243", + "2839845469", + "2882899447", + "3418577436", + "5292156665", + "5668985363", + "7497605401", + "9169530932", + "4918276559", + "5620768201" + ] + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|version|string|ID Hash| +|versionID|string|当前版本表ID| +|equal|string|Hash 是否相等| +|userIDs|array|好友ID列表| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/friendsManagement/getIncrementalFriends.mdx b/docs/restapi/apis/friendsManagement/getIncrementalFriends.mdx new file mode 100644 index 0000000000..7b3d5cbea5 --- /dev/null +++ b/docs/restapi/apis/friendsManagement/getIncrementalFriends.mdx @@ -0,0 +1,151 @@ +--- +sidebar_position: 7 +title: 获取增量好友列表 +hide_title: true +--- + +
+ +## 获取增量好友列表 + +
+ +### 简要描述 +- 获取指定用户的指定版本间的好友变化列表。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/friend/get_incremental_friends` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + + +### 请求参数示例 + + +```json +{ + "userID": "advzxc123", + "versionID": "123321", + "version": 1 +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|userID|必填|string|用户ID| +|versionID|必填|string|好友增量版本表ID| +|version|必填|string|当前版本号| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "version": 48, + "versionID": "669a20774e3031f1220d0188", + "full": false, + "delete": null, + "insert": null, + "update": [ + { + "ownerUserID": "4084688351", + "remark": "", + "createTime": 1721376887, + "friendUser": { + "userID": "2839845469", + "nickname": "OpenIM-Kevln", + "faceURL": "https://web.rentsoft.cn/api_enterprise/object/2839845469/1551721111119_.pic.webp", + "ex": "", + "createTime": 0, + "appMangerLevel": 0, + "globalRecvMsgOpt": 0 + }, + "addSource": 1, + "operatorUserID": "1721376886813", + "ex": "", + "isPinned": false + }, + { + "ownerUserID": "4084688351", + "remark": "", + "createTime": 1721376887, + "friendUser": { + "userID": "3418577436", + "nickname": "OpenIM-skiffer", + "faceURL": "https://web.rentsoft.cn/api_enterprise/object/3418577436/BD14C2C1956AB2E1BD8A9F33E76220BE (1).jpg", + "ex": "", + "createTime": 0, + "appMangerLevel": 0, + "globalRecvMsgOpt": 0 + }, + "addSource": 1, + "operatorUserID": "1721376886813", + "ex": "", + "isPinned": false + }, + { + "ownerUserID": "4084688351", + "remark": "", + "createTime": 1721376887, + "friendUser": { + "userID": "7497605401", + "nickname": "Jane-", + "faceURL": "https://web.rentsoft.cn/api_enterprise/object/7497605401/微信截图_20240709181242.webp", + "ex": "", + "createTime": 0, + "appMangerLevel": 0, + "globalRecvMsgOpt": 0 + }, + "addSource": 1, + "operatorUserID": "1721376886813", + "ex": "", + "isPinned": false + } + ], + "sortVersion": 0 + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|version|string|| +|versionID|string|| +|full|boolean|是否全量同步| +|delete|string|被删除ID列表| +|insert|array|插入的[好友信息](docs/restapi/commonFields.mdx#friendinfo)列表| +|update|array|更新的[好友信息](docs/restapi/commonFields.mdx#friendinfo)列表| +|sortVersion|string|如果大于0，则需要全量获取排序| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/friendsManagement/getSentApplication.mdx b/docs/restapi/apis/friendsManagement/getSentApplication.mdx index 8331feaf03..9aca92454e 100644 --- a/docs/restapi/apis/friendsManagement/getSentApplication.mdx +++ b/docs/restapi/apis/friendsManagement/getSentApplication.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 13 title: 获取发起的好友申请 hide_title: true --- diff --git a/docs/restapi/apis/friendsManagement/importFriend.mdx b/docs/restapi/apis/friendsManagement/importFriend.mdx index 04f9e90b8a..52d508a84c 100644 --- a/docs/restapi/apis/friendsManagement/importFriend.mdx +++ b/docs/restapi/apis/friendsManagement/importFriend.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 11 title: 导入好友 hide_title: true --- diff --git a/docs/restapi/apis/friendsManagement/processApplication.mdx b/docs/restapi/apis/friendsManagement/processApplication.mdx index bd7945ff7b..20281408d0 100644 --- a/docs/restapi/apis/friendsManagement/processApplication.mdx +++ b/docs/restapi/apis/friendsManagement/processApplication.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 12 title: 处理好友申请 hide_title: true --- diff --git a/docs/restapi/apis/friendsManagement/sendApplication.mdx b/docs/restapi/apis/friendsManagement/sendApplication.mdx index 028810254a..c56f410f0d 100644 --- a/docs/restapi/apis/friendsManagement/sendApplication.mdx +++ b/docs/restapi/apis/friendsManagement/sendApplication.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 10 title: 发起好友申请 hide_title: true --- diff --git a/docs/restapi/apis/friendsManagement/updateFriendRemark.mdx b/docs/restapi/apis/friendsManagement/updateFriendRemark.mdx index f1b399e3fb..d63f2517a7 100644 --- a/docs/restapi/apis/friendsManagement/updateFriendRemark.mdx +++ b/docs/restapi/apis/friendsManagement/updateFriendRemark.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 9 title: 修改好友备注 hide_title: true --- diff --git a/docs/restapi/apis/groupManagement/getFullGroupMemberUserIds.mdx b/docs/restapi/apis/groupManagement/getFullGroupMemberUserIds.mdx new file mode 100644 index 0000000000..b8064752ec --- /dev/null +++ b/docs/restapi/apis/groupManagement/getFullGroupMemberUserIds.mdx @@ -0,0 +1,98 @@ +--- +sidebar_position: 4 +title: 获取全量群成员ID列表 +hide_title: true +--- + +
+ +## 获取全量群成员ID列表 + +
+ +### 简要描述 +- 获取指定群的全量群成员ID列表。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/group/get_full_group_member_user_ids` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + +### 请求参数示例 + + +```json +{ + "idhash": 3228175501, + "groupID": "3228175501" +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|idhash|必填|int|群id Hash| +|groupID|必填|string|群ID| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "version": 16201896299926272000, + "versionID": "66a1bf782429d1e700ee3789", + "equal": false, + "userIDs": [ + "1695766238", + "2725451243", + "2839845469", + "2882899447", + "3418577436", + "5292156665", + "5668985363", + "7497605401", + "9169530932", + "4918276559", + "5620768201" + ] + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|version|string|ID Hash| +|versionID|string|当前版本表ID| +|equal|string|Hash 是否相等| +|userIDs|array|群成员ID列表| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/groupManagement/getFullJoinGroupIds.mdx b/docs/restapi/apis/groupManagement/getFullJoinGroupIds.mdx new file mode 100644 index 0000000000..35e5243dd4 --- /dev/null +++ b/docs/restapi/apis/groupManagement/getFullJoinGroupIds.mdx @@ -0,0 +1,89 @@ +--- +sidebar_position: 5 +title: 获取全量已加入群组ID列表 +hide_title: true +--- + +
+ +## 获取全量已加入群组ID列表 + +
+ +### 简要描述 +- 获取指定用户的全量已加入群ID列表。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/group/get_full_join_group_ids` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + +### 请求参数示例 + + +```json +{ + "idhash": 3228175501, + "userID": "2268888073" +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|idhash|必填|int|用户ID Hash| +|userID|必填|string|用户ID| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "version": 11285559722339189000, + "versionID": "669a229cbd218dbf9196e89d", + "equal": false, + "groupIDs": [ + "3187706596", + "291798782" + ] + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|version|string|ID Hash| +|versionID|string|当前版本表ID| +|equal|string|Hash 是否相等| +|groupIDs|array|已加入群ID列表| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/groupManagement/getGroupMemberUserId.mdx b/docs/restapi/apis/groupManagement/getGroupMemberUserId.mdx new file mode 100644 index 0000000000..bc5c97de59 --- /dev/null +++ b/docs/restapi/apis/groupManagement/getGroupMemberUserId.mdx @@ -0,0 +1,85 @@ +--- +sidebar_position: 13 +title: 获取群成员用户ID列表 +hide_title: true +--- + +
+ +## 获取群成员用户ID列表 + +
+ +### 简要描述 +- 获取指定群成员用户的ID列表。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/group/get_group_member_user_id` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + +### 请求参数示例 + + +```json +{ + "groupID": "1012900607" +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|groupID|必填|string|群ID| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "userIDs": [ + "1029199385", + "1035025841", + "1046238762", + "1695766238", + "8772228740", + "9447003536" + ] + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|userIDs|string|群成员ID列表| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/groupManagement/getIncrementalGroupMembers.mdx b/docs/restapi/apis/groupManagement/getIncrementalGroupMembers.mdx new file mode 100644 index 0000000000..1b24cad482 --- /dev/null +++ b/docs/restapi/apis/groupManagement/getIncrementalGroupMembers.mdx @@ -0,0 +1,131 @@ +--- +sidebar_position: 7 +title: 获取增量群成员列表 +hide_title: true +--- + +
+ +## 获取增量群成员列表 + +
+ +### 简要描述 +- 获取指定群组的指定版本间的群成员变化列表。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/group/get_incremental_group_members` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + +### 请求参数示例 + + +```json +{ + "groupID": "3416772962", + "versionID": "669a211abd218dbf9196e884", + "version": 20 +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|groupID|必填|string|群组ID| +|versionID|必填|string|群增量版本表ID| +|version|必填|string|当前版本号| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "version": 25, + "versionID": "669a211abd218dbf9196e884", + "full": false, + "delete": null, + "insert": null, + "update": [ + { + "groupID": "3416772962", + "userID": "7497605401", + "roleLevel": 20, + "joinTime": 1709774772037, + "nickname": "Jane-", + "faceURL": "https://web.rentsoft.cn/api_enterprise/object/7497605401/微信截图_20240709181242.webp", + "appMangerLevel": 0, + "joinSource": 2, + "operatorUserID": "8941452423", + "ex": "", + "muteEndTime": 0, + "inviterUserID": "8941452423" + } + ], + "group": { + "groupID": "3416772962", + "groupName": "工作群1", + "notification": "", + "introduction": "", + "faceURL": "", + "ownerUserID": "8941452423", + "createTime": 1709774772036, + "memberCount": 3, + "ex": "", + "status": 0, + "creatorUserID": "8941452423", + "groupType": 2, + "needVerification": 0, + "lookMemberInfo": 0, + "applyMemberFriend": 0, + "notificationUpdateTime": 0, + "notificationUserID": "", + "displayIsRead": true + }, + "sortVersion": 0 + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|version|string|群组增量版本表| +|versionID|string|当前版本号| +|full|boolean|是否全量同步| +|delete|string|被删除群成员ID列表| +|insert|array|插入的[群成员信息](docs/restapi/commonFields.mdx#groupmemberinfo)列表| +|update|array|更新的[群成员信息](docs/restapi/commonFields.mdx#groupmemberinfo)列表| +|group|object|[群信息](docs/restapi/commonFields.mdx#groupinfo)列表| +|sortVersion|string|如果大于0，则需要全量获取排序| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/groupManagement/getIncrementalGroupMembersBatch.mdx b/docs/restapi/apis/groupManagement/getIncrementalGroupMembersBatch.mdx new file mode 100644 index 0000000000..7eaba3f2c7 --- /dev/null +++ b/docs/restapi/apis/groupManagement/getIncrementalGroupMembersBatch.mdx @@ -0,0 +1,143 @@ +--- +sidebar_position: 9 +title: 批量获取增量群成员列表 +hide_title: true +--- + +
+ +## 批量获取增量群成员列表 + +
+ +### 简要描述 +- 批量获取指定群组的指定版本间的群成员变化列表。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/group/get_incremental_group_members_batch` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + +### 请求参数示例 + + +```json +{ + "userID": "7497605401", + "reqList": [ + { + "groupID": "3416772962", + "versionID": "669a211abd218dbf9196e884", + "version": 20 + } + ] +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|userID|必填|string|用户ID| +|reqList|必填|array|批量获取增量群成员的请求列表| +|reqList.groupID|必填|string|群ID| +|reqList.versionID|必填|string|群增量版本表ID| +|reqList.version|必填|string|增量版本号| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "respList": { + "3416772962": { + "version": 25, + "versionID": "669a211abd218dbf9196e884", + "full": false, + "delete": null, + "insert": null, + "update": [ + { + "groupID": "3416772962", + "userID": "7497605401", + "roleLevel": 20, + "joinTime": 1709774772037, + "nickname": "Jane-", + "faceURL": "https://web.rentsoft.cn/api_enterprise/object/7497605401/微信截图_20240709181242.webp", + "appMangerLevel": 0, + "joinSource": 2, + "operatorUserID": "8941452423", + "ex": "", + "muteEndTime": 0, + "inviterUserID": "8941452423" + } + ], + "group": { + "groupID": "3416772962", + "groupName": "工作群1", + "notification": "", + "introduction": "", + "faceURL": "", + "ownerUserID": "8941452423", + "createTime": 1709774772036, + "memberCount": 3, + "ex": "", + "status": 0, + "creatorUserID": "8941452423", + "groupType": 2, + "needVerification": 0, + "lookMemberInfo": 0, + "applyMemberFriend": 0, + "notificationUpdateTime": 0, + "notificationUserID": "", + "displayIsRead": true + }, + "sortVersion": 0 + } + } + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|respList|object|批量获取增量群成员的响应列表| +|respList.version|string|增量版本号| +|respList.versionID|string|群成员增量版本表| +|respList.full|string|是否全量同步| +|respList.delete|object|被删除群成员ID列表| +|respList.insert|object|插入的[群成员信息](docs/restapi/commonFields.mdx#groupmemberinfo)列表| +|respList.update|array|更新的[群成员信息](docs/restapi/commonFields.mdx#groupmemberinfo)列表| +|respList.group|object|[群信息](docs/restapi/commonFields.mdx#groupinfo)列表| +|respList.sortVersion|string|如果大于0，则需要全量获取排序| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/groupManagement/getIncrementalJoinGroups.mdx b/docs/restapi/apis/groupManagement/getIncrementalJoinGroups.mdx new file mode 100644 index 0000000000..a948f5f990 --- /dev/null +++ b/docs/restapi/apis/groupManagement/getIncrementalJoinGroups.mdx @@ -0,0 +1,135 @@ +--- +sidebar_position: 8 +title: 获取增量已加入群组列表 +hide_title: true +--- + +
+ +## 获取增量已加入群组列表 + +
+ +### 简要描述 +- 获取指定用户的指定版本间的已加入群组变化列表。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/group/get_incremental_join_groups` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + +### 请求参数示例 + + +```json +{ + "userID": "8460878932", + "versionID": "669a2667bd218dbf9196e8c4", + "version": 3 +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|userID|必填|string|用户ID| +|versionID|必填|string|群增量版本表ID| +|version|必填|string|当前版本号| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "version": 5, + "versionID": "669a2667bd218dbf9196e8c4", + "full": false, + "delete": null, + "insert": [ + { + "groupID": "3793971726", + "groupName": "000000000000", + "notification": "", + "introduction": "", + "faceURL": "", + "ownerUserID": "8460878932", + "createTime": 1721380274393, + "memberCount": 4, + "ex": "", + "status": 0, + "creatorUserID": "8460878932", + "groupType": 2, + "needVerification": 0, + "lookMemberInfo": 0, + "applyMemberFriend": 0, + "notificationUpdateTime": 0, + "notificationUserID": "", + "displayIsRead": true + }, + { + "groupID": "2244016122", + "groupName": "11", + "notification": "", + "introduction": "", + "faceURL": "", + "ownerUserID": "4500796576", + "createTime": 1721994729129, + "memberCount": 3, + "ex": "", + "status": 0, + "creatorUserID": "4500796576", + "groupType": 2, + "needVerification": 0, + "lookMemberInfo": 0, + "applyMemberFriend": 0, + "notificationUpdateTime": 0, + "notificationUserID": "", + "displayIsRead": true + } + ], + "update": null, + "sortVersion": 0 + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|version|string|群组增量版本表| +|versionID|string|当前版本号| +|full|boolean|是否全量同步| +|delete|string|被删除群ID列表| +|insert|array|插入的[群组信息](docs/restapi/commonFields.mdx#groupinfo)列表| +|update|array|更新的[群组信息](docs/restapi/commonFields.mdx#groupinfo)列表| +|sortVersion|string|如果大于0，则需要全量获取排序| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/messageManagement/batchSendMsg.mdx b/docs/restapi/apis/messageManagement/batchSendMsg.mdx new file mode 100644 index 0000000000..326d4b974a --- /dev/null +++ b/docs/restapi/apis/messageManagement/batchSendMsg.mdx @@ -0,0 +1,105 @@ +--- +sidebar_position: 13 +title: 批量发送消息 +hide_title: true +--- + +
+ +## 批量发送消息 + +
+ +### 简要描述 +- 批量发送消息。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/msg/batch_send_msg` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + +### 请求参数示例 + + +```json +{ + "sendID": "openIMAdmin", + "senderNickname": "Gordon", + "senderFaceURL": "http://www.head.com", + "senderPlatformID": 1, + "content": { + "text": "{\"content\":\"hello world!\"}" + }, + "contentType": 101, + "sessionType": 1, + "isOnlineOnly": false, + "notOfflinePush": false, + "offlinePushInfo": { + "title": "send message", + "desc": "", + "ex": "", + "iOSPushSound": "default", + "iOSBadgeCount": true + }, + "isSendAll": true +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|sendID|必填|string|发送者ID(可以为管理员ID，可以为用户ID)| +|recvIDs|选填|array|接收者ID列表，sessionType1或者4，必填，为接收方用户ID，如果是群聊则不填| +|senderNickname|选填|string|发送者昵称| +|senderFaceURL|选填|string|发送者头像| +|senderPlatformID|选填|int|发送者平台号，模拟用户发送时填写， 1->IOS,2->Android,3->Windows,4->OSX,5->Web,5->MiniWeb,7->Linux,8->AndroidPad,9->IPad| +|content|必填|object|消息的具体内容，内部是json 对象，其他消息的详细字段请参考消息类型格式描述文档| +|contentType|必填|int|消息类型，101表示文本，102表示图片..详细参考消息类型格式描述文档| +|sessionType|必填|int|会话类型，发送的消息是单聊还是群聊,单聊为1，群聊（普通写扩散）为2,大群(读扩散接口)为3，通知会话为4| +|isOnlineOnly|选填|boolean|该字段设置为true时候，发送的消息服务器不会存储，接收者在线才会收到，不在线该消息丢失| +|notOfflinePush|选填|string|该字段设置为true时候，发送的消息在用户离线时将不会进行离线推送| +|offlinePushInfo|选填|object|离线推送的具体内容，如果不填写，使用服务器默认推送标题| +|offlinePushInfo.title|选填|string|推送的标题| +|offlinePushInfo.desc|选填|string|推送的具体描述| +|offlinePushInfo.ex|选填|string|扩展字段| +|offlinePushInfo.iOSPushSound|选填|string|IOS的推送声音| +|offlinePushInfo.iOSBadgeCount|选填|string|IOS推送消息是否计入桌面图标未读数| +|isSendAll|选填|boolean|是否发送给全部人| +### 成功返回示例 + + +```json + +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/messageManagement/searchMsg.mdx b/docs/restapi/apis/messageManagement/searchMsg.mdx new file mode 100644 index 0000000000..5cb30e0329 --- /dev/null +++ b/docs/restapi/apis/messageManagement/searchMsg.mdx @@ -0,0 +1,370 @@ +--- +sidebar_position: 12 +title: 查询消息 +hide_title: true +--- + +
+ +## 查询消息 + +
+ +### 简要描述 +- 搜索消息，支持分页。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/msg/search_msg` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + +### 请求参数示例 + + +```json +{ + "sendID": "", + "recvID": "", + "msgType": 0, + "sendTime": "", + "sessionType": 1, + "pagination": { + "pagenumber": 1, + "showNumber": 10 + } +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|sendID|选填|string|发送者ID| +|recvID|选填|string|接收者ID| +|msgType|选填|string|消息类型| +|sendTime|选填|string|发送时间| +|sessionType|选填|string|会话类型| +|pagination|必填|object|| +|pagination.pagenumber|必填|string|分页 0开始| +|pagination.showNumber|必填|string|每页数量| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "chatLogs": [ + { + "serverMsgID": "946db72dccc4dd74e2831e0dd7f5bf1e", + "clientMsgID": "016159d9684fa181c525afd06d0f8cc7", + "sendID": "5855361412", + "recvID": "1126971029", + "groupID": "", + "recvNickname": "的ss你我", + "senderPlatformID": 0, + "senderNickname": "客人", + "senderFaceURL": "", + "groupName": "", + "sessionType": 1, + "msgFrom": 200, + "contentType": 1201, + "content": "{\"detail\":\"{\\\"fromToUserID\\\":{\\\"fromUserID\\\":\\\"1126971029\\\",\\\"toUserID\\\":\\\"5855361412\\\"},\\\"handleMsg\\\":\\\"\\\"}\"}", + "status": 0, + "sendTime": 1690459824302, + "createTime": 1690459824301, + "ex": "", + "groupFaceURL": "", + "groupMemberCount": 0, + "seq": 1, + "groupOwner": "", + "groupType": 0 + }, + { + "serverMsgID": "fc956b77f1e7474fa7957ad864af56fb", + "clientMsgID": "c2d2e1ac23455bd7825fbd4861eef5c9", + "sendID": "1126971029", + "recvID": "5855361412", + "groupID": "", + "recvNickname": "客人", + "senderPlatformID": 2, + "senderNickname": "ss", + "senderFaceURL": "", + "groupName": "", + "sessionType": 1, + "msgFrom": 100, + "contentType": 101, + "content": "{\"content\":\"毕不男不女\"}", + "status": 1, + "sendTime": 1690512458446, + "createTime": 1690512457729, + "ex": "", + "groupFaceURL": "", + "groupMemberCount": 0, + "seq": 2, + "groupOwner": "", + "groupType": 0 + }, + { + "serverMsgID": "6f8cb2cf9beb596325b89e4e8b813650", + "clientMsgID": "8a8c463c0c130b0ed05227acc7ce2cf9", + "sendID": "1126971029", + "recvID": "5855361412", + "groupID": "", + "recvNickname": "客人", + "senderPlatformID": 2, + "senderNickname": "ss", + "senderFaceURL": "", + "groupName": "", + "sessionType": 1, + "msgFrom": 100, + "contentType": 101, + "content": "{\"content\":\"bb\"}", + "status": 1, + "sendTime": 1690512524528, + "createTime": 1690512523907, + "ex": "", + "groupFaceURL": "", + "groupMemberCount": 0, + "seq": 3, + "groupOwner": "", + "groupType": 0 + }, + { + "serverMsgID": "f8829a0afa37f4b563ce1061742c3f78", + "clientMsgID": "c579ea3186f37bc145c9987e919f6680", + "sendID": "1126971029", + "recvID": "5855361412", + "groupID": "", + "recvNickname": "客人", + "senderPlatformID": 2, + "senderNickname": "ss你", + "senderFaceURL": "", + "groupName": "", + "sessionType": 1, + "msgFrom": 100, + "contentType": 101, + "content": "{\"content\":\"想\"}", + "status": 1, + "sendTime": 1690513211341, + "createTime": 1690513210724, + "ex": "", + "groupFaceURL": "", + "groupMemberCount": 0, + "seq": 4, + "groupOwner": "", + "groupType": 0 + }, + { + "serverMsgID": "ec39d9d243f947be8e13e90214856ff1", + "clientMsgID": "51ccebee0b33c715c955681d5efeac56", + "sendID": "1126971029", + "recvID": "5855361412", + "groupID": "", + "recvNickname": "客人", + "senderPlatformID": 2, + "senderNickname": "的ss你我", + "senderFaceURL": "http://43.154.157.177:10002/object/1126971029/data/user/0/cn.rentsoft.openim.flutter.base.open/cache/image_cropper_1690513226705.jpg", + "groupName": "", + "sessionType": 1, + "msgFrom": 100, + "contentType": 2101, + "content": "{\"detail\":\"{\\\"revokerID\\\":\\\"1126971029\\\",\\\"revokerRole\\\":0,\\\"clientMsgID\\\":\\\"51ccebee0b33c715c955681d5efeac56\\\",\\\"revokerNickname\\\":\\\"的ss你我\\\",\\\"revokeTime\\\":1690536346006,\\\"sourceMessageSendTime\\\":1690513240525,\\\"sourceMessageSendID\\\":\\\"1126971029\\\",\\\"sourceMessageSenderNickname\\\":\\\"的ss你我\\\",\\\"sessionType\\\":1,\\\"seq\\\":5,\\\"ex\\\":\\\"\\\"}\"}", + "status": 1, + "sendTime": 1690513240525, + "createTime": 1690513239901, + "ex": "", + "groupFaceURL": "", + "groupMemberCount": 0, + "seq": 5, + "groupOwner": "", + "groupType": 0 + }, + { + "serverMsgID": "c883f338179325de9f5e1ba5e584e18d", + "clientMsgID": "3ebb0d9f681745c56dafd3d916c3a705", + "sendID": "5855361412", + "recvID": "1126971029", + "groupID": "", + "recvNickname": "", + "senderPlatformID": 0, + "senderNickname": "客人", + "senderFaceURL": "", + "groupName": "", + "sessionType": 1, + "msgFrom": 200, + "contentType": 1201, + "content": "{\"detail\":\"{\\\"fromToUserID\\\":{\\\"fromUserID\\\":\\\"1126971029\\\",\\\"toUserID\\\":\\\"5855361412\\\"},\\\"handleMsg\\\":\\\"\\\"}\"}", + "status": 0, + "sendTime": 1690513340454, + "createTime": 1690513340453, + "ex": "", + "groupFaceURL": "", + "groupMemberCount": 0, + "seq": 6, + "groupOwner": "", + "groupType": 0 + }, + { + "serverMsgID": "2f2123345ba26a31188e9e081554fea3", + "clientMsgID": "7ff238c5ff23c641e3c7135a10a9ccaf", + "sendID": "5855361412", + "recvID": "1126971029", + "groupID": "", + "recvNickname": "", + "senderPlatformID": 0, + "senderNickname": "客人", + "senderFaceURL": "", + "groupName": "", + "sessionType": 1, + "msgFrom": 200, + "contentType": 1201, + "content": "{\"detail\":\"{\\\"fromToUserID\\\":{\\\"fromUserID\\\":\\\"1126971029\\\",\\\"toUserID\\\":\\\"5855361412\\\"},\\\"handleMsg\\\":\\\"\\\"}\"}", + "status": 0, + "sendTime": 1690513371446, + "createTime": 1690513371446, + "ex": "", + "groupFaceURL": "", + "groupMemberCount": 0, + "seq": 7, + "groupOwner": "", + "groupType": 0 + }, + { + "serverMsgID": "54f7f33b3ab76d3cd8b4391ff3210cf7", + "clientMsgID": "c11f59a6672732f3c8fde5012ee6af41", + "sendID": "1126971029", + "recvID": "5855361412", + "groupID": "", + "recvNickname": "客人", + "senderPlatformID": 2, + "senderNickname": "的ss你我", + "senderFaceURL": "http://43.154.157.177:10002/object/1126971029/data/user/0/cn.rentsoft.openim.flutter.base.open/cache/image_cropper_1690513226705.jpg", + "groupName": "", + "sessionType": 1, + "msgFrom": 100, + "contentType": 101, + "content": "{\"content\":\"bbbb\"}", + "status": 1, + "sendTime": 1690514316001, + "createTime": 1690514315382, + "ex": "", + "groupFaceURL": "", + "groupMemberCount": 0, + "seq": 8, + "groupOwner": "", + "groupType": 0 + }, + { + "serverMsgID": "aca620a221e01f823a0d439cd48d14db", + "clientMsgID": "468a9eba8e6e0580e68d4f57027b540a", + "sendID": "5855361412", + "recvID": "1126971029", + "groupID": "", + "recvNickname": "的ss你我", + "senderPlatformID": 2, + "senderNickname": "客人", + "senderFaceURL": "", + "groupName": "", + "sessionType": 1, + "msgFrom": 100, + "contentType": 101, + "content": "{\"content\":\"哈哈\"}", + "status": 1, + "sendTime": 1690514787336, + "createTime": 1690514786761, + "ex": "", + "groupFaceURL": "", + "groupMemberCount": 0, + "seq": 9, + "groupOwner": "", + "groupType": 0 + }, + { + "serverMsgID": "75ce151c35eebe59a5ddd614cf04966f", + "clientMsgID": "95c6dca35593d0c6b4d94be25e84bae4", + "sendID": "5855361412", + "recvID": "1126971029", + "groupID": "", + "recvNickname": "的ss你我", + "senderPlatformID": 2, + "senderNickname": "客人", + "senderFaceURL": "", + "groupName": "", + "sessionType": 1, + "msgFrom": 100, + "contentType": 101, + "content": "{\"content\":\"哈哈\"}", + "status": 1, + "sendTime": 1690536911213, + "createTime": 1690536910484, + "ex": "", + "groupFaceURL": "", + "groupMemberCount": 0, + "seq": 10, + "groupOwner": "", + "groupType": 0 + } + ], + "chatLogsNum": 26758 + } +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +|chatLogs|array|| +|chatLogs.serverMsgID|string|服务器消息ID| +|chatLogs.clientMsgID|string|客户端消息ID| +|chatLogs.sendID|string|发送者ID| +|chatLogs.recvID|string|接收者ID| +|chatLogs.groupID|string|群组ID| +|chatLogs.recvNickname|string|接收者昵称| +|chatLogs.senderPlatformID|string|发送者平台| +|chatLogs.senderNickname|string|发送者昵称| +|chatLogs.senderFaceURL|string|发送者头像| +|chatLogs.groupName|string|群名称| +|chatLogs.sessionType|string|会话类型，发送的消息是单聊还是群聊,单聊为1，群聊（普通写扩散）为2,大群(读扩散接口)为3，通知会话为4| +|chatLogs.msgFrom|string|消息来源，100来源于用户发送，200来源于管理员发送或者系统广播通知等| +|chatLogs.contentType|string|消息类型，101表示文本，102表示图片..详细参考消息类型格式描述文档| +|chatLogs.content|string|内容| +|chatLogs.status|string|消息状态| +|chatLogs.sendTime|string|发送时间| +|chatLogs.createTime|string|创建时间| +|chatLogs.ex|string|扩展字段| +|chatLogs.groupFaceURL|string|群头像| +|chatLogs.groupMemberCount|string|群成员数量| +|chatLogs.seq|string|消息唯一序列号ID| +|chatLogs.groupOwner|string|群主| +|chatLogs.groupType|string|群类型| +|chatLogsNum|string|消息数量| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/commonFields.mdx b/docs/restapi/commonFields.mdx index 0ed19decf5..92c02685e5 100644 --- a/docs/restapi/commonFields.mdx +++ b/docs/restapi/commonFields.mdx @@ -170,7 +170,7 @@ title: 常用结构体说明 | --------------------- | ------- | ------------------ | ------------------------------------------------------------------------- | -------- | | ownerUserID | string | | 会话的拥有者用户 ID | | conversationID | string | | 会话 ID | -| recvMsgOpt | int | | 接收消息参数，0 为接收消息，1 为不接收消息，2 为接收消息但不提醒 | +| recvMsgOpt | int | | 接收消息参数，0 为接收消息，1 为不接收消息，2 为接收消息但不提醒 | | conversationType | int | | 会话类型，1 为单聊，3 为群聊 | | userID | string | | 会话用户 ID，当会话类型为 1 时，此字段生效 | | groupID | string | | 会话的群 ID，当会话类型为 3 时，此字段生效 | From 6074d87ecb90ac537096bf06209230748ec1f07e Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Mon, 19 Aug 2024 17:11:47 +0800 Subject: [PATCH 06/12] remove unnecessary docs. --- .../getFullConversationIDs.mdx | 98 ----- .../getIncrementalConversations.mdx | 172 -------- .../setConversations.mdx | 98 ----- .../getDesignatedFriends.mdx | 102 ----- .../apis/friendsManagement/getFriendId.mdx | 82 ---- .../friendsManagement/getFullFriendUserId.mdx | 99 ----- .../getIncrementalFriends.mdx | 151 ------- .../getFullGroupMemberUserIds.mdx | 98 ----- .../groupManagement/getFullJoinGroupIds.mdx | 89 ----- .../getIncrementalGroupMembers.mdx | 131 ------- .../getIncrementalGroupMembersBatch.mdx | 143 ------- .../getIncrementalJoinGroups.mdx | 135 ------- .../apis/messageManagement/batchSendMsg.mdx | 105 ----- .../apis/messageManagement/searchMsg.mdx | 370 ------------------ 14 files changed, 1873 deletions(-) delete mode 100644 docs/restapi/apis/conversationManagement/getFullConversationIDs.mdx delete mode 100644 docs/restapi/apis/conversationManagement/getIncrementalConversations.mdx delete mode 100644 docs/restapi/apis/conversationManagement/setConversations.mdx delete mode 100644 docs/restapi/apis/friendsManagement/getDesignatedFriends.mdx delete mode 100644 docs/restapi/apis/friendsManagement/getFriendId.mdx delete mode 100644 docs/restapi/apis/friendsManagement/getFullFriendUserId.mdx delete mode 100644 docs/restapi/apis/friendsManagement/getIncrementalFriends.mdx delete mode 100644 docs/restapi/apis/groupManagement/getFullGroupMemberUserIds.mdx delete mode 100644 docs/restapi/apis/groupManagement/getFullJoinGroupIds.mdx delete mode 100644 docs/restapi/apis/groupManagement/getIncrementalGroupMembers.mdx delete mode 100644 docs/restapi/apis/groupManagement/getIncrementalGroupMembersBatch.mdx delete mode 100644 docs/restapi/apis/groupManagement/getIncrementalJoinGroups.mdx delete mode 100644 docs/restapi/apis/messageManagement/batchSendMsg.mdx delete mode 100644 docs/restapi/apis/messageManagement/searchMsg.mdx diff --git a/docs/restapi/apis/conversationManagement/getFullConversationIDs.mdx b/docs/restapi/apis/conversationManagement/getFullConversationIDs.mdx deleted file mode 100644 index a74d529c40..0000000000 --- a/docs/restapi/apis/conversationManagement/getFullConversationIDs.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -sidebar_position: 2 -title: 获取全量会话ID列表 -hide_title: true ---- - -
- -## 获取全量会话ID列表 - -
- -### 简要描述 -- 获取指定用户的全量会话ID列表。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/conversation/get_full_conversation_ids` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - - -### 请求参数示例 - - -```json -{ - "idhash": 3228175501, - "userID": "2268888073" -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|idhash|必填|int|用户ID Hash| -|userID|必填|string|用户ID| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "version": 15804284030727883000, - "versionID": "669a229c3cd5e8fc6530ecb2", - "equal": false, - "conversationIDs": [ - "sg_291798782", - "sg_3187706596", - "sg_570135126", - "si_1695766238_2268888073", - "si_2268888073_2839845469", - "si_2268888073_2882899447", - "si_2268888073_3418577436", - "si_2268888073_4918276559", - "si_2268888073_7497605401", - "si_2268888073_9169530932" - ] - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|version|string|ID Hash| -|versionID|string|当前版本表ID| -|equal|string|Hash 是否相等| -|conversationIDs|string|会话ID列表| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/conversationManagement/getIncrementalConversations.mdx b/docs/restapi/apis/conversationManagement/getIncrementalConversations.mdx deleted file mode 100644 index 1ecbb237fd..0000000000 --- a/docs/restapi/apis/conversationManagement/getIncrementalConversations.mdx +++ /dev/null @@ -1,172 +0,0 @@ ---- -sidebar_position: 3 -title: 获取增量会话列表 -hide_title: true ---- - -
- -## 获取增量会话列表 - -
- -### 简要描述 -- 获取指定用户的指定版本间的会话变化列表。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/conversation/get_incremental_conversations` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - - - -### 请求参数示例 - - -```json -{ - "userID": "4084688351", - "versionID": "669a20773cd5e8fc6530ec99", - "version": 10 -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|userID|必填|string|用户ID| -|versionID|必填|string|会话增量版本表ID| -|version|必填|string|当前版本号| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "version": 18, - "versionID": "669a20773cd5e8fc6530ec99", - "full": false, - "delete": null, - "insert": [ - { - "ownerUserID": "4084688351", - "conversationID": "sg_570135126", - "recvMsgOpt": 0, - "conversationType": 3, - "userID": "", - "groupID": "570135126", - "isPinned": false, - "attachedInfo": "", - "isPrivateChat": false, - "groupAtType": 0, - "ex": "", - "burnDuration": 0, - "minSeq": 0, - "maxSeq": 0, - "msgDestructTime": 0, - "latestMsgDestructTime": -62135596800000, - "isMsgDestruct": false - } - ], - "update": [ - { - "ownerUserID": "4084688351", - "conversationID": "si_2839845469_4084688351", - "recvMsgOpt": 0, - "conversationType": 1, - "userID": "2839845469", - "groupID": "", - "isPinned": false, - "attachedInfo": "", - "isPrivateChat": false, - "groupAtType": 0, - "ex": "", - "burnDuration": 0, - "minSeq": 0, - "maxSeq": 0, - "msgDestructTime": 0, - "latestMsgDestructTime": -62135596800000, - "isMsgDestruct": false - }, - { - "ownerUserID": "4084688351", - "conversationID": "sg_3187706596", - "recvMsgOpt": 0, - "conversationType": 3, - "userID": "", - "groupID": "3187706596", - "isPinned": false, - "attachedInfo": "", - "isPrivateChat": false, - "groupAtType": 0, - "ex": "", - "burnDuration": 0, - "minSeq": 0, - "maxSeq": 0, - "msgDestructTime": 0, - "latestMsgDestructTime": -62135596800000, - "isMsgDestruct": false - }, - { - "ownerUserID": "4084688351", - "conversationID": "sg_291798782", - "recvMsgOpt": 0, - "conversationType": 3, - "userID": "", - "groupID": "291798782", - "isPinned": false, - "attachedInfo": "", - "isPrivateChat": false, - "groupAtType": 4, - "ex": "", - "burnDuration": 0, - "minSeq": 0, - "maxSeq": 0, - "msgDestructTime": 0, - "latestMsgDestructTime": -62135596800000, - "isMsgDestruct": false - } - ] - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|version|string|群组增量版本表| -|versionID|string|当前版本号| -|full|boolean|是否全量同步| -|delete|string|被删除群成员ID列表| -|insert|array|插入的[会话](docs/restapi/commonFields.mdx#conversationinfo)列表| -|update|array|更新的[会话](docs/restapi/commonFields.mdx#conversationinfo)列表| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/conversationManagement/setConversations.mdx b/docs/restapi/apis/conversationManagement/setConversations.mdx deleted file mode 100644 index 1d298211fd..0000000000 --- a/docs/restapi/apis/conversationManagement/setConversations.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -sidebar_position: 7 -title: 多个用户对同一会话设置字段 -hide_title: true ---- - -
- -## 多个用户对同一会话设置字段 - -
- -### 简要描述 -- 多个用户对同一会话可选择性的设置字段。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/conversation/set_conversations` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - - -### 请求参数示例 - - -```json -{ - "userIDs": [ - "6965946400" - ], - "conversation": { - "conversationID": "si_4365007572_6965946400", - "conversationType": 1, - "userID": "4365007572", - "groupID": "", - "recvMsgOpt": 0, - "isPinned": false, - "isPrivateChat": true, - "ex": "", - "burnDuration": 30 - } -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|userIDs|必填|array|要设置会话字段的用户ID列表| -|conversation|必填|object|会话对象| -|conversation.conversationID|必填|string|会话ID| -|conversation.conversationType|必填|int|会话类型，单聊为1，群聊为3| -|conversation.userID|选填|string|会话类型为单聊时必填| -|conversation.groupID|选填|string|会话类型为群聊时必填| -|conversation.recvMsgOpt|选填|int|会话免打扰状态| -|conversation.isPinned|选填|boolean|会话是否置顶| -|conversation.isPrivateChat|选填|boolean|是否开启阅后即焚| -|conversation.ex|选填|string|会话扩展字段| -|conversation.burnDuration|选填|string|设置会话阅后即焚时间，单位秒| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "" -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/friendsManagement/getDesignatedFriends.mdx b/docs/restapi/apis/friendsManagement/getDesignatedFriends.mdx deleted file mode 100644 index cc467b9ce8..0000000000 --- a/docs/restapi/apis/friendsManagement/getDesignatedFriends.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -sidebar_position: 5 -title: 获取特定好友列表 -hide_title: true ---- - -
- -## 获取特定好友列表 - -
- -### 简要描述 -- 分页获取指定用户的特定好友列表，如果无结果不返回错误。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/friend/get_designated_friends` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - - -### 请求参数示例 - - -```json -{ - "ownerUserID": "1001978187", - "friendUserIDs": [ - "xxxxxx" - ] -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|ownerUserID|必填|string|指定的用户ID| -|friendUserIDs|必填|object|指定的好友ID列表| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "friendsInfo": [ - { - "ownerUserID": "11000000", - "remark": "", - "createTime": 1695252063, - "friendUser": { - "userID": "11111111", - "nickname": "Your Name", - "faceURL": "Your URL", - "ex": "", - "createTime": 0, - "appMangerLevel": 0, - "globalRecvMsgOpt": 0 - }, - "addSource": 1, - "operatorUserID": "1111111", - "ex": "", - "isPinned": false - } - ] - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|friendsInfo|array|[好友信息](docs/restapi/commonFields.mdx#friendinfo)列表| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/friendsManagement/getFriendId.mdx b/docs/restapi/apis/friendsManagement/getFriendId.mdx deleted file mode 100644 index 39e3cb100a..0000000000 --- a/docs/restapi/apis/friendsManagement/getFriendId.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -sidebar_position: 6 -title: 获取好友ID列表 -hide_title: true ---- - -
- -## 获取好友ID列表 - -
- -### 简要描述 -- 获取指定用户的好友ID列表。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/friend/get_friend_id` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - - -### 请求参数示例 - - -```json -{ - "userID": "1231233" -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|userID|必填|string|用户ID| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "friendIDs": [ - "1111111", - "2222222" - ] - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|friendIDs|string|好友ID列表| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/friendsManagement/getFullFriendUserId.mdx b/docs/restapi/apis/friendsManagement/getFullFriendUserId.mdx deleted file mode 100644 index 40574f2ebf..0000000000 --- a/docs/restapi/apis/friendsManagement/getFullFriendUserId.mdx +++ /dev/null @@ -1,99 +0,0 @@ ---- -sidebar_position: 8 -title: 获取全量好友ID列表 -hide_title: true ---- - -
- -## 获取全量好友ID列表 - -
- -### 简要描述 -- 获取指定用户的全量好友ID列表。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/friend/get_full_friend_user_ids` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - - -### 请求参数示例 - - -```json -{ -"idhash":123123, - "userID": "5099153716" -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|idhash|必填|int|用户id Hash| -|userID|必填|string|用户ID| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "version": 16201896299926272000, - "versionID": "66a1bf782429d1e700ee3789", - "equal": false, - "userIDs": [ - "1695766238", - "2725451243", - "2839845469", - "2882899447", - "3418577436", - "5292156665", - "5668985363", - "7497605401", - "9169530932", - "4918276559", - "5620768201" - ] - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|version|string|ID Hash| -|versionID|string|当前版本表ID| -|equal|string|Hash 是否相等| -|userIDs|array|好友ID列表| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/friendsManagement/getIncrementalFriends.mdx b/docs/restapi/apis/friendsManagement/getIncrementalFriends.mdx deleted file mode 100644 index 7b3d5cbea5..0000000000 --- a/docs/restapi/apis/friendsManagement/getIncrementalFriends.mdx +++ /dev/null @@ -1,151 +0,0 @@ ---- -sidebar_position: 7 -title: 获取增量好友列表 -hide_title: true ---- - -
- -## 获取增量好友列表 - -
- -### 简要描述 -- 获取指定用户的指定版本间的好友变化列表。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/friend/get_incremental_friends` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - - - -### 请求参数示例 - - -```json -{ - "userID": "advzxc123", - "versionID": "123321", - "version": 1 -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|userID|必填|string|用户ID| -|versionID|必填|string|好友增量版本表ID| -|version|必填|string|当前版本号| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "version": 48, - "versionID": "669a20774e3031f1220d0188", - "full": false, - "delete": null, - "insert": null, - "update": [ - { - "ownerUserID": "4084688351", - "remark": "", - "createTime": 1721376887, - "friendUser": { - "userID": "2839845469", - "nickname": "OpenIM-Kevln", - "faceURL": "https://web.rentsoft.cn/api_enterprise/object/2839845469/1551721111119_.pic.webp", - "ex": "", - "createTime": 0, - "appMangerLevel": 0, - "globalRecvMsgOpt": 0 - }, - "addSource": 1, - "operatorUserID": "1721376886813", - "ex": "", - "isPinned": false - }, - { - "ownerUserID": "4084688351", - "remark": "", - "createTime": 1721376887, - "friendUser": { - "userID": "3418577436", - "nickname": "OpenIM-skiffer", - "faceURL": "https://web.rentsoft.cn/api_enterprise/object/3418577436/BD14C2C1956AB2E1BD8A9F33E76220BE (1).jpg", - "ex": "", - "createTime": 0, - "appMangerLevel": 0, - "globalRecvMsgOpt": 0 - }, - "addSource": 1, - "operatorUserID": "1721376886813", - "ex": "", - "isPinned": false - }, - { - "ownerUserID": "4084688351", - "remark": "", - "createTime": 1721376887, - "friendUser": { - "userID": "7497605401", - "nickname": "Jane-", - "faceURL": "https://web.rentsoft.cn/api_enterprise/object/7497605401/微信截图_20240709181242.webp", - "ex": "", - "createTime": 0, - "appMangerLevel": 0, - "globalRecvMsgOpt": 0 - }, - "addSource": 1, - "operatorUserID": "1721376886813", - "ex": "", - "isPinned": false - } - ], - "sortVersion": 0 - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|version|string|| -|versionID|string|| -|full|boolean|是否全量同步| -|delete|string|被删除ID列表| -|insert|array|插入的[好友信息](docs/restapi/commonFields.mdx#friendinfo)列表| -|update|array|更新的[好友信息](docs/restapi/commonFields.mdx#friendinfo)列表| -|sortVersion|string|如果大于0，则需要全量获取排序| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/groupManagement/getFullGroupMemberUserIds.mdx b/docs/restapi/apis/groupManagement/getFullGroupMemberUserIds.mdx deleted file mode 100644 index b8064752ec..0000000000 --- a/docs/restapi/apis/groupManagement/getFullGroupMemberUserIds.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -sidebar_position: 4 -title: 获取全量群成员ID列表 -hide_title: true ---- - -
- -## 获取全量群成员ID列表 - -
- -### 简要描述 -- 获取指定群的全量群成员ID列表。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/group/get_full_group_member_user_ids` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - -### 请求参数示例 - - -```json -{ - "idhash": 3228175501, - "groupID": "3228175501" -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|idhash|必填|int|群id Hash| -|groupID|必填|string|群ID| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "version": 16201896299926272000, - "versionID": "66a1bf782429d1e700ee3789", - "equal": false, - "userIDs": [ - "1695766238", - "2725451243", - "2839845469", - "2882899447", - "3418577436", - "5292156665", - "5668985363", - "7497605401", - "9169530932", - "4918276559", - "5620768201" - ] - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|version|string|ID Hash| -|versionID|string|当前版本表ID| -|equal|string|Hash 是否相等| -|userIDs|array|群成员ID列表| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/groupManagement/getFullJoinGroupIds.mdx b/docs/restapi/apis/groupManagement/getFullJoinGroupIds.mdx deleted file mode 100644 index 35e5243dd4..0000000000 --- a/docs/restapi/apis/groupManagement/getFullJoinGroupIds.mdx +++ /dev/null @@ -1,89 +0,0 @@ ---- -sidebar_position: 5 -title: 获取全量已加入群组ID列表 -hide_title: true ---- - -
- -## 获取全量已加入群组ID列表 - -
- -### 简要描述 -- 获取指定用户的全量已加入群ID列表。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/group/get_full_join_group_ids` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - -### 请求参数示例 - - -```json -{ - "idhash": 3228175501, - "userID": "2268888073" -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|idhash|必填|int|用户ID Hash| -|userID|必填|string|用户ID| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "version": 11285559722339189000, - "versionID": "669a229cbd218dbf9196e89d", - "equal": false, - "groupIDs": [ - "3187706596", - "291798782" - ] - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|version|string|ID Hash| -|versionID|string|当前版本表ID| -|equal|string|Hash 是否相等| -|groupIDs|array|已加入群ID列表| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/groupManagement/getIncrementalGroupMembers.mdx b/docs/restapi/apis/groupManagement/getIncrementalGroupMembers.mdx deleted file mode 100644 index 1b24cad482..0000000000 --- a/docs/restapi/apis/groupManagement/getIncrementalGroupMembers.mdx +++ /dev/null @@ -1,131 +0,0 @@ ---- -sidebar_position: 7 -title: 获取增量群成员列表 -hide_title: true ---- - -
- -## 获取增量群成员列表 - -
- -### 简要描述 -- 获取指定群组的指定版本间的群成员变化列表。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/group/get_incremental_group_members` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - - -### 请求参数示例 - - -```json -{ - "groupID": "3416772962", - "versionID": "669a211abd218dbf9196e884", - "version": 20 -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|groupID|必填|string|群组ID| -|versionID|必填|string|群增量版本表ID| -|version|必填|string|当前版本号| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "version": 25, - "versionID": "669a211abd218dbf9196e884", - "full": false, - "delete": null, - "insert": null, - "update": [ - { - "groupID": "3416772962", - "userID": "7497605401", - "roleLevel": 20, - "joinTime": 1709774772037, - "nickname": "Jane-", - "faceURL": "https://web.rentsoft.cn/api_enterprise/object/7497605401/微信截图_20240709181242.webp", - "appMangerLevel": 0, - "joinSource": 2, - "operatorUserID": "8941452423", - "ex": "", - "muteEndTime": 0, - "inviterUserID": "8941452423" - } - ], - "group": { - "groupID": "3416772962", - "groupName": "工作群1", - "notification": "", - "introduction": "", - "faceURL": "", - "ownerUserID": "8941452423", - "createTime": 1709774772036, - "memberCount": 3, - "ex": "", - "status": 0, - "creatorUserID": "8941452423", - "groupType": 2, - "needVerification": 0, - "lookMemberInfo": 0, - "applyMemberFriend": 0, - "notificationUpdateTime": 0, - "notificationUserID": "", - "displayIsRead": true - }, - "sortVersion": 0 - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|version|string|群组增量版本表| -|versionID|string|当前版本号| -|full|boolean|是否全量同步| -|delete|string|被删除群成员ID列表| -|insert|array|插入的[群成员信息](docs/restapi/commonFields.mdx#groupmemberinfo)列表| -|update|array|更新的[群成员信息](docs/restapi/commonFields.mdx#groupmemberinfo)列表| -|group|object|[群信息](docs/restapi/commonFields.mdx#groupinfo)列表| -|sortVersion|string|如果大于0，则需要全量获取排序| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/groupManagement/getIncrementalGroupMembersBatch.mdx b/docs/restapi/apis/groupManagement/getIncrementalGroupMembersBatch.mdx deleted file mode 100644 index 7eaba3f2c7..0000000000 --- a/docs/restapi/apis/groupManagement/getIncrementalGroupMembersBatch.mdx +++ /dev/null @@ -1,143 +0,0 @@ ---- -sidebar_position: 9 -title: 批量获取增量群成员列表 -hide_title: true ---- - -
- -## 批量获取增量群成员列表 - -
- -### 简要描述 -- 批量获取指定群组的指定版本间的群成员变化列表。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/group/get_incremental_group_members_batch` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - - -### 请求参数示例 - - -```json -{ - "userID": "7497605401", - "reqList": [ - { - "groupID": "3416772962", - "versionID": "669a211abd218dbf9196e884", - "version": 20 - } - ] -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|userID|必填|string|用户ID| -|reqList|必填|array|批量获取增量群成员的请求列表| -|reqList.groupID|必填|string|群ID| -|reqList.versionID|必填|string|群增量版本表ID| -|reqList.version|必填|string|增量版本号| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "respList": { - "3416772962": { - "version": 25, - "versionID": "669a211abd218dbf9196e884", - "full": false, - "delete": null, - "insert": null, - "update": [ - { - "groupID": "3416772962", - "userID": "7497605401", - "roleLevel": 20, - "joinTime": 1709774772037, - "nickname": "Jane-", - "faceURL": "https://web.rentsoft.cn/api_enterprise/object/7497605401/微信截图_20240709181242.webp", - "appMangerLevel": 0, - "joinSource": 2, - "operatorUserID": "8941452423", - "ex": "", - "muteEndTime": 0, - "inviterUserID": "8941452423" - } - ], - "group": { - "groupID": "3416772962", - "groupName": "工作群1", - "notification": "", - "introduction": "", - "faceURL": "", - "ownerUserID": "8941452423", - "createTime": 1709774772036, - "memberCount": 3, - "ex": "", - "status": 0, - "creatorUserID": "8941452423", - "groupType": 2, - "needVerification": 0, - "lookMemberInfo": 0, - "applyMemberFriend": 0, - "notificationUpdateTime": 0, - "notificationUserID": "", - "displayIsRead": true - }, - "sortVersion": 0 - } - } - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|respList|object|批量获取增量群成员的响应列表| -|respList.version|string|增量版本号| -|respList.versionID|string|群成员增量版本表| -|respList.full|string|是否全量同步| -|respList.delete|object|被删除群成员ID列表| -|respList.insert|object|插入的[群成员信息](docs/restapi/commonFields.mdx#groupmemberinfo)列表| -|respList.update|array|更新的[群成员信息](docs/restapi/commonFields.mdx#groupmemberinfo)列表| -|respList.group|object|[群信息](docs/restapi/commonFields.mdx#groupinfo)列表| -|respList.sortVersion|string|如果大于0，则需要全量获取排序| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/groupManagement/getIncrementalJoinGroups.mdx b/docs/restapi/apis/groupManagement/getIncrementalJoinGroups.mdx deleted file mode 100644 index a948f5f990..0000000000 --- a/docs/restapi/apis/groupManagement/getIncrementalJoinGroups.mdx +++ /dev/null @@ -1,135 +0,0 @@ ---- -sidebar_position: 8 -title: 获取增量已加入群组列表 -hide_title: true ---- - -
- -## 获取增量已加入群组列表 - -
- -### 简要描述 -- 获取指定用户的指定版本间的已加入群组变化列表。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/group/get_incremental_join_groups` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - -### 请求参数示例 - - -```json -{ - "userID": "8460878932", - "versionID": "669a2667bd218dbf9196e8c4", - "version": 3 -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|userID|必填|string|用户ID| -|versionID|必填|string|群增量版本表ID| -|version|必填|string|当前版本号| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "version": 5, - "versionID": "669a2667bd218dbf9196e8c4", - "full": false, - "delete": null, - "insert": [ - { - "groupID": "3793971726", - "groupName": "000000000000", - "notification": "", - "introduction": "", - "faceURL": "", - "ownerUserID": "8460878932", - "createTime": 1721380274393, - "memberCount": 4, - "ex": "", - "status": 0, - "creatorUserID": "8460878932", - "groupType": 2, - "needVerification": 0, - "lookMemberInfo": 0, - "applyMemberFriend": 0, - "notificationUpdateTime": 0, - "notificationUserID": "", - "displayIsRead": true - }, - { - "groupID": "2244016122", - "groupName": "11", - "notification": "", - "introduction": "", - "faceURL": "", - "ownerUserID": "4500796576", - "createTime": 1721994729129, - "memberCount": 3, - "ex": "", - "status": 0, - "creatorUserID": "4500796576", - "groupType": 2, - "needVerification": 0, - "lookMemberInfo": 0, - "applyMemberFriend": 0, - "notificationUpdateTime": 0, - "notificationUserID": "", - "displayIsRead": true - } - ], - "update": null, - "sortVersion": 0 - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|version|string|群组增量版本表| -|versionID|string|当前版本号| -|full|boolean|是否全量同步| -|delete|string|被删除群ID列表| -|insert|array|插入的[群组信息](docs/restapi/commonFields.mdx#groupinfo)列表| -|update|array|更新的[群组信息](docs/restapi/commonFields.mdx#groupinfo)列表| -|sortVersion|string|如果大于0，则需要全量获取排序| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/messageManagement/batchSendMsg.mdx b/docs/restapi/apis/messageManagement/batchSendMsg.mdx deleted file mode 100644 index 326d4b974a..0000000000 --- a/docs/restapi/apis/messageManagement/batchSendMsg.mdx +++ /dev/null @@ -1,105 +0,0 @@ ---- -sidebar_position: 13 -title: 批量发送消息 -hide_title: true ---- - -
- -## 批量发送消息 - -
- -### 简要描述 -- 批量发送消息。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/msg/batch_send_msg` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - - -### 请求参数示例 - - -```json -{ - "sendID": "openIMAdmin", - "senderNickname": "Gordon", - "senderFaceURL": "http://www.head.com", - "senderPlatformID": 1, - "content": { - "text": "{\"content\":\"hello world!\"}" - }, - "contentType": 101, - "sessionType": 1, - "isOnlineOnly": false, - "notOfflinePush": false, - "offlinePushInfo": { - "title": "send message", - "desc": "", - "ex": "", - "iOSPushSound": "default", - "iOSBadgeCount": true - }, - "isSendAll": true -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|sendID|必填|string|发送者ID(可以为管理员ID，可以为用户ID)| -|recvIDs|选填|array|接收者ID列表，sessionType1或者4，必填，为接收方用户ID，如果是群聊则不填| -|senderNickname|选填|string|发送者昵称| -|senderFaceURL|选填|string|发送者头像| -|senderPlatformID|选填|int|发送者平台号，模拟用户发送时填写， 1->IOS,2->Android,3->Windows,4->OSX,5->Web,5->MiniWeb,7->Linux,8->AndroidPad,9->IPad| -|content|必填|object|消息的具体内容，内部是json 对象，其他消息的详细字段请参考消息类型格式描述文档| -|contentType|必填|int|消息类型，101表示文本，102表示图片..详细参考消息类型格式描述文档| -|sessionType|必填|int|会话类型，发送的消息是单聊还是群聊,单聊为1，群聊（普通写扩散）为2,大群(读扩散接口)为3，通知会话为4| -|isOnlineOnly|选填|boolean|该字段设置为true时候，发送的消息服务器不会存储，接收者在线才会收到，不在线该消息丢失| -|notOfflinePush|选填|string|该字段设置为true时候，发送的消息在用户离线时将不会进行离线推送| -|offlinePushInfo|选填|object|离线推送的具体内容，如果不填写，使用服务器默认推送标题| -|offlinePushInfo.title|选填|string|推送的标题| -|offlinePushInfo.desc|选填|string|推送的具体描述| -|offlinePushInfo.ex|选填|string|扩展字段| -|offlinePushInfo.iOSPushSound|选填|string|IOS的推送声音| -|offlinePushInfo.iOSBadgeCount|选填|string|IOS推送消息是否计入桌面图标未读数| -|isSendAll|选填|boolean|是否发送给全部人| -### 成功返回示例 - - -```json - -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/docs/restapi/apis/messageManagement/searchMsg.mdx b/docs/restapi/apis/messageManagement/searchMsg.mdx deleted file mode 100644 index 5cb30e0329..0000000000 --- a/docs/restapi/apis/messageManagement/searchMsg.mdx +++ /dev/null @@ -1,370 +0,0 @@ ---- -sidebar_position: 12 -title: 查询消息 -hide_title: true ---- - -
- -## 查询消息 - -
- -### 简要描述 -- 搜索消息，支持分页。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/msg/search_msg` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - - -### 请求参数示例 - - -```json -{ - "sendID": "", - "recvID": "", - "msgType": 0, - "sendTime": "", - "sessionType": 1, - "pagination": { - "pagenumber": 1, - "showNumber": 10 - } -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|sendID|选填|string|发送者ID| -|recvID|选填|string|接收者ID| -|msgType|选填|string|消息类型| -|sendTime|选填|string|发送时间| -|sessionType|选填|string|会话类型| -|pagination|必填|object|| -|pagination.pagenumber|必填|string|分页 0开始| -|pagination.showNumber|必填|string|每页数量| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "chatLogs": [ - { - "serverMsgID": "946db72dccc4dd74e2831e0dd7f5bf1e", - "clientMsgID": "016159d9684fa181c525afd06d0f8cc7", - "sendID": "5855361412", - "recvID": "1126971029", - "groupID": "", - "recvNickname": "的ss你我", - "senderPlatformID": 0, - "senderNickname": "客人", - "senderFaceURL": "", - "groupName": "", - "sessionType": 1, - "msgFrom": 200, - "contentType": 1201, - "content": "{\"detail\":\"{\\\"fromToUserID\\\":{\\\"fromUserID\\\":\\\"1126971029\\\",\\\"toUserID\\\":\\\"5855361412\\\"},\\\"handleMsg\\\":\\\"\\\"}\"}", - "status": 0, - "sendTime": 1690459824302, - "createTime": 1690459824301, - "ex": "", - "groupFaceURL": "", - "groupMemberCount": 0, - "seq": 1, - "groupOwner": "", - "groupType": 0 - }, - { - "serverMsgID": "fc956b77f1e7474fa7957ad864af56fb", - "clientMsgID": "c2d2e1ac23455bd7825fbd4861eef5c9", - "sendID": "1126971029", - "recvID": "5855361412", - "groupID": "", - "recvNickname": "客人", - "senderPlatformID": 2, - "senderNickname": "ss", - "senderFaceURL": "", - "groupName": "", - "sessionType": 1, - "msgFrom": 100, - "contentType": 101, - "content": "{\"content\":\"毕不男不女\"}", - "status": 1, - "sendTime": 1690512458446, - "createTime": 1690512457729, - "ex": "", - "groupFaceURL": "", - "groupMemberCount": 0, - "seq": 2, - "groupOwner": "", - "groupType": 0 - }, - { - "serverMsgID": "6f8cb2cf9beb596325b89e4e8b813650", - "clientMsgID": "8a8c463c0c130b0ed05227acc7ce2cf9", - "sendID": "1126971029", - "recvID": "5855361412", - "groupID": "", - "recvNickname": "客人", - "senderPlatformID": 2, - "senderNickname": "ss", - "senderFaceURL": "", - "groupName": "", - "sessionType": 1, - "msgFrom": 100, - "contentType": 101, - "content": "{\"content\":\"bb\"}", - "status": 1, - "sendTime": 1690512524528, - "createTime": 1690512523907, - "ex": "", - "groupFaceURL": "", - "groupMemberCount": 0, - "seq": 3, - "groupOwner": "", - "groupType": 0 - }, - { - "serverMsgID": "f8829a0afa37f4b563ce1061742c3f78", - "clientMsgID": "c579ea3186f37bc145c9987e919f6680", - "sendID": "1126971029", - "recvID": "5855361412", - "groupID": "", - "recvNickname": "客人", - "senderPlatformID": 2, - "senderNickname": "ss你", - "senderFaceURL": "", - "groupName": "", - "sessionType": 1, - "msgFrom": 100, - "contentType": 101, - "content": "{\"content\":\"想\"}", - "status": 1, - "sendTime": 1690513211341, - "createTime": 1690513210724, - "ex": "", - "groupFaceURL": "", - "groupMemberCount": 0, - "seq": 4, - "groupOwner": "", - "groupType": 0 - }, - { - "serverMsgID": "ec39d9d243f947be8e13e90214856ff1", - "clientMsgID": "51ccebee0b33c715c955681d5efeac56", - "sendID": "1126971029", - "recvID": "5855361412", - "groupID": "", - "recvNickname": "客人", - "senderPlatformID": 2, - "senderNickname": "的ss你我", - "senderFaceURL": "http://43.154.157.177:10002/object/1126971029/data/user/0/cn.rentsoft.openim.flutter.base.open/cache/image_cropper_1690513226705.jpg", - "groupName": "", - "sessionType": 1, - "msgFrom": 100, - "contentType": 2101, - "content": "{\"detail\":\"{\\\"revokerID\\\":\\\"1126971029\\\",\\\"revokerRole\\\":0,\\\"clientMsgID\\\":\\\"51ccebee0b33c715c955681d5efeac56\\\",\\\"revokerNickname\\\":\\\"的ss你我\\\",\\\"revokeTime\\\":1690536346006,\\\"sourceMessageSendTime\\\":1690513240525,\\\"sourceMessageSendID\\\":\\\"1126971029\\\",\\\"sourceMessageSenderNickname\\\":\\\"的ss你我\\\",\\\"sessionType\\\":1,\\\"seq\\\":5,\\\"ex\\\":\\\"\\\"}\"}", - "status": 1, - "sendTime": 1690513240525, - "createTime": 1690513239901, - "ex": "", - "groupFaceURL": "", - "groupMemberCount": 0, - "seq": 5, - "groupOwner": "", - "groupType": 0 - }, - { - "serverMsgID": "c883f338179325de9f5e1ba5e584e18d", - "clientMsgID": "3ebb0d9f681745c56dafd3d916c3a705", - "sendID": "5855361412", - "recvID": "1126971029", - "groupID": "", - "recvNickname": "", - "senderPlatformID": 0, - "senderNickname": "客人", - "senderFaceURL": "", - "groupName": "", - "sessionType": 1, - "msgFrom": 200, - "contentType": 1201, - "content": "{\"detail\":\"{\\\"fromToUserID\\\":{\\\"fromUserID\\\":\\\"1126971029\\\",\\\"toUserID\\\":\\\"5855361412\\\"},\\\"handleMsg\\\":\\\"\\\"}\"}", - "status": 0, - "sendTime": 1690513340454, - "createTime": 1690513340453, - "ex": "", - "groupFaceURL": "", - "groupMemberCount": 0, - "seq": 6, - "groupOwner": "", - "groupType": 0 - }, - { - "serverMsgID": "2f2123345ba26a31188e9e081554fea3", - "clientMsgID": "7ff238c5ff23c641e3c7135a10a9ccaf", - "sendID": "5855361412", - "recvID": "1126971029", - "groupID": "", - "recvNickname": "", - "senderPlatformID": 0, - "senderNickname": "客人", - "senderFaceURL": "", - "groupName": "", - "sessionType": 1, - "msgFrom": 200, - "contentType": 1201, - "content": "{\"detail\":\"{\\\"fromToUserID\\\":{\\\"fromUserID\\\":\\\"1126971029\\\",\\\"toUserID\\\":\\\"5855361412\\\"},\\\"handleMsg\\\":\\\"\\\"}\"}", - "status": 0, - "sendTime": 1690513371446, - "createTime": 1690513371446, - "ex": "", - "groupFaceURL": "", - "groupMemberCount": 0, - "seq": 7, - "groupOwner": "", - "groupType": 0 - }, - { - "serverMsgID": "54f7f33b3ab76d3cd8b4391ff3210cf7", - "clientMsgID": "c11f59a6672732f3c8fde5012ee6af41", - "sendID": "1126971029", - "recvID": "5855361412", - "groupID": "", - "recvNickname": "客人", - "senderPlatformID": 2, - "senderNickname": "的ss你我", - "senderFaceURL": "http://43.154.157.177:10002/object/1126971029/data/user/0/cn.rentsoft.openim.flutter.base.open/cache/image_cropper_1690513226705.jpg", - "groupName": "", - "sessionType": 1, - "msgFrom": 100, - "contentType": 101, - "content": "{\"content\":\"bbbb\"}", - "status": 1, - "sendTime": 1690514316001, - "createTime": 1690514315382, - "ex": "", - "groupFaceURL": "", - "groupMemberCount": 0, - "seq": 8, - "groupOwner": "", - "groupType": 0 - }, - { - "serverMsgID": "aca620a221e01f823a0d439cd48d14db", - "clientMsgID": "468a9eba8e6e0580e68d4f57027b540a", - "sendID": "5855361412", - "recvID": "1126971029", - "groupID": "", - "recvNickname": "的ss你我", - "senderPlatformID": 2, - "senderNickname": "客人", - "senderFaceURL": "", - "groupName": "", - "sessionType": 1, - "msgFrom": 100, - "contentType": 101, - "content": "{\"content\":\"哈哈\"}", - "status": 1, - "sendTime": 1690514787336, - "createTime": 1690514786761, - "ex": "", - "groupFaceURL": "", - "groupMemberCount": 0, - "seq": 9, - "groupOwner": "", - "groupType": 0 - }, - { - "serverMsgID": "75ce151c35eebe59a5ddd614cf04966f", - "clientMsgID": "95c6dca35593d0c6b4d94be25e84bae4", - "sendID": "5855361412", - "recvID": "1126971029", - "groupID": "", - "recvNickname": "的ss你我", - "senderPlatformID": 2, - "senderNickname": "客人", - "senderFaceURL": "", - "groupName": "", - "sessionType": 1, - "msgFrom": 100, - "contentType": 101, - "content": "{\"content\":\"哈哈\"}", - "status": 1, - "sendTime": 1690536911213, - "createTime": 1690536910484, - "ex": "", - "groupFaceURL": "", - "groupMemberCount": 0, - "seq": 10, - "groupOwner": "", - "groupType": 0 - } - ], - "chatLogsNum": 26758 - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|chatLogs|array|| -|chatLogs.serverMsgID|string|服务器消息ID| -|chatLogs.clientMsgID|string|客户端消息ID| -|chatLogs.sendID|string|发送者ID| -|chatLogs.recvID|string|接收者ID| -|chatLogs.groupID|string|群组ID| -|chatLogs.recvNickname|string|接收者昵称| -|chatLogs.senderPlatformID|string|发送者平台| -|chatLogs.senderNickname|string|发送者昵称| -|chatLogs.senderFaceURL|string|发送者头像| -|chatLogs.groupName|string|群名称| -|chatLogs.sessionType|string|会话类型，发送的消息是单聊还是群聊,单聊为1，群聊（普通写扩散）为2,大群(读扩散接口)为3，通知会话为4| -|chatLogs.msgFrom|string|消息来源，100来源于用户发送，200来源于管理员发送或者系统广播通知等| -|chatLogs.contentType|string|消息类型，101表示文本，102表示图片..详细参考消息类型格式描述文档| -|chatLogs.content|string|内容| -|chatLogs.status|string|消息状态| -|chatLogs.sendTime|string|发送时间| -|chatLogs.createTime|string|创建时间| -|chatLogs.ex|string|扩展字段| -|chatLogs.groupFaceURL|string|群头像| -|chatLogs.groupMemberCount|string|群成员数量| -|chatLogs.seq|string|消息唯一序列号ID| -|chatLogs.groupOwner|string|群主| -|chatLogs.groupType|string|群类型| -|chatLogsNum|string|消息数量| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| From 3dfc70dfd7285455db93dde77d5b34aeeeb2025b Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Mon, 19 Aug 2024 17:23:13 +0800 Subject: [PATCH 07/12] update --- .../setConversations.mdx | 98 +++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 docs/restapi/apis/conversationManagement/setConversations.mdx diff --git a/docs/restapi/apis/conversationManagement/setConversations.mdx b/docs/restapi/apis/conversationManagement/setConversations.mdx new file mode 100644 index 0000000000..1d298211fd --- /dev/null +++ b/docs/restapi/apis/conversationManagement/setConversations.mdx @@ -0,0 +1,98 @@ +--- +sidebar_position: 7 +title: 多个用户对同一会话设置字段 +hide_title: true +--- + +
+ +## 多个用户对同一会话设置字段 + +
+ +### 简要描述 +- 多个用户对同一会话可选择性的设置字段。 +### 请求方式 +- `post` +### 请求URL +- `http://x.x.x.x:10002/conversation/set_conversations` + + +### Header +|header名|示例值|选填|类型|说明| +|:---- |:------- |:--- |---|------ | +|operationID|1646445464564|必填|string|operationID用于全局链路追踪| +|token|eyJhbxxxx3Xs|必填|string|管理员token| + + +### 请求参数示例 + + +```json +{ + "userIDs": [ + "6965946400" + ], + "conversation": { + "conversationID": "si_4365007572_6965946400", + "conversationType": 1, + "userID": "4365007572", + "groupID": "", + "recvMsgOpt": 0, + "isPinned": false, + "isPrivateChat": true, + "ex": "", + "burnDuration": 30 + } +} +``` +|字段名|选填|类型|说明| +|:---- |:------- |:--- |---| +|userIDs|必填|array|要设置会话字段的用户ID列表| +|conversation|必填|object|会话对象| +|conversation.conversationID|必填|string|会话ID| +|conversation.conversationType|必填|int|会话类型，单聊为1，群聊为3| +|conversation.userID|选填|string|会话类型为单聊时必填| +|conversation.groupID|选填|string|会话类型为群聊时必填| +|conversation.recvMsgOpt|选填|int|会话免打扰状态| +|conversation.isPinned|选填|boolean|会话是否置顶| +|conversation.isPrivateChat|选填|boolean|是否开启阅后即焚| +|conversation.ex|选填|string|会话扩展字段| +|conversation.burnDuration|选填|string|设置会话阅后即焚时间，单位秒| +### 成功返回示例 + + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "" +} +``` +### 成功返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,0表示成功| +|errMsg|string|错误简要信息,无错误时为空| +|errDlt|errDlt|错误详细信息,无错误时为空| +|data|object|通用数据对象，具体结构见下方| +### 失败返回示例 + + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` +### 失败返回示例的参数说明 + + +|参数名|类型|说明| +|:---- |:------- |:--- | +|errCode|int|错误码,具体查看全局错误码文档| +|errMsg|string|错误简要信息| +|errDlt|errDlt|错误详细信息| From 76a5548723778c1f420c5db201d3b37be896cd85 Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Mon, 19 Aug 2024 17:43:16 +0800 Subject: [PATCH 08/12] update --- .../getOwnerConversation.mdx | 2 +- .../getOwnerConversation.mdx | 127 ++++++++++++++++++ .../setConversations.mdx | 98 ++++++++++++++ .../friendsManagement/getSentApplication.mdx | 2 +- .../apis/friendsManagement/importFriend.mdx | 2 +- .../friendsManagement/processApplication.mdx | 2 +- .../friendsManagement/sendApplication.mdx | 2 +- .../friendsManagement/updateFriendRemark.mdx | 2 +- .../groupManagement/getGroupMemberUserId.mdx | 86 ++++++++++++ scripts/githooks/commit-msg.sh | 92 ------------- scripts/githooks/pre-commit.sh | 111 --------------- scripts/githooks/pre-push.sh | 119 ---------------- 12 files changed, 317 insertions(+), 328 deletions(-) create mode 100644 i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx create mode 100644 i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/setConversations.mdx create mode 100644 i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/getGroupMemberUserId.mdx delete mode 100644 scripts/githooks/commit-msg.sh delete mode 100644 scripts/githooks/pre-commit.sh delete mode 100644 scripts/githooks/pre-push.sh diff --git a/docs/restapi/apis/conversationManagement/getOwnerConversation.mdx b/docs/restapi/apis/conversationManagement/getOwnerConversation.mdx index 04a144c8a9..a5ed720911 100644 --- a/docs/restapi/apis/conversationManagement/getOwnerConversation.mdx +++ b/docs/restapi/apis/conversationManagement/getOwnerConversation.mdx @@ -449,7 +449,7 @@ hide_title: true |errDlt|errDlt|错误详细信息,无错误时为空| |data|object|通用数据对象，具体结构见下方| |total|string|会话总数| -|conversations|array|(会话](docs/restapi/commonFields.mdx#conversationinfo)列表| +|conversations|array|[会话](docs/restapi/commonFields.mdx#conversationinfo)列表| ### 失败返回示例 diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx new file mode 100644 index 0000000000..e5af280f3a --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx @@ -0,0 +1,127 @@ +--- +sidebar_position: 8 +title: Get Paginated Conversation List for the Current User +hide_title: true +--- + +
+ +## Get Paginated Conversation List for the Current User + +
+ +### Brief Description +- Retrieve the paginated list of conversations for the current user. + +### Request Method +- `post` + +### Request URL +- `http://x.x.x.x:10002/conversation/get_owner_conversation` + +### Header +| Header Name | Example Value | Required | Type | Description | +|:---- |:------- |:--- |---|------ | +| operationID | 1646445464564 | Required | string | The operationID is used for global tracing. | +| token | eyJhbxxxx3Xs | Required | string | Admin token | + +### Request Parameter Example + +```json +{ + "userID": "1008432211", + "pagination": { + "pageNumber": 1, + "showNumber": 20 + } +} +``` + +| Field Name | Required | Type | Description | +|:---- |:------- |:--- |---| +| userID | Required | string | Current user ID. | +| pagination | Required | object | Pagination parameters structure. | +| pagination.pageNumber | Required | string | Current page number, starting from 1. | +| pagination.showNumber | Required | string | Number of records per page. | + +### Successful Response Example + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "total": 38, + "conversations": [ + { + "ownerUserID": "1008432211", + "conversationID": "sg_1012900607", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "1012900607", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 0, + "minSeq": 0, + "maxSeq": 184, + "msgDestructTime": 0, + "latestMsgDestructTime": -62135596800000, + "isMsgDestruct": false + }, + { + "ownerUserID": "1008432211", + "conversationID": "sg_1084800774", + "recvMsgOpt": 0, + "conversationType": 3, + "userID": "", + "groupID": "1084800774", + "isPinned": false, + "attachedInfo": "", + "isPrivateChat": false, + "groupAtType": 0, + "ex": "", + "burnDuration": 30, + "minSeq": 0, + "maxSeq": 0, + "msgDestructTime": 604800, + "latestMsgDestructTime": 1695265099982, + "isMsgDestruct": false + } + ] + } +} +``` + +### Successful Response Parameters Description + +| Parameter Name | Type | Description | +|:---- |:------- |:--- | +| errCode | int | Error code, 0 indicates success. | +| errMsg | string | Brief error message, empty if there is no error. | +| errDlt | string | Detailed error message, empty if there is no error. | +| data | object | Common data object, see below for the specific structure. | +| total | string | Total number of conversations. | +| conversations | array | List of [conversations](docs/restapi/commonFields.mdx#conversationinfo). | + +### Failed Response Example + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` + +### Failed Response Parameters Description + +| Parameter Name | Type | Description | +|:---- |:------- |:--- | +| errCode | int | Error code, refer to the global error code documentation for details. | +| errMsg | string | Brief error message. | +| errDlt | string | Detailed error message. | \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/setConversations.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/setConversations.mdx new file mode 100644 index 0000000000..cc37a9b3dd --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/setConversations.mdx @@ -0,0 +1,98 @@ +--- +sidebar_position: 7 +title: Set Fields for Multiple Users in the Same Conversation +hide_title: true +--- + +
+ +## Set Fields for Multiple Users in the Same Conversation + +
+ +### Brief Description +- Allows multiple users to selectively set fields for the same conversation. + +### Request Method +- `post` + +### Request URL +- `http://x.x.x.x:10002/conversation/set_conversations` + +### Header +| Header Name | Example Value | Required | Type | Description | +|:---- |:------- |:--- |---|------ | +| operationID | 1646445464564 | Required | string | The operationID is used for global tracing. | +| token | eyJhbxxxx3Xs | Required | string | Admin token | + +### Request Parameter Example + +```json +{ + "userIDs": [ + "6965946400" + ], + "conversation": { + "conversationID": "si_4365007572_6965946400", + "conversationType": 1, + "userID": "4365007572", + "groupID": "", + "recvMsgOpt": 0, + "isPinned": false, + "isPrivateChat": true, + "ex": "", + "burnDuration": 30 + } +} +``` + +| Field Name | Required | Type | Description | +|:---- |:------- |:--- |---| +| userIDs | Required | array | List of user IDs for whom the conversation fields will be set. | +| conversation | Required | object | Conversation object. | +| conversation.conversationID | Required | string | Conversation ID. | +| conversation.conversationType | Required | int | Conversation type, 1 for single chat, 3 for group chat. | +| conversation.userID | Optional | string | Required if the conversation type is single chat. | +| conversation.groupID | Optional | string | Required if the conversation type is group chat. | +| conversation.recvMsgOpt | Optional | int | Conversation do-not-disturb status. | +| conversation.isPinned | Optional | boolean | Whether the conversation is pinned. | +| conversation.isPrivateChat | Optional | boolean | Whether the private chat (self-destructing messages) feature is enabled. | +| conversation.ex | Optional | string | Conversation extension field. | +| conversation.burnDuration | Optional | string | Set the self-destruct timer for the conversation, in seconds. | + +### Successful Response Example + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "" +} +``` + +### Successful Response Parameters Description + +| Parameter Name | Type | Description | +|:---- |:------- |:--- | +| errCode | int | Error code, 0 indicates success. | +| errMsg | string | Brief error message, empty if there is no error. | +| errDlt | string | Detailed error message, empty if there is no error. | +| data | object | Common data object, see below for the specific structure. | + +### Failed Response Example + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` + +### Failed Response Parameters Description + +| Parameter Name | Type | Description | +|:---- |:------- |:--- | +| errCode | int | Error code, refer to the global error code documentation for details. | +| errMsg | string | Brief error message. | +| errDlt | string | Detailed error message. | \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/getSentApplication.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/getSentApplication.mdx index e037c96b58..ec141482d5 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/getSentApplication.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/getSentApplication.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 13 title: get_self_friend_apply_list hide_title: true --- diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/importFriend.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/importFriend.mdx index 911f0f8fab..5536c9cfea 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/importFriend.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/importFriend.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 11 title: import_friend hide_title: true --- diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/processApplication.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/processApplication.mdx index 1e1ab092ab..8b23f4e82a 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/processApplication.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/processApplication.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 12 title: add_friend_response hide_title: true --- diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/sendApplication.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/sendApplication.mdx index 93e88c2884..517533b647 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/sendApplication.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/sendApplication.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 10 title: add_friend hide_title: true --- diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/updateFriendRemark.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/updateFriendRemark.mdx index 527aa97f60..a9ab6ea64b 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/updateFriendRemark.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/friendsManagement/updateFriendRemark.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 9 title: set_friend_remark hide_title: true --- diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/getGroupMemberUserId.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/getGroupMemberUserId.mdx new file mode 100644 index 0000000000..d08c8ec86d --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/getGroupMemberUserId.mdx @@ -0,0 +1,86 @@ +--- +sidebar_position: 13 +title: Get Group Member User ID List +hide_title: true +--- + +
+ +## Get Group Member User ID List + +
+ +### Brief Description +- Retrieve the list of user IDs for members of a specified group. + +### Request Method +- `post` + +### Request URL +- `http://x.x.x.x:10002/group/get_group_member_user_id` + +### Header +| Header Name | Example Value | Required | Type | Description | +|:-------------|:-------------------|:---------|:-------|:-----------------------------------------| +| operationID | 1646445464564 | Required | string | operationID is used for global trace tracking | +| token | eyJhbxxxx3Xs | Required | string | Admin token | + +### Request Parameter Example + +```json +{ + "groupID": "1012900607" +} +``` + +| Field Name | Required | Type | Description | +|:-----------|:---------|:-------|:------------| +| groupID | Required | string | Group ID | + +### Successful Response Example + +```json +{ + "errCode": 0, + "errMsg": "", + "errDlt": "", + "data": { + "userIDs": [ + "1029199385", + "1035025841", + "1046238762", + "1695766238", + "8772228740", + "9447003536" + ] + } +} +``` + +### Parameter Explanation for Successful Response + +| Parameter Name | Type | Description | +|:---------------|:-------|:-------------------------------------| +| errCode | int | Error code, 0 indicates success | +| errMsg | string | Brief error message, empty if no error | +| errDlt | errDlt | Detailed error message, empty if no error | +| data | object | Common data object, structure detailed below | +| userIDs | string | List of group member IDs | + +### Failure Response Example + +```json +{ + "errCode": 1004, + "errMsg": "RecordNotFoundError", + "errDlt": ": [1004]RecordNotFoundError" +} +``` + +### Parameter Explanation for Failure Response + +| Parameter Name | Type | Description | +|:---------------|:-------|:--------------------------------------| +| errCode | int | Error code, refer to global error codes documentation | +| errMsg | string | Brief error message | +| errDlt | errDlt | Detailed error message | \ No newline at end of file diff --git a/scripts/githooks/commit-msg.sh b/scripts/githooks/commit-msg.sh deleted file mode 100644 index d2d96645bc..0000000000 --- a/scripts/githooks/commit-msg.sh +++ /dev/null @@ -1,92 +0,0 @@ -#!/usr/bin/env bash -# Copyright © 2023 OpenIMSDK. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# ============================================================================== -# -# Store this file as .git/hooks/commit-msg in your repository in order to -# enforce checking for proper commit message format before actual commits. -# You may need to make the scripts executable by 'chmod +x .git/hooks/commit-msg'. - -# commit-msg use go-gitlint tool, install go-gitlint via `go get github.com/llorllale/go-gitlint/cmd/go-gitlint` -# go-gitlint --msg-file="$1" - -# An example hook scripts to check the commit log message. -# Called by "git commit" with one argument, the name of the file -# that has the commit message. The hook should exit with non-zero -# status after issuing an appropriate message if it wants to stop the -# commit. The hook is allowed to edit the commit message file. - -YELLOW="\e[93m" -GREEN="\e[32m" -RED="\e[31m" -ENDCOLOR="\e[0m" - -printMessage() { - printf "${YELLOW}OpenIM : $1${ENDCOLOR}\n" -} - -printSuccess() { - printf "${GREEN}OpenIM : $1${ENDCOLOR}\n" -} - -printError() { - printf "${RED}OpenIM : $1${ENDCOLOR}\n" -} - -printMessage "Running the OpenIM commit-msg hook." - -# This example catches duplicate Signed-off-by lines. - -test "" = "$(grep '^Signed-off-by: ' "$1" | -sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || { -echo >&2 Duplicate Signed-off-by lines. -exit 1 -} - -# TODO: go-gitlint dir set -OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/../.. -GITLINT_DIR="$OPENIM_ROOT/_output/tools/go-gitlint" - -$GITLINT_DIR \ ---msg-file=$1 \ ---subject-regex="^(build|chore|ci|docs|feat|feature|fix|perf|refactor|revert|style|bot|test)(.*)?:\s?.*" \ ---subject-maxlen=150 \ ---subject-minlen=10 \ ---body-regex=".*" \ ---max-parents=1 - -if [ $? -ne 0 ] -then -if ! command -v $GITLINT_DIR &>/dev/null; then - printError "$GITLINT_DIR not found. Please run 'make tools' OR 'make tools.verify.go-gitlint' make verto install it." -fi -printError "Please fix your commit message to match kubecub coding standards" -printError "https://gist.github.com/cubxxw/126b72104ac0b0ca484c9db09c3e5694#file-githook-md" -exit 1 -fi - -### Add Sign-off-by line to the end of the commit message -# Get local git config -NAME=$(git config user.name) -EMAIL=$(git config user.email) - -# Check if the commit message contains a sign-off line -grep -qs "^Signed-off-by: " "$1" -SIGNED_OFF_BY_EXISTS=$? - -# Add "Signed-off-by" line if it doesn't exist -if [ $SIGNED_OFF_BY_EXISTS -ne 0 ]; then -echo -e "\nSigned-off-by: $NAME <$EMAIL>" >> "$1" -fi \ No newline at end of file diff --git a/scripts/githooks/pre-commit.sh b/scripts/githooks/pre-commit.sh deleted file mode 100644 index d8396b5605..0000000000 --- a/scripts/githooks/pre-commit.sh +++ /dev/null @@ -1,111 +0,0 @@ -#!/usr/bin/env bash -# Copyright © 2023 OpenIMSDK. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# ============================================================================== -# This is a pre-commit hook that ensures attempts to commit files that are -# are larger than $limit to your _local_ repo fail, with a helpful error message. - -# You can override the default limit of 2MB by supplying the environment variable: -# GIT_FILE_SIZE_LIMIT=50000000 git commit -m "test: this commit is allowed file sizes up to 50MB" -# -# ============================================================================== -# - -LC_ALL=C - -local_branch="$(git rev-parse --abbrev-ref HEAD)" -valid_branch_regex="^(main|master|develop|release(-[a-zA-Z0-9._-]+)?)$|(feature|feat|openim|hotfix|test|bug|bot|refactor|revert|ci|cicd|style|)\/[a-z0-9._-]+$|^HEAD$" - -YELLOW="\e[93m" -GREEN="\e[32m" -RED="\e[31m" -ENDCOLOR="\e[0m" - -printMessage() { - printf "${YELLOW}openim : $1${ENDCOLOR}\n" -} - -printSuccess() { - printf "${GREEN}openim : $1${ENDCOLOR}\n" -} - -printError() { - printf "${RED}openim : $1${ENDCOLOR}\n" -} - -printMessage "Running local openim pre-commit hook." - -# flutter format . -# https://gist.github.com/cubxxw/126b72104ac0b0ca484c9db09c3e5694#file-githook-md -# TODO! GIT_FILE_SIZE_LIMIT=50000000 git commit -m "test: this commit is allowed file sizes up to 50MB" -# Maximum file size limit in bytes -limit=${GIT_FILE_SIZE_LIMIT:-2000000} # Default 2MB -limitInMB=$(( $limit / 1000000 )) - -function file_too_large(){ - filename=$0 - filesize=$(( $1 / 2**20 )) - - cat < /dev/null 2>&1 -then - against=HEAD -else - against="$empty_tree" -fi - -# Set split so that for loop below can handle spaces in file names by splitting on line breaks -IFS=' -' - -shouldFail=false -for file in $( git diff-index --cached --name-only $against ); do - file_size=$(([ ! -f $file ] && echo 0) || (ls -la $file | awk '{ print $5 }')) - if [ "$file_size" -gt "$limit" ]; then - printError "File $file is $(( $file_size / 10**6 )) MB, which is larger than our configured limit of $limitInMB MB" - shouldFail=true - fi -done - -if $shouldFail -then - printMessage "If you really need to commit this file, you can override the size limit by setting the GIT_FILE_SIZE_LIMIT environment variable, e.g. GIT_FILE_SIZE_LIMIT=42000000 for 42MB. Or, commit with the --no-verify switch to skip the check entirely." - printError "Commit aborted" - exit 1; -fi - -if [[ ! $local_branch =~ $valid_branch_regex ]] -then - printError "There is something wrong with your branch name. Branch names in this project must adhere to this contract: $valid_branch_regex. -Your commit will be rejected. You should rename your branch to a valid name(feat/name OR fix/name) and try again." - printError "For more on this, read on: https://gist.github.com/cubxxw/126b72104ac0b0ca484c9db09c3e5694" - exit 1 -fi \ No newline at end of file diff --git a/scripts/githooks/pre-push.sh b/scripts/githooks/pre-push.sh deleted file mode 100644 index 9bd9389158..0000000000 --- a/scripts/githooks/pre-push.sh +++ /dev/null @@ -1,119 +0,0 @@ -#!/usr/bin/env bash -# Copyright © 2023 OpenIMSDK. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# ============================================================================== -# - -YELLOW="\e[93m" -GREEN="\e[32m" -RED="\e[31m" -ENDCOLOR="\e[0m" - -local_branch="$(git rev-parse --abbrev-ref HEAD)" -valid_branch_regex="^(main|master|develop|release(-[a-zA-Z0-9._-]+)?)$|(feature|feat|openim|hotfix|test|bug|ci|cicd|style|)\/[a-z0-9._-]+$|^HEAD$" - -printMessage() { - printf "${YELLOW}OpenIM : $1${ENDCOLOR}\n" -} - -printSuccess() { - printf "${GREEN}OpenIM : $1${ENDCOLOR}\n" -} - -printError() { - printf "${RED}OpenIM : $1${ENDCOLOR}\n" -} - -printMessage "Running local OpenIM pre-push hook." - -if [[ $(git status --porcelain) ]]; then - printError "This scripts needs to run against committed code only. Please commit or stash you changes." - exit 1 -fi - -COLOR_SUFFIX="\033[0m" - -BLACK_PREFIX="\033[30m" -RED_PREFIX="\033[31m" -GREEN_PREFIX="\033[32m" -BACKGROUND_GREEN="\033[33m" -BLUE_PREFIX="\033[34m" -PURPLE_PREFIX="\033[35m" -SKY_BLUE_PREFIX="\033[36m" -WHITE_PREFIX="\033[37m" -BOLD_PREFIX="\033[1m" -UNDERLINE_PREFIX="\033[4m" -ITALIC_PREFIX="\033[3m" - -# Function to print colored text -print_color() { - local text=$1 - local color=$2 - echo -e "${color}${text}${COLOR_SUFFIX}" -} - -# Function to print section separator -print_separator() { - print_color "==========================================================" ${PURPLE_PREFIX} -} - -# Get current time -time=$(date +"%Y-%m-%d %H:%M:%S") - -# Print section separator -print_separator - -# Print time of submission -print_color "PTIME: ${time}" "${BOLD_PREFIX}${CYAN_PREFIX}" -echo "" -author=$(git config user.name) -repository=$(basename -s .git $(git config --get remote.origin.url)) - -# Print additional information if needed -print_color "Repository: ${repository}" "${BLUE_PREFIX}" -echo "" - -print_color "Author: ${author}" "${PURPLE_PREFIX}" - -# Print section separator -print_separator - -file_list=$(git diff --name-status HEAD @{u}) -added_files=$(grep -c '^A' <<< "$file_list") -modified_files=$(grep -c '^M' <<< "$file_list") -deleted_files=$(grep -c '^D' <<< "$file_list") - -print_color "Added Files: ${added_files}" "${BACKGROUND_GREEN}" -print_color "Modified Files: ${modified_files}" "${BACKGROUND_GREEN}" -print_color "Deleted Files: ${deleted_files}" "${BACKGROUND_GREEN}" - -if [[ ! $local_branch =~ $valid_branch_regex ]] -then - printError "There is something wrong with your branch name. Branch names in this project must adhere to this contract: $valid_branch_regex. -Your commit will be rejected. You should rename your branch to a valid name(feat/name OR fix/name) and try again." - printError "For more on this, read on: https://gist.github.com/cubxxw/126b72104ac0b0ca484c9db09c3e5694" - exit 1 -fi - -# -#printMessage "Running the Flutter analyzer" -#flutter analyze -# -#if [ $? -ne 0 ]; then -# printError "Flutter analyzer error" -# exit 1 -#fi -# -#printMessage "Finished running the Flutter analyzer" From 8314517d5030078e62cde84d026089695cef0aaa Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Mon, 19 Aug 2024 18:08:47 +0800 Subject: [PATCH 09/12] update --- .../apis/conversationManagement/getOwnerConversation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx index e5af280f3a..9bc5b6042b 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx @@ -106,7 +106,7 @@ hide_title: true | errDlt | string | Detailed error message, empty if there is no error. | | data | object | Common data object, see below for the specific structure. | | total | string | Total number of conversations. | -| conversations | array | List of [conversations](docs/restapi/commonFields.mdx#conversationinfo). | +| conversations | array | List of [conversations](/restapi/commonFields#conversationinfo). | ### Failed Response Example From 7fafb7faa4b8fcd3303658d05a0300dbb2df83fe Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Mon, 19 Aug 2024 18:35:04 +0800 Subject: [PATCH 10/12] update --- .../groupManagement/getGroupMemberUserId.mdx | 85 ------------------- .../getOwnerConversation.mdx | 2 +- 2 files changed, 1 insertion(+), 86 deletions(-) delete mode 100644 docs/restapi/apis/groupManagement/getGroupMemberUserId.mdx diff --git a/docs/restapi/apis/groupManagement/getGroupMemberUserId.mdx b/docs/restapi/apis/groupManagement/getGroupMemberUserId.mdx deleted file mode 100644 index bc5c97de59..0000000000 --- a/docs/restapi/apis/groupManagement/getGroupMemberUserId.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -sidebar_position: 13 -title: 获取群成员用户ID列表 -hide_title: true ---- - -
- -## 获取群成员用户ID列表 - -
- -### 简要描述 -- 获取指定群成员用户的ID列表。 -### 请求方式 -- `post` -### 请求URL -- `http://x.x.x.x:10002/group/get_group_member_user_id` - - -### Header -|header名|示例值|选填|类型|说明| -|:---- |:------- |:--- |---|------ | -|operationID|1646445464564|必填|string|operationID用于全局链路追踪| -|token|eyJhbxxxx3Xs|必填|string|管理员token| - -### 请求参数示例 - - -```json -{ - "groupID": "1012900607" -} -``` -|字段名|选填|类型|说明| -|:---- |:------- |:--- |---| -|groupID|必填|string|群ID| -### 成功返回示例 - - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "userIDs": [ - "1029199385", - "1035025841", - "1046238762", - "1695766238", - "8772228740", - "9447003536" - ] - } -} -``` -### 成功返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,0表示成功| -|errMsg|string|错误简要信息,无错误时为空| -|errDlt|errDlt|错误详细信息,无错误时为空| -|data|object|通用数据对象，具体结构见下方| -|userIDs|string|群成员ID列表| -### 失败返回示例 - - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` -### 失败返回示例的参数说明 - - -|参数名|类型|说明| -|:---- |:------- |:--- | -|errCode|int|错误码,具体查看全局错误码文档| -|errMsg|string|错误简要信息| -|errDlt|errDlt|错误详细信息| diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx index 9bc5b6042b..55bd13a6dc 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/getOwnerConversation.mdx @@ -1,6 +1,6 @@ --- sidebar_position: 8 -title: Get Paginated Conversation List for the Current User +title: get_owner_conversation hide_title: true --- From 6c16442d59c0f26bc96826af463e8f5e02a50bae Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Mon, 19 Aug 2024 18:39:42 +0800 Subject: [PATCH 11/12] update --- .../groupManagement/getGroupMemberUserId.mdx | 86 ------------------- 1 file changed, 86 deletions(-) delete mode 100644 i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/getGroupMemberUserId.mdx diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/getGroupMemberUserId.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/getGroupMemberUserId.mdx deleted file mode 100644 index d08c8ec86d..0000000000 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/groupManagement/getGroupMemberUserId.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -sidebar_position: 13 -title: Get Group Member User ID List -hide_title: true ---- - -
- -## Get Group Member User ID List - -
- -### Brief Description -- Retrieve the list of user IDs for members of a specified group. - -### Request Method -- `post` - -### Request URL -- `http://x.x.x.x:10002/group/get_group_member_user_id` - -### Header -| Header Name | Example Value | Required | Type | Description | -|:-------------|:-------------------|:---------|:-------|:-----------------------------------------| -| operationID | 1646445464564 | Required | string | operationID is used for global trace tracking | -| token | eyJhbxxxx3Xs | Required | string | Admin token | - -### Request Parameter Example - -```json -{ - "groupID": "1012900607" -} -``` - -| Field Name | Required | Type | Description | -|:-----------|:---------|:-------|:------------| -| groupID | Required | string | Group ID | - -### Successful Response Example - -```json -{ - "errCode": 0, - "errMsg": "", - "errDlt": "", - "data": { - "userIDs": [ - "1029199385", - "1035025841", - "1046238762", - "1695766238", - "8772228740", - "9447003536" - ] - } -} -``` - -### Parameter Explanation for Successful Response - -| Parameter Name | Type | Description | -|:---------------|:-------|:-------------------------------------| -| errCode | int | Error code, 0 indicates success | -| errMsg | string | Brief error message, empty if no error | -| errDlt | errDlt | Detailed error message, empty if no error | -| data | object | Common data object, structure detailed below | -| userIDs | string | List of group member IDs | - -### Failure Response Example - -```json -{ - "errCode": 1004, - "errMsg": "RecordNotFoundError", - "errDlt": ": [1004]RecordNotFoundError" -} -``` - -### Parameter Explanation for Failure Response - -| Parameter Name | Type | Description | -|:---------------|:-------|:--------------------------------------| -| errCode | int | Error code, refer to global error codes documentation | -| errMsg | string | Brief error message | -| errDlt | errDlt | Detailed error message | \ No newline at end of file From 8dd4f03da77a51693e879f319f14a5a39d603ece Mon Sep 17 00:00:00 2001 From: Monet Lee Date: Mon, 19 Aug 2024 18:40:16 +0800 Subject: [PATCH 12/12] update --- .../current/apis/conversationManagement/setConversations.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/setConversations.mdx b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/setConversations.mdx index cc37a9b3dd..bdbbd3dfc5 100644 --- a/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/setConversations.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-restapi/current/apis/conversationManagement/setConversations.mdx @@ -1,6 +1,6 @@ --- sidebar_position: 7 -title: Set Fields for Multiple Users in the Same Conversation +title: set_conversations hide_title: true ---