Add ACS WhatsApp interactive message (Azure#43782)

Added WhatsApp interactive, sticker and reaction message

Author: arifibrahim4

sdk/communication/azure-communication-messages/CHANGELOG.md

@@ -1,14 +1,11 @@
 # Release History
 
-## 1.2.0-beta.1 (Unreleased)
+## 1.2.0-beta.1 (2025-01-15)
 
 ### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
+- Added Interactive Message.
+- Added Reaction Message.
+- Added Sticker Message.
 
 
 ## 1.1.1 (2024-12-04)
@@ -24,7 +21,7 @@
 ## 1.1.0 (2024-10-23)
 
 ### Features Added
-- Added ImageNotificationContent to send image messgae.
+- Added ImageNotificationContent to send image message.
 - Added DocumentNotificationContent to send document message.
 - Added VideoNotificationContent to send video message.
 - Added AudioNotificationContent to  send audio message.

sdk/communication/azure-communication-messages/README.md

@@ -274,6 +274,127 @@ public void sendDocumentMessage() {
     result.getReceipts().forEach(r -> System.out.println("Message sent to:" + r.getTo() + " and message id:" + r.getMessageId()));
 }
 ```
+```java readme-sample-sendStickerMessage
+/*
+ * This sample shows how to send sticker message with below details
+ * Supported sticker type - (.webp)
+ * Note: Business cannot initiate conversation with media message.
+ * */
+public static void sendStickerMessage() {
+    //Update the Media URL
+    String mediaUrl = "https://www.gstatic.com/webp/gallery/1.sm.webp";
+    List<String> recipients = new ArrayList<>();
+    recipients.add("<RECIPIENT_IDENTIFIER e.g. PhoneNumber>");
+    NotificationMessagesClient client = new NotificationMessagesClientBuilder()
+        .connectionString("<CONNECTION_STRING>")
+        .buildClient();
+    SendMessageResult result = client.send(
+        new StickerNotificationContent("<CHANNEL_ID>", recipients, mediaUrl));
+
+    result.getReceipts().forEach(r -> System.out.println("Message sent to:" + r.getTo() + " and message id:" + r.getMessageId()));
+}
+```
+```java readme-sample-sendReactionMessage
+/*
+ * This sample shows how to send reaction message with below details
+ * Emoji - unicode for emoji character.
+ * Reply Message ID - ID of the message to be replied with emoji
+ * Note: Business cannot initiate conversation with media message.
+ * */
+public static void sendReactionMessage() {
+    List<String> recipients = new ArrayList<>();
+    recipients.add("<RECIPIENT_IDENTIFIER e.g. PhoneNumber>");
+    NotificationMessagesClient client = new NotificationMessagesClientBuilder()
+        .connectionString("<CONNECTION_STRING>")
+        .buildClient();
+    SendMessageResult result = client.send(
+        new ReactionNotificationContent("<CHANNEL_ID>", recipients, "\uD83D\uDE00", "<REPLY_MESSAGE_ID>"));
+
+    result.getReceipts().forEach(r -> System.out.println("Message sent to:" + r.getTo() + " and message id:" + r.getMessageId()));
+}
+```
+```java readme-sample-sendInteractiveMessageWithButtonAction
+/*
+ * This sample shows how to send interactive message with Button Action
+ * Note: Business cannot initiate conversation with interactive message.
+ * */
+public void sendInteractiveMessageWithButtonAction() {
+    List<String> recipients = new ArrayList<>();
+    recipients.add("<RECIPIENT_IDENTIFIER e.g. PhoneNumber>");
+    NotificationMessagesClient client = new NotificationMessagesClientBuilder()
+        .connectionString("<CONNECTION_STRING>")
+        .buildClient();
+    List<ButtonContent> buttonActions =  new ArrayList<>();
+    buttonActions.add(new ButtonContent("no",  "No"));
+    buttonActions.add(new ButtonContent("yes",  "Yes"));
+    ButtonSetContent buttonSet = new ButtonSetContent(buttonActions);
+    InteractiveMessage interactiveMessage = new InteractiveMessage(
+        new TextMessageContent("Do you want to proceed?"), new WhatsAppButtonActionBindings(buttonSet));
+    SendMessageResult result = client.send(
+        new InteractiveNotificationContent("<CHANNEL_ID>",  recipients, interactiveMessage));
+
+    result.getReceipts().forEach(r -> System.out.println("Message sent to:" + r.getTo() + " and message id:" + r.getMessageId()));
+}
+```
+```java readme-sample-sendInteractiveMessageWithListAction
+/*
+ * This sample shows how to send list action interactive message
+ * Note: Business cannot initiate conversation with interactive message.
+ * */
+public static void sendInteractiveMessageWithListAction() {
+    List<ActionGroupItem> group1 = new ArrayList<>();
+    group1.add(new ActionGroupItem("priority_express", "Priority Mail Express", "Delivered on same day!"));
+    group1.add(new ActionGroupItem("priority_mail", "Priority Mail", "Delivered in 1-2 days"));
+
+    List<ActionGroupItem> group2 = new ArrayList<>();
+    group2.add(new ActionGroupItem("usps_ground_advantage", "USPS Ground Advantage", "Delivered in 2-5 days"));
+    group2.add(new ActionGroupItem("media_mail", "Media Mail", "Delivered in 5-8 days"));
+
+    List<ActionGroup> options = new ArrayList<>();
+    options.add(new ActionGroup("Express Delivery", group1));
+    options.add(new ActionGroup("Normal Delivery", group2));
+
+    ActionGroupContent actionGroupContent = new ActionGroupContent("Shipping Options", options);
+    InteractiveMessage interactiveMessage = new InteractiveMessage(
+        new TextMessageContent("Which shipping option do you want?"), new WhatsAppListActionBindings(actionGroupContent));
+    interactiveMessage.setFooter(new TextMessageContent("Eagle Logistic"));
+    interactiveMessage.setHeader(new TextMessageContent("Shipping Options"));
+
+    List<String> recipients = new ArrayList<>();
+    recipients.add("<RECIPIENT_IDENTIFIER e.g. PhoneNumber>");
+    NotificationMessagesClient client = new NotificationMessagesClientBuilder()
+        .connectionString("<CONNECTION_STRING>")
+        .buildClient();
+    SendMessageResult result = client.send(
+        new InteractiveNotificationContent("<CHANNEL_ID>",  recipients, interactiveMessage));
+
+    result.getReceipts().forEach(r -> System.out.println("Message sent to:" + r.getTo() + " and message id:" + r.getMessageId()));
+
+}
+```
+```java readme-sample-sendInteractiveMessageWithUrlAction
+/*
+ * This sample shows how to send url action interactive message
+ * Note: Business cannot initiate conversation with interactive message.
+ * */
+public static void sendInteractiveMessageWithUrlAction() {
+    LinkContent urlAction = new LinkContent("Rocket is the best!", "https://wallpapercave.com/wp/wp2163723.jpg");
+    InteractiveMessage interactiveMessage = new InteractiveMessage(
+        new TextMessageContent("The best Guardian of Galaxy"), new WhatsAppUrlActionBindings(urlAction));
+    interactiveMessage.setFooter(new TextMessageContent("Intergalactic New Ltd"));
+
+    List<String> recipients = new ArrayList<>();
+    recipients.add("<RECIPIENT_IDENTIFIER e.g. PhoneNumber>");
+    NotificationMessagesClient client = new NotificationMessagesClientBuilder()
+        .connectionString("<CONNECTION_STRING>")
+        .buildClient();
+    SendMessageResult result = client.send(
+        new InteractiveNotificationContent("<CHANNEL_ID>",  recipients, interactiveMessage));
+
+    result.getReceipts().forEach(r -> System.out.println("Message sent to:" + r.getTo() + " and message id:" + r.getMessageId()));
+}
+```
+
 ### Get Template List for given channel example:
 ```java readme-sample-ListTemplates
 MessageTemplateClient templateClient =

sdk/communication/azure-communication-messages/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo" : "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath" : "java",
   "TagPrefix" : "java/communication/azure-communication-messages",
-  "Tag" : "java/communication/azure-communication-messages_d7c7441f3b"
+  "Tag" : "java/communication/azure-communication-messages_d7e86da684"
 }

