feat: add group api

Author: yanglbme

README.md

@@ -25,7 +25,7 @@ If you're using Maven, just add the following dependency in `pom.xml`.
 <dependency>
   <groupId>io.github.doocs</groupId>
   <artifactId>im-server-sdk-java</artifactId>
-  <version>0.4.10</version>
+  <version>0.4.11</version>
 </dependency>
 ```
 

README_CN.md

@@ -25,7 +25,7 @@ https://doocs.github.io/qcloud-im-server-sdk-java
 <dependency>
   <groupId>io.github.doocs</groupId>
   <artifactId>im-server-sdk-java</artifactId>
-  <version>0.4.10</version>
+  <version>0.4.11</version>
 </dependency>
 ```
 

docs/guide/README.md

@@ -1,6 +1,6 @@
 # 介绍
 
-本文档基于腾讯云 IM Server SDK Java <Badge type="tip" text="v0.4.10" vertical="top" /> 编写。
+本文档基于腾讯云 IM Server SDK Java <Badge type="tip" text="v0.4.11" vertical="top" /> 编写。
 
 ## 前提条件
 

docs/guide/group.md

@@ -1047,6 +1047,55 @@ request.setRandom(1223L);
 SendBroadcastMsgResult result = client.group.sendBroadcastMsg(request);
 ```
 
+## 群消息已读回执
+
+App 管理员可以通过该接口对指定成员进行群消息已读回执。
+
+::: warning
+该功能仅对旗舰版或企业版客户开放，需 购买旗舰版或企业版套餐包 并在 控制台 > 功能配置 > 群组配置 > 群消息已读回执打开开关后方可使用。
+:::
+
+::: tip
+适用的群组类型
+
+| 群组类型 ID       | 是否支持此 REST API                        |
+| ----------------- | ------------------------------------------ |
+| Private           | 支持，同新版本中的 Work(好友工作群)        |
+| Public            | 支持                                       |
+| ChatRoom          | 支持，同新版本中的 Meeting（临时会议群）） |
+| AVChatRoom        | 不支持                                     |
+| Community（社群） | 不支持                                     |
+
+即时通信 IM 内置上述群组类型，详情介绍请参见 [群组系统](https://cloud.tencent.com/document/product/269/1502)。
+:::
+
+使用示例：
+
+```java
+GroupMsgReceiptRequest request = new GroupMsgReceiptRequest();
+request.setGroupId("MyFirstGroup");
+request.setFromAccount("test1");
+request.setMsgSeqList(Collections.singletonList(new MsgSeqItem(123L)));
+
+GroupMsgReceiptResult result = client.group.groupMsgReceipt(request);
+```
+
+## 发送单聊消息已读回执
+
+- App 管理员可以通过该接口发送单聊消息已读回执。
+- 用户 A 给用户 B 发送单聊消息，则用户 B 作为消息的接收方，发送消息已读回执。请求中 Operator_Account 字段填用户 B 的 UserID,  Peer_Account 字段填用户 A 的 UserID，C2CMsgInfo 中的 From_Account 填用户 A 的 UserID ，To_Account填用户 B 的 UserID。
+
+使用示例：
+
+```java
+C2cMsgReadReceiptRequest request = new C2cMsgReadReceiptRequest();
+request.setPeerAccount("test1");
+request.setOperatorAccount("test2");
+request.setC2cMsgInfoItemList(Collections.singletonList(new C2cMsgInfoItem("123", "456", "789")));
+
+C2cMsgReadReceiptResult result = client.group.c2cMsgReadReceipt(request);
+```
+
 ## 拉取群消息已读回执信息
 
 App 管理员可以通过该接口拉取群消息已读回执信息。

docs/guide/quickstart.md

@@ -10,14 +10,14 @@
 <dependency>
   <groupId>io.github.doocs</groupId>
   <artifactId>im-server-sdk-java</artifactId>
-  <version>0.4.10</version>
+  <version>0.4.11</version>
 </dependency>
 ```
 
 ### Gradle
 
 ```gradle
-implementation group: 'io.github.doocs', name: 'im-server-sdk-java', version: '0.4.10'
+implementation group: 'io.github.doocs', name: 'im-server-sdk-java', version: '0.4.11'
 ```
 
 ### 下载 JAR

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "qcloud-im-server-sdk-java",
-  "version": "0.4.10",
+  "version": "0.4.11",
   "description": "腾讯云 IM 服务端 SDK API 文档 Java 版",
   "main": "index.js",
   "scripts": {

package.json

@@ -6,7 +6,7 @@
 
     <groupId>io.github.doocs</groupId>
     <artifactId>im-server-sdk-java</artifactId>
-    <version>0.4.10</version>
+    <version>0.4.11</version>
     <packaging>jar</packaging>
 
     <name>qcloud-im-server-sdk-java</name>

pom.xml

@@ -60,6 +60,8 @@ public class Group {
     public static final String SET_GROUP_ATTR_COMMAND = "set_group_attr";
     public static final String MODIFY_GROUP_MSG_COMMAND = "modify_group_msg";
     public static final String SEND_BROADCAST_MSG_COMMAND = "send_broadcast_msg";
+    public static final String GROUP_MSG_RECEIPT_COMMAND = "group_msg_receipt";
+    public static final String C2C_MSG_READ_RECEIPT_COMMAND = "c2c_msg_read_receipt";
     public static final String GET_GROUP_MSG_RECEIPT_COMMAND = "get_group_msg_receipt";
     public static final String GET_GROUP_MSG_RECEIPT_DETAIL_COMMAND = "get_group_msg_receipt_detail";
     public static final String CREATE_GROUP_TOPIC_COMMAND = "create_topic";
@@ -648,6 +650,40 @@ public SendBroadcastMsgResult sendBroadcastMsg(SendBroadcastMsgRequest sendBroad
         return HttpUtil.post(url, sendBroadcastMsgRequest, SendBroadcastMsgResult.class, imClient.getConfig());
     }
 
+    /**
+     * 群消息已读回执
+     *
+     * @param groupMsgReceiptRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
+    public GroupMsgReceiptResult groupMsgReceipt(GroupMsgReceiptRequest groupMsgReceiptRequest) throws IOException {
+        String url = imClient.getUrl(SERVICE_NAME, GROUP_MSG_RECEIPT_COMMAND);
+        return HttpUtil.post(url, groupMsgReceiptRequest, GroupMsgReceiptResult.class, imClient.getConfig());
+    }
+
+    public GroupMsgReceiptResult groupMsgReceipt(GroupMsgReceiptRequest groupMsgReceiptRequest, long random) throws IOException {
+        String url = imClient.getUrl(SERVICE_NAME, GROUP_MSG_RECEIPT_COMMAND, random);
+        return HttpUtil.post(url, groupMsgReceiptRequest, GroupMsgReceiptResult.class, imClient.getConfig());
+    }
+
+    /**
+     * 发送单聊消息已读回执
+     *
+     * @param c2cMsgReadReceiptRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
+    public C2cMsgReadReceiptResult c2cMsgReadReceipt(C2cMsgReadReceiptRequest c2cMsgReadReceiptRequest) throws IOException {
+        String url = imClient.getUrl(SERVICE_NAME_OPEN_IM, C2C_MSG_READ_RECEIPT_COMMAND);
+        return HttpUtil.post(url, c2cMsgReadReceiptRequest, C2cMsgReadReceiptResult.class, imClient.getConfig());
+    }
+
+    public C2cMsgReadReceiptResult c2cMsgReadReceipt(C2cMsgReadReceiptRequest c2cMsgReadReceiptRequest, long random) throws IOException {
+        String url = imClient.getUrl(SERVICE_NAME_OPEN_IM, C2C_MSG_READ_RECEIPT_COMMAND, random);
+        return HttpUtil.post(url, c2cMsgReadReceiptRequest, C2cMsgReadReceiptResult.class, imClient.getConfig());
+    }
+
     /**
      * 拉取群消息已读回执信息
      *

src/main/java/io/github/doocs/im/core/Group.java

@@ -0,0 +1,104 @@
+package io.github.doocs.im.model.request;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.io.Serializable;
+
+/**
+ * @author hyh
+ * @since 2021/07/29 15:37
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class C2cMsgInfoItem implements Serializable {
+    private static final long serialVersionUID = 2340480215779943454L;
+
+    /**
+     * 消息的发送方 UserID，需与 Peer_Account 保持一致
+     */
+    @JsonProperty("From_Account")
+    private String fromAccount;
+
+    /**
+     * 消息的接收方 UserID，需与 Operator_Account 保持一致
+     */
+    @JsonProperty("To_Account")
+    private String toAccount;
+
+    /**
+     * 消息的 MsgKey
+     */
+    @JsonProperty("MsgKey")
+    private String msgKey;
+
+    public String getFromAccount() {
+        return fromAccount;
+    }
+
+    public void setFromAccount(String fromAccount) {
+        this.fromAccount = fromAccount;
+    }
+
+    public String getToAccount() {
+        return toAccount;
+    }
+
+    public void setToAccount(String toAccount) {
+        this.toAccount = toAccount;
+    }
+
+    public String getMsgKey() {
+        return msgKey;
+    }
+
+    public void setMsgKey(String msgKey) {
+        this.msgKey = msgKey;
+    }
+
+    public C2cMsgInfoItem() {
+    }
+
+    public C2cMsgInfoItem(String fromAccount, String toAccount, String msgKey) {
+        this.fromAccount = fromAccount;
+        this.toAccount = toAccount;
+        this.msgKey = msgKey;
+    }
+
+    private C2cMsgInfoItem(Builder builder) {
+        this.fromAccount = builder.fromAccount;
+        this.toAccount = builder.toAccount;
+        this.msgKey = builder.msgKey;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public static final class Builder {
+        private String fromAccount;
+        private String toAccount;
+        private String msgKey;
+
+        private Builder() {
+        }
+
+        public C2cMsgInfoItem build() {
+            return new C2cMsgInfoItem(this);
+        }
+
+        public Builder fromAccount(String fromAccount) {
+            this.fromAccount = fromAccount;
+            return this;
+        }
+
+        public Builder toAccount(String toAccount) {
+            this.toAccount = toAccount;
+            return this;
+        }
+
+        public Builder msgKey(String msgKey) {
+            this.msgKey = msgKey;
+            return this;
+        }
+    }
+}

src/main/java/io/github/doocs/im/model/request/C2cMsgInfoItem.java

@@ -0,0 +1,92 @@
+package io.github.doocs.im.model.request;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 发送单聊消息已读回执-请求参数
+ *
+ * @author bingo
+ * @since 2024/3/7 15:27
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class C2cMsgReadReceiptRequest extends GenericRequest implements Serializable {
+    @JsonProperty("Operator_Account")
+    private String operatorAccount;
+    @JsonProperty("Peer_Account")
+    private String peerAccount;
+
+    @JsonProperty("C2CMsgInfo")
+    private List<C2cMsgInfoItem> c2cMsgInfoItemList;
+
+    public C2cMsgReadReceiptRequest() {
+    }
+
+    public C2cMsgReadReceiptRequest(String operatorAccount, String peerAccount, List<C2cMsgInfoItem> c2cMsgInfoItemList) {
+        this.operatorAccount = operatorAccount;
+        this.peerAccount = peerAccount;
+        this.c2cMsgInfoItemList = c2cMsgInfoItemList;
+    }
+
+    public String getOperatorAccount() {
+        return operatorAccount;
+    }
+
+    public void setOperatorAccount(String operatorAccount) {
+        this.operatorAccount = operatorAccount;
+    }
+
+    public String getPeerAccount() {
+        return peerAccount;
+    }
+
+    public void setPeerAccount(String peerAccount) {
+        this.peerAccount = peerAccount;
+    }
+
+    public List<C2cMsgInfoItem> getC2cMsgInfoItemList() {
+        return c2cMsgInfoItemList;
+    }
+
+    public void setC2cMsgInfoItemList(List<C2cMsgInfoItem> c2cMsgInfoItemList) {
+        this.c2cMsgInfoItemList = c2cMsgInfoItemList;
+    }
+
+    private C2cMsgReadReceiptRequest(Builder builder) {
+        this.operatorAccount = builder.operatorAccount;
+        this.peerAccount = builder.peerAccount;
+        this.c2cMsgInfoItemList = builder.c2cMsgInfoItemList;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public static final class Builder {
+        private String operatorAccount;
+        private String peerAccount;
+        private List<C2cMsgInfoItem> c2cMsgInfoItemList;
+
+        public C2cMsgReadReceiptRequest build() {
+            return new C2cMsgReadReceiptRequest(this);
+        }
+
+        public Builder operatorAccount(String operatorAccount) {
+            this.operatorAccount = operatorAccount;
+            return this;
+        }
+
+        public Builder peerAccount(String peerAccount) {
+            this.peerAccount = peerAccount;
+            return this;
+        }
+
+        public Builder c2cMsgInfoItemList(List<C2cMsgInfoItem> c2cMsgInfoItemList) {
+            this.c2cMsgInfoItemList = c2cMsgInfoItemList;
+            return this;
+        }
+    }
+}