feat: support group message with GroupAtInfo

Author: yanglbme

src/main/java/io/github/doocs/im/constant/GroupAtAllFlag.java

@@ -0,0 +1,24 @@
+package io.github.doocs.im.constant;
+
+/**
+ * 群组@全体成员标识
+ *
+ * @author Vensin
+ * @since  2025/1/25 13:52
+ */
+public final class GroupAtAllFlag {
+
+    /**
+     * 群组消息 @all
+     */
+    public static final int AT_ALL = 1;
+
+    /**
+     * 群组消息 @指定成员
+     */
+    public static final int AT_MEMBER = 0;
+
+    private GroupAtAllFlag() {
+
+    }
+}

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

@@ -0,0 +1,84 @@
+package io.github.doocs.im.model.request;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.io.Serializable;
+
+/**
+ * 群@消息
+ *
+ * @author Vensin
+ * @since 2025/1/25 13:43
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class GroupAtInfo implements Serializable {
+
+    private static final long serialVersionUID = -11238790123456789L;
+
+    /**
+     * 为1表示 @all,为0表示 @某个群成员 <br>
+     * {@link io.github.doocs.im.constant.GroupAtAllFlag}
+     */
+    @JsonProperty("GroupAtAllFlag")
+    private Integer groupAtAllFlag;
+
+    /**
+     * 表示 @的具体的群成员，如果为 @all，则无需填写该字段 <br>
+     * 消息体里面@的用户按顺序逐一对应，该字段上送的是用户的userId，消息体里的'@'后面内容任意，一般为用户的昵称
+     */
+    @JsonProperty("GroupAt_Account")
+    private String groupAtAccount;
+
+    public static GroupAtInfo.Builder builder() {
+        return new GroupAtInfo.Builder();
+    }
+
+
+    public Integer getGroupAtAllFlag() {
+        return groupAtAllFlag;
+    }
+
+    public void setGroupAtAllFlag(Integer groupAtAllFlag) {
+        this.groupAtAllFlag = groupAtAllFlag;
+    }
+
+    public String getGroupAtAccount() {
+        return groupAtAccount;
+    }
+
+    public void setGroupAtAccount(String groupAtAccount) {
+        this.groupAtAccount = groupAtAccount;
+    }
+
+
+    public static class Builder {
+        private Integer groupAtAllFlag;
+        private String groupAtAccount;
+
+        private Builder() {
+        }
+
+        public Builder groupAtAllFlag(Integer groupAtAllFlag) {
+            this.groupAtAllFlag = groupAtAllFlag;
+            return this;
+        }
+
+        public Builder groupAtAccount(String groupAtAccount) {
+            this.groupAtAccount = groupAtAccount;
+            return this;
+        }
+
+        public GroupAtInfo build() {
+            GroupAtInfo groupAtInfo = new GroupAtInfo();
+            groupAtInfo.groupAtAllFlag = this.groupAtAllFlag;
+            groupAtInfo.groupAtAccount = this.groupAtAccount;
+            return groupAtInfo;
+        }
+
+        public static Builder builder() {
+            return new Builder();
+        }
+    }
+
+}

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

@@ -48,6 +48,12 @@ public class SendGroupMsgRequest extends GenericRequest implements Serializable
     @JsonProperty("From_Account")
     private String fromAccount;
 
+    /**
+     * 群组消息设置@的用户，跟消息体里面@的用户按顺序逐一对应。
+     */
+    @JsonProperty("GroupAtInfo")
+    private List<GroupAtInfo> groupAtInfos;
+
     /**
      * 线推送信息配置，详细可参阅 消息格式描述
      */
@@ -129,6 +135,14 @@ public SendGroupMsgRequest(String groupId, Long random, String msgPriority, List
         this.topicId = topicId;
     }
 
+    public SendGroupMsgRequest(String groupId, Long random, String msgPriority, List<TIMMsgElement> msgBody,
+                               String fromAccount, OfflinePushInfo offlinePushInfo, List<String> forbidCallbackControl,
+                               Integer onlineOnlyFlag, List<String> sendMsgControl, String cloudCustomData,
+                               Integer supportMessageExtension, String toAccount, String topicId, List<GroupAtInfo> groupAtInfos) {
+        this(groupId, random, msgPriority, msgBody, fromAccount, offlinePushInfo, forbidCallbackControl, onlineOnlyFlag, sendMsgControl, cloudCustomData, supportMessageExtension, toAccount, topicId);
+        this.groupAtInfos = groupAtInfos;
+    }
+
     private SendGroupMsgRequest(Builder builder) {
         this.groupId = builder.groupId;
         this.random = builder.random;
@@ -143,6 +157,7 @@ private SendGroupMsgRequest(Builder builder) {
         this.supportMessageExtension = builder.supportMessageExtension;
         this.toAccount = builder.toAccount;
         this.topicId = builder.topicId;
+        this.groupAtInfos = builder.groupAtInfos;
     }
 
     public static Builder builder() {
@@ -253,12 +268,20 @@ public void setTopicId(String topicId) {
         this.topicId = topicId;
     }
 
+    public List<GroupAtInfo> getGroupAtInfos() {
+        return groupAtInfos;
+    }
+
+    public void setGroupAtInfos(List<GroupAtInfo> groupAtInfos) {
+        this.groupAtInfos = groupAtInfos;
+    }
 
     public static final class Builder {
         private String groupId;
         private Long random;
         private String msgPriority;
         private List<TIMMsgElement> msgBody;
+        private List<GroupAtInfo> groupAtInfos;
         private String fromAccount;
         private OfflinePushInfo offlinePushInfo;
         private List<String> forbidCallbackControl;
@@ -296,6 +319,11 @@ public Builder msgBody(List<TIMMsgElement> msgBody) {
             return this;
         }
 
+        public Builder groupAtInfos(List<GroupAtInfo> groupAtInfos) {
+            this.groupAtInfos = groupAtInfos;
+            return this;
+        }
+
         public Builder fromAccount(String fromAccount) {
             this.fromAccount = fromAccount;
             return this;

src/test/java/io/github/doocs/im/core/GroupTest.java

@@ -702,4 +702,23 @@ void testCheckMembers() throws IOException {
         System.out.println(result);
         Assertions.assertEquals(ErrorCode.SUCCESS.getCode(), result.getErrorCode());
     }
+
+    @Test
+    void testGroupMessageWithAtInfo() throws IOException {
+        TIMTextMsgElement msgEle = new TIMTextMsgElement();
+        msgEle.setMsgContent(new TIMTextMsgElement.TextMsgContent("Hello @小鬼 欢迎加入小组"));
+
+        SendGroupMsgRequest request = SendGroupMsgRequest.builder()
+                .groupId("shg_90")
+                .fromAccount("260")
+                .msgBody(Collections.singletonList(msgEle))
+                .groupAtInfos(Collections.singletonList(GroupAtInfo.builder()
+                        .groupAtAllFlag(GroupAtAllFlag.AT_MEMBER)
+                        .groupAtAccount("276").build()))
+                .build();
+
+        SendGroupMsgResult result = client.group.sendGroupMsg(request);
+        System.out.println(result);
+        Assertions.assertEquals(ErrorCode.SUCCESS.getCode(), result.getErrorCode());
+    }
 }