sdk/communication/azure-communication-messages/customization/src/main/java/MessagesSdkCustomization.java

@@ -8,13 +8,19 @@
 import com.github.javaparser.ast.Modifier;
 import com.github.javaparser.ast.Node;
 import com.github.javaparser.ast.NodeList;
+import com.github.javaparser.ast.body.MethodDeclaration;
+import com.github.javaparser.ast.body.Parameter;
 import com.github.javaparser.ast.stmt.BlockStmt;
 import com.github.javaparser.ast.type.ClassOrInterfaceType;
 import com.github.javaparser.javadoc.Javadoc;
 import com.github.javaparser.javadoc.description.JavadocDescription;
 import com.github.javaparser.javadoc.description.JavadocSnippet;
 import org.slf4j.Logger;
 
+import java.util.ArrayList;
+import java.util.List;
+import java.util.stream.Collectors;
+
 public class MessagesSdkCustomization extends Customization {
 
     @Override
@@ -32,13 +38,24 @@ public void customize(LibraryCustomization libraryCustomization, Logger logger)
         customizeMessageTemplateLocation(modelsPackage);
         customizeMessageTemplateItemModel(modelsPackage);
 
+        //Handle Interactive message content models
+        updateModelClassModifierToAbstract(modelsPackage, "MessageContent");
+        updateModelClassModifierToAbstract(modelsPackage, "ActionBindings");
+        updateJavaDocForMethodFromJson(modelsPackage, "ActionBindings");
+        updateJavaDocForMethodFromJson(modelsPackage, "MessageContent");
+        customizeInteractiveMessage(modelsPackage);
+
         PackageCustomization channelsModelsPackage = libraryCustomization.getPackage(
             "com.azure.communication.messages.models.channels");
         updateWhatsAppMessageTemplateItemWithBinaryDataContent(channelsModelsPackage);
 
-        AddDeprecateAnnotationToMediaNotificationContent(modelsPackage);
+        addDeprecateAnnotationToMediaNotificationContent(modelsPackage);
+
+        addDeprecateAnnotationForImageV0CommunicationKind(modelsPackage);
 
-        AddDeprecateAnnotationForImageV0CommunicationKind(modelsPackage);
+        customizeActionGroup(modelsPackage);
+        customizeActionGroupContent(modelsPackage);
+        customizeButtonSetContent(modelsPackage);
     }
 
     private void updateModelClassModifierToAbstract(PackageCustomization modelsPackage, String className) {
@@ -174,6 +191,45 @@ private void customizeMessageTemplateLocation(PackageCustomization modelsPackage
         });
     }
 
