feat: add markdown button template message support

IllTamer · IllTamer · commit e6b93fe9f064 · 2024-03-04T22:46:30.000+08:00
diff --git a/openqq-for-java/src/main/java/cn/byteforge/openqq/http/OpenAPI.java b/openqq-for-java/src/main/java/cn/byteforge/openqq/http/OpenAPI.java
@@ -13,6 +13,7 @@
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.google.gson.JsonObject;
+import lombok.extern.slf4j.Slf4j;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.Map;
@@ -21,6 +22,7 @@
  * QQ 机器人 服务端开放的 openapi 接口对接
  * */
 // TODO 更改url储存位置
+@Slf4j
 public class OpenAPI {
 
     private static final Gson GSON = new GsonBuilder().create();
@@ -112,14 +114,14 @@ private static <T> T getAuthResponse(String url, @Nullable Map<String, Object> d
      * */
     private static <T> T getResponse(String url, Map<String, Object> data, Method method, Class<T> clazz, Map<String, String> headers) {
         String body = GSON.toJson(data);
+        log.debug("Send json object to url: {}, json: {}", url, body);
         try (HttpResponse response = HttpRequest.of(url)
                 .method(method)
                 .timeout(HttpGlobalConfig.getTimeout())
                 .body(body)
                 .headerMap(headers, true)
                 .execute())
         {
-            // {"message":"send msg err","code":22013,"err_code":22013,"trace_id":"eaab6442592c90cffa1ca71ce5f7c670"}
             Status.Http httpStatus = Status.Http.parse(response.getStatus());
             if (!httpStatus.isSuccess() && response.bodyBytes().length == 0) {
                 throw new APIInvokeException(httpStatus.getCode(), httpStatus.getMessage(), body);
diff --git a/openqq-for-java/src/main/java/cn/byteforge/openqq/message/MessageBuilder.java b/openqq-for-java/src/main/java/cn/byteforge/openqq/message/MessageBuilder.java
@@ -4,6 +4,7 @@
 import cn.byteforge.openqq.http.entity.entry.KeyValueEntry;
 import cn.byteforge.openqq.http.entity.entry.LinkedTextEntry;
 import cn.byteforge.openqq.util.Maps;
+import cn.hutool.core.lang.Assert;
 import com.google.gson.JsonArray;
 import org.jetbrains.annotations.Nullable;
 
@@ -80,6 +81,20 @@ public MessageBuilder addCustomMarkdown(String content) {
         return this;
     }
 
+    /**
+     * 从模版发送 Markdown 按钮消息
+     * @param templateId markdown 按钮模版id，申请按钮模版后获得
+     * @apiNote 按钮模板消息不能与markdown消息混合使用
+     * */
+    public MessageBuilder addTemplateMarkdownButton(String templateId) {
+        Assert.isNull(data.remove("markdown"), "Button template messages cannot be mixed with markdown messages");
+        data.put("keyboard", Maps.of(
+                "id", templateId
+        ));
+        updateMsgType(MessageType.MARKDOWN);
+        return this;
+    }
+
     // ARK 消息
 
     /**
diff --git a/openqq-for-java/src/main/java/cn/byteforge/openqq/ws/entity/Intent.java b/openqq-for-java/src/main/java/cn/byteforge/openqq/ws/entity/Intent.java
@@ -56,6 +56,9 @@ public Register withDirectMessage() {
             return this;
         }
 
+        /**
+         * Markdown 按钮点击回调事件监听
+         * */
         public Register withInteraction() {
             intents = intents | (1 << 26);
             return this;
diff --git a/openqq-for-java/src/main/java/cn/byteforge/openqq/ws/entity/data/InteractionData.java b/openqq-for-java/src/main/java/cn/byteforge/openqq/ws/entity/data/InteractionData.java
@@ -0,0 +1,113 @@
+package cn.byteforge.openqq.ws.entity.data;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import org.jetbrains.annotations.Nullable;
+
+@Data
+public class InteractionData {
+
+    /**
+     * 平台方事件 ID，可以用于被动消息发送
+     * */
+    private String id;
+
+    /**
+     * 消息按钮： 11，单聊快捷菜单：12
+     * */
+    private Integer type;
+
+    /**
+     * 事件发生的场景：c2c、group、guild
+     * */
+    private String scene;
+
+    /**
+     * 0 频道场景，1 群聊场景，2 单聊场景
+     * */
+    @SerializedName("chat_type")
+    private Integer chatType;
+
+    /**
+     * 触发时间 RFC 3339 格式
+     * */
+    private String timestamp;
+
+    /**
+     * 单聊单聊按钮触发x，的用户 openid，仅在单聊场景提供该字段
+     * */
+    @SerializedName("user_openid")
+    @Nullable
+    private String userOpenid;
+
+    /**
+     * 群的 openid，仅在群聊场景提供该字段
+     * */
+    @SerializedName("group_openid")
+    @Nullable
+    private String groupOpenid;
+
+    /**
+     * 按钮触发用户，群聊的群成员 openid，仅在群聊场景提供该字段
+     * */
+    @SerializedName("group_member_openid")
+    @Nullable
+    private String groupMemberOpenid;
+
+    private Data data;
+
+    private Integer version;
+
+    /**
+     * 机器人的 appid
+     * */
+    @SerializedName("application_id")
+    private String applicationId;
+
+
+    @lombok.Data
+    public static final class Data {
+
+        private Resolved resolved;
+
+    }
+
+    @lombok.Data
+    public static final class Resolved {
+
+        /**
+         * 操作按钮的 data 字段值（在发送消息按钮时设置）
+         * */
+        @SerializedName("button_data")
+        private String buttonData;
+
+        /**
+         * 操作按钮的 id 字段值（在发送消息按钮时设置）
+         * */
+        @SerializedName("button_id")
+        private String buttonId;
+
+        /**
+         * 操作的用户 userid，仅频道场景提供该字段
+         * */
+        @Nullable
+        @SerializedName("user_id")
+        private String userId;
+
+        /**
+         * 操作按钮的 id 字段值，仅自定义菜单提供该字段（在管理端设置）
+         * */
+        @Nullable
+        @SerializedName("feature_id")
+        private String featureId;
+
+        /**
+         * 操作的消息id，目前仅频道场景提供该字段
+         * */
+        @Nullable
+        @SerializedName("message_id")
+        private String messageId;
+
+    }
+
+}
diff --git a/openqq-for-java/src/main/java/cn/byteforge/openqq/ws/event/type/MessageEvent.java b/openqq-for-java/src/main/java/cn/byteforge/openqq/ws/event/type/MessageEvent.java
@@ -16,7 +16,7 @@
 public abstract class MessageEvent extends Event {
 
     /**
-     * 	平台方消息ID，可以用于被动消息发送
+     * 事件ID
      * */
     private String id;
 
diff --git a/openqq-for-java/src/main/java/cn/byteforge/openqq/ws/event/type/interact/InteractionEvent.java b/openqq-for-java/src/main/java/cn/byteforge/openqq/ws/event/type/interact/InteractionEvent.java
@@ -0,0 +1,31 @@
+package cn.byteforge.openqq.ws.event.type.interact;
+
+import cn.byteforge.openqq.ws.entity.data.InteractionData;
+import cn.byteforge.openqq.ws.event.Event;
+import com.google.gson.Gson;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * Markdown 按钮交互事件
+ * */
+@EqualsAndHashCode(callSuper = true)
+@ToString(callSuper = true)
+@Data
+public class InteractionEvent extends Event {
+
+    /**
+     * 事件ID
+     * */
+    private String id;
+
+    /**
+     * 获取事件字段数据
+     * */
+    public InteractionData getData() {
+        return new Gson().fromJson(getD(), InteractionData.class);
+    }
+
+
+}
diff --git a/openqq-for-java/src/main/java/cn/byteforge/openqq/ws/handler/EventParseHandler.java b/openqq-for-java/src/main/java/cn/byteforge/openqq/ws/handler/EventParseHandler.java
@@ -5,6 +5,7 @@
 import cn.byteforge.openqq.ws.event.Event;
 import cn.byteforge.openqq.ws.event.type.friend.*;
 import cn.byteforge.openqq.ws.event.type.group.*;
+import cn.byteforge.openqq.ws.event.type.interact.InteractionEvent;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.google.gson.JsonObject;
@@ -42,6 +43,7 @@ protected Event doHandle(Object object) {
 
     static {
         TYPE_EVENT_MAP = new HashMap<>();
+        TYPE_EVENT_MAP.put("INTERACTION_CREATE", InteractionEvent.class);
         TYPE_EVENT_MAP.putAll(Maps.of(
                 "C2C_MESSAGE_CREATE", C2CMessageEvent.class,
                 "GROUP_AT_MESSAGE_CREATE", GroupAtMessageEvent.class
diff --git a/openqq-for-java/src/test/java/TestMain.java b/openqq-for-java/src/test/java/TestMain.java
@@ -1,13 +1,17 @@
 import cn.byteforge.openqq.http.OpenAPI;
 import cn.byteforge.openqq.http.entity.AccessToken;
 import cn.byteforge.openqq.http.entity.RecommendShard;
+import cn.byteforge.openqq.message.Message;
+import cn.byteforge.openqq.message.MessageBuilder;
 import cn.byteforge.openqq.model.Certificate;
 import cn.byteforge.openqq.ws.BotContext;
 import cn.byteforge.openqq.ws.QQConnection;
 import cn.byteforge.openqq.ws.WebSocketAPI;
 import cn.byteforge.openqq.ws.entity.Intent;
+import cn.byteforge.openqq.ws.entity.data.GroupAtMessageData;
 import cn.byteforge.openqq.ws.event.EventListener;
 import cn.byteforge.openqq.ws.event.type.group.GroupAtMessageEvent;
+import cn.byteforge.openqq.ws.event.type.interact.InteractionEvent;
 import cn.byteforge.openqq.ws.handler.ChainHandler;
 
 import java.nio.file.Files;
@@ -18,26 +22,44 @@ public class TestMain {
     private static BotContext context;
 
     public static void main(String[] args) throws Exception {
-        String appId = new String(Files.readAllBytes(Paths.get("../secrets/appId.txt")));
-        String clientSecret = new String(Files.readAllBytes(Paths.get("../secrets/clientSecret.txt")));
+        String appId = new String(Files.readAllBytes(Paths.get("secrets/appId.txt")));
+        String clientSecret = new String(Files.readAllBytes(Paths.get("secrets/clientSecret.txt")));
         AccessToken token = OpenAPI.getAppAccessToken(appId, clientSecret);
         Certificate certificate = new Certificate(appId, clientSecret, token);
         context = BotContext.create(certificate);
         RecommendShard shard = OpenAPI.getRecommendShardWssUrls(certificate);
         String wssUrl = shard.getUrl();
 
-        Intent intent = Intent.register().withAll().done();
+        Intent intent = Intent.register()
+                .withCustom(1 << 25)
+                .withCustom(1 << 26)
+                .done();
         ChainHandler chainHandler = ChainHandler.defaultChainGroup(wssUrl, null,
                 new EventListener<GroupAtMessageEvent>() {
                     @Override
                     public void onEvent(GroupAtMessageEvent event) {
-                        System.out.println(event);
+                        GroupAtMessageData data = event.getData();
+                        Message message = new MessageBuilder()
+                                .addTemplateMarkdownButton("")
+                                .setPassive(data.getId())
+                                .build();
+                        OpenAPI.sendGroupMessage(data.getGroupId(), message, certificate);
                     }
 
                     @Override
                     public Intent eventIntent() {
                         return Intent.register().withCustom(1 << 25).done();
                     }
+                }, new EventListener<InteractionEvent>() {
+                    @Override
+                    public void onEvent(InteractionEvent event) {
+                        System.out.println("收到：" + event);
+                    }
+
+                    @Override
+                    public Intent eventIntent() {
+                        return Intent.register().withInteraction().done();
+                    }
                 });
 
         QQConnection.connect(wssUrl, chainHandler, context,

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,9 @@ public Register withDirectMessage() {`
`56`	`56`	`return this;`
`57`	`57`	`}`
`58`	`58`
	`59`	`+ /**`
	`60`	`+ * Markdown 按钮点击回调事件监听`
	`61`	`+ * */`
`59`	`62`	`public Register withInteraction() {`
`60`	`63`	`intents = intents \| (1 << 26);`
`61`	`64`	`return this;`