+    private void customizeInteractiveMessage(PackageCustomization modelsPackage) {
+        modelsPackage.getClass("InteractiveMessage").customizeAst(ast -> {
+            ast.getClassByName("InteractiveMessage").ifPresent(clazz -> {
+                clazz.addMethod("getHeader", Modifier.Keyword.PUBLIC)
+                    .setType(clazz.getMethodsByName("getHeaderProperty").get(0).getType())
+                    .setBody(clazz.getMethodsByName("getHeaderProperty").get(0).getBody().get())
+                    .setJavadocComment(clazz.getMethodsByName("getHeaderProperty").get(0).getJavadocComment().get());
+
+                clazz.getMethodsByName("getHeaderProperty").forEach(Node::remove);
+
+                MethodDeclaration setHeaderMethodDeclaration = clazz.getMethodsByName("setHeaderProperty").get(0);
+                List<Parameter> parameters = setHeaderMethodDeclaration
+                    .getParameters()
+                    .stream()
+                    .map(p -> p.setName("header"))
+                    .collect(Collectors.toList());
+                String methodBodyContent = setHeaderMethodDeclaration
+                    .getBody()
+                    .get()
+                    .toString()
+                    .replace("headerProperty;", "header;");
+
+                String docComment = setHeaderMethodDeclaration
+                    .getJavadocComment()
+                    .get()
+                    .getContent()
+                    .replace("headerProperty", "header");
+
+                clazz.addMethod("setHeader", Modifier.Keyword.PUBLIC)
+                    .setParameters(new NodeList<Parameter>(parameters))
+                    .setType(setHeaderMethodDeclaration.getType())
+                    .setBody(StaticJavaParser.parseBlock(methodBodyContent))
+                    .setJavadocComment(new Javadoc(JavadocDescription.parseText(docComment)));
+
+                clazz.getMethodsByName("setHeaderProperty").forEach(Node::remove);
+            });
+        });
+    }
+
     private void updateWhatsAppMessageTemplateItemWithBinaryDataContent(PackageCustomization channelsModelsPackage) {
         channelsModelsPackage.getClass("WhatsAppMessageTemplateItem").customizeAst(ast -> {
             // ast.addImport("com.azure.core.util.BinaryData");
@@ -206,7 +262,7 @@ private void removeJsonKnownDiscriminatorMethod(PackageCustomization modelPackag
         });
     }
 
-    private void AddDeprecateAnnotationToMediaNotificationContent(PackageCustomization modelsPackage) {
+    private void addDeprecateAnnotationToMediaNotificationContent(PackageCustomization modelsPackage) {
         modelsPackage.getClass("MediaNotificationContent").customizeAst(ast -> {
             ast.getClassByName("MediaNotificationContent").ifPresent(clazz -> {
                 clazz.addAnnotation(Deprecated.class);
@@ -222,7 +278,7 @@ private void AddDeprecateAnnotationToMediaNotificationContent(PackageCustomizati
         });
     }
 
-    private  void AddDeprecateAnnotationForImageV0CommunicationKind(PackageCustomization modelsPackage) {
+    private  void addDeprecateAnnotationForImageV0CommunicationKind(PackageCustomization modelsPackage) {
         modelsPackage.getClass("CommunicationMessageKind").customizeAst(ast -> {
             ast.getClassByName("CommunicationMessageKind")
                 .flatMap(clazz -> clazz.getFieldByName("IMAGE_V0"))
@@ -240,4 +296,72 @@ private  void AddDeprecateAnnotationForImageV0CommunicationKind(PackageCustomiza
                 });
         });
     }
+
+    private void updateJavaDocForMethodFromJson(PackageCustomization modelPackage, String className) {
+        String originalDocText = String.format("@throws IOException If an error occurs while reading the %s.", className);
+        modelPackage.getClass(className).customizeAst(ast -> {
+            ast.getClassByName(className).ifPresent( clazz -> {
+                String fromJsonDoc = clazz.getMethodsByName("fromJson")
+                    .get(0).getJavadoc().get().toText()
+                    .replace(originalDocText,
+                        "@throws IllegalStateException If the deserialized JSON object was missing any required properties.\n" +
+                            originalDocText);
+                clazz.getMethodsByName("fromJson").get(0).setJavadocComment(fromJsonDoc);
+            });
+        });
+    }
+
+    private void customizeActionGroup(PackageCustomization modelsPackage) {
+        modelsPackage.getClass("ActionGroup").customizeAst(ast -> {
+            ast.getClassByName("ActionGroup")
+                .flatMap(clazz -> clazz.getConstructorByParameterTypes(String.class, List.class))
+                .ifPresent(c -> {
+                    String body = c.getBody().toString().replace("this.items = items;",
+                        "this.items = new ArrayList<>(items);");
+                    c.setBody(StaticJavaParser.parseBlock(body));
+            });
+
+            ast.getClassByName("ActionGroup").ifPresent(clazz -> {
+                String getItemsBody = clazz.getMethodsByName("getItems").get(0).getBody().get().toString()
+                    .replace("return this.items;", "return new ArrayList<>(this.items);");
+                clazz.getMethodsByName("getItems").get(0).setBody(StaticJavaParser.parseBlock(getItemsBody));
+            });
+        });
+    }
+
+    private void customizeActionGroupContent(PackageCustomization modelsPackage) {
+        modelsPackage.getClass("ActionGroupContent").customizeAst(ast -> {
+            ast.getClassByName("ActionGroupContent")
+                .flatMap(clazz -> clazz.getConstructorByParameterTypes(String.class, List.class))
+                .ifPresent(c -> {
+                    String body = c.getBody().toString().replace("this.groups = groups;",
+                        "this.groups = new ArrayList<>(groups);");
+                    c.setBody(StaticJavaParser.parseBlock(body));
+                });
+
+            ast.getClassByName("ActionGroupContent").ifPresent(clazz -> {
+                String getItemsBody = clazz.getMethodsByName("getGroups").get(0).getBody().get().toString()
+                    .replace("return this.groups;", "return new ArrayList<>(this.groups);");
+                clazz.getMethodsByName("getGroups").get(0).setBody(StaticJavaParser.parseBlock(getItemsBody));
+            });
+        });
+    }
+
+    private void customizeButtonSetContent(PackageCustomization modelsPackage) {
+        modelsPackage.getClass("ButtonSetContent").customizeAst(ast -> {
+            ast.getClassByName("ButtonSetContent")
+                .flatMap(clazz -> clazz.getConstructorByParameterTypes(List.class))
+                .ifPresent(c -> {
+                    String body = c.getBody().toString().replace("this.buttons = buttons;",
+                        "this.buttons = new ArrayList<>(buttons);");
+                    c.setBody(StaticJavaParser.parseBlock(body));
+                });
+
+            ast.getClassByName("ButtonSetContent").ifPresent(clazz -> {
+                String getItemsBody = clazz.getMethodsByName("getButtons").get(0).getBody().get().toString()
+                    .replace("return this.buttons;", "return new ArrayList<>(this.buttons);");
+                clazz.getMethodsByName("getButtons").get(0).setBody(StaticJavaParser.parseBlock(getItemsBody));
+            });
+        });
+    }
 }

sdk/communication/azure-communication-messages/src/main/java/com/azure/communication/messages/MessagesServiceVersion.java

@@ -18,7 +18,12 @@ public enum MessagesServiceVersion implements ServiceVersion {
     /**
      * Enum value 2024-08-30.
      */
-    V2024_08_30("2024-08-30");
+    V2024_08_30("2024-08-30"),
+
+    /**
+     * Enum value 2025-01-15-preview.
+     */
+    V2025_01_15_PREVIEW("2025-01-15-preview");
 
     private final String version;
 
@@ -40,6 +45,6 @@ public String getVersion() {
      * @return The latest {@link MessagesServiceVersion}.
      */
     public static MessagesServiceVersion getLatest() {
-        return V2024_08_30;
+        return V2025_01_15_PREVIEW;
     }
 }

sdk/communication/azure-communication-messages/src/main/java/com/azure/communication/messages/NotificationMessagesAsyncClient.java

@@ -55,7 +55,7 @@ public final class NotificationMessagesAsyncClient {
      * <pre>
      * {@code
      * {
-     *     kind: String(text/image/image_v0/document/video/audio/template) (Required)
+     *     kind: String(text/image/image_v0/document/video/audio/template/sticker/reaction/interactive) (Required)
      *     channelRegistrationId: String (Required)
      *     to (Required): [
      *         String (Required)

sdk/communication/azure-communication-messages/src/main/java/com/azure/communication/messages/NotificationMessagesClient.java

@@ -53,7 +53,7 @@ public final class NotificationMessagesClient {
      * <pre>
      * {@code
      * {
-     *     kind: String(text/image/image_v0/document/video/audio/template) (Required)
+     *     kind: String(text/image/image_v0/document/video/audio/template/sticker/reaction/interactive) (Required)
      *     channelRegistrationId: String (Required)
      *     to (Required): [
      *         String (Required)