Add support for more media message types

specification/communication/Communication.Messages/examples/2024-08-30-preview/NotificationMessages_SendAudio.json

@@ -0,0 +1,30 @@
+{
+  "title": "Sends a notification message - audio",
+  "operationId": "NotificationMessagesOperations_Send",
+  "parameters": {
+    "api-version": "2024-08-30-preview",
+    "content-type": "application/json",
+    "body": {
+      "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
+      "to": [
+        "14250000000"
+      ],
+      "kind": "audio",
+      "mediaUri": "https://example.com/audio.mp44",
+      "content": "check out this audio!"
+    },
+    "endpoint": "https://my-resource.communication.azure.com"
+  },
+  "responses": {
+    "202": {
+      "body": {
+        "receipts": [
+          {
+            "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
+            "to": "14250000000"
+          }
+        ]
+      }
+    }
+  }
+}

specification/communication/Communication.Messages/examples/2024-08-30-preview/NotificationMessages_SendDocument.json

@@ -0,0 +1,30 @@
+{
+  "title": "Sends a notification message - document",
+  "operationId": "NotificationMessagesOperations_Send",
+  "parameters": {
+    "api-version": "2024-08-30-preview",
+    "content-type": "application/json",
+    "body": {
+      "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
+      "to": [
+        "14250000000"
+      ],
+      "kind": "document",
+      "mediaUri": "https://example.com/document.pdf",
+      "content": "check out this document!"
+    },
+    "endpoint": "https://my-resource.communication.azure.com"
+  },
+  "responses": {
+    "202": {
+      "body": {
+        "receipts": [
+          {
+            "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
+            "to": "14250000000"
+          }
+        ]
+      }
+    }
+  }
+}

specification/communication/Communication.Messages/examples/2024-08-30-preview/NotificationMessages_SendImage.json

@@ -0,0 +1,30 @@
+{
+  "title": "Sends a notification message - image",
+  "operationId": "NotificationMessagesOperations_Send",
+  "parameters": {
+    "api-version": "2024-08-30-preview",
+    "content-type": "application/json",
+    "body": {
+      "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
+      "to": [
+        "14250000000"
+      ],
+      "kind": "image",
+      "mediaUri": "https://example.com/image.jpg",
+      "content": "check out this image!"
+    },
+    "endpoint": "https://my-resource.communication.azure.com"
+  },
+  "responses": {
+    "202": {
+      "body": {
+        "receipts": [
+          {
+            "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
+            "to": "14250000000"
+          }
+        ]
+      }
+    }
+  }
+}

specification/communication/Communication.Messages/examples/2024-08-30-preview/NotificationMessages_SendTemplate.json

@@ -0,0 +1,55 @@
+{
+  "title": "Sends a notification message - Template",
+  "operationId": "NotificationMessagesOperations_Send",
+  "parameters": {
+    "api-version": "2024-08-30-preview",
+    "content-type": "application/json",
+    "body": {
+      "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
+      "to": [
+        "14250000000"
+      ],
+      "kind": "template",
+      "template": {
+        "name": "example",
+        "language": "en",
+        "values": [
+          {
+            "name": "userName",
+            "kind": "text",
+            "text": "John Doe"
+          },
+          {
+            "name": "orderNumber",
+            "kind": "text",
+            "text": "12345"
+          }
+        ],
+        "bindings": {
+          "body": [
+            {
+              "refValue": "userName"
+            },
+            {
+              "refValue": "orderNumber"
+            }
+          ],
+          "kind": "whatsApp"
+        }
+      }
+    },
+    "endpoint": "https://my-resource.communication.azure.com"
+  },
+  "responses": {
+    "202": {
+      "body": {
+        "receipts": [
+          {
+            "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
+            "to": "14250000000"
+          }
+        ]
+      }
+    }
+  }
+}

specification/communication/Communication.Messages/examples/2024-08-30-preview/NotificationMessages_SendText.json

@@ -0,0 +1,29 @@
+{
+  "title": "Sends a notification message - text",
+  "operationId": "NotificationMessagesOperations_Send",
+  "parameters": {
+    "api-version": "2024-08-30-preview",
+    "content-type": "application/json",
+    "body": {
+      "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
+      "to": [
+        "14250000000"
+      ],
+      "kind": "text",
+      "content": "Text message through CPM"
+    },
+    "endpoint": "https://my-resource.communication.azure.com"
+  },
+  "responses": {
+    "202": {
+      "body": {
+        "receipts": [
+          {
+            "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
+            "to": "14250000000"
+          }
+        ]
+      }
+    }
+  }
+}

specification/communication/Communication.Messages/examples/2024-08-30-preview/NotificationMessages_SendVideo.json

@@ -0,0 +1,30 @@
+{
+  "title": "Sends a notification message - video",
+  "operationId": "NotificationMessagesOperations_Send",
+  "parameters": {
+    "api-version": "2024-08-30-preview",
+    "content-type": "application/json",
+    "body": {
+      "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
+      "to": [
+        "14250000000"
+      ],
+      "kind": "video",
+      "mediaUri": "https://example.com/video.mp44",
+      "content": "check out this video!"
+    },
+    "endpoint": "https://my-resource.communication.azure.com"
+  },
+  "responses": {
+    "202": {
+      "body": {
+        "receipts": [
+          {
+            "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
+            "to": "14250000000"
+          }
+        ]
+      }
+    }
+  }
+}

specification/communication/Communication.Messages/examples/2024-08-30-preview/Stream_GetMedia.json

@@ -0,0 +1,15 @@
+{
+  "title": "Download media",
+  "operationId": "StreamOperations_GetMedia",
+  "parameters": {
+    "api-version": "2024-08-30-preview",
+    "content-type": "application/json",
+    "id": "d19e68ec-bdd6-4a50-8dfb-cbb1642df6ab",
+    "endpoint": "https://my-resource.communication.azure.com"
+  },
+  "responses": {
+    "200": {
+      "body": "<binary_media_data>"
+    }
+  }
+}

specification/communication/Communication.Messages/examples/2024-08-30-preview/Template_ListTemplates.json

@@ -0,0 +1,35 @@
+{
+  "title": "Gets a list of templates",
+  "operationId": "TemplateOperations_ListTemplates",
+  "parameters": {
+    "api-version": "2024-08-30-preview",
+    "content-type": "application/json",
+    "channelId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
+    "endpoint": "https://my-resource.communication.azure.com"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "name": "sample_shipping_confirmation",
+            "language": "en_US",
+            "status": "approved",
+            "kind": "whatsApp",
+            "content": [
+              {
+                "type": "BODY",
+                "text": "Your package has been shipped. It will be delivered in {{1}} business days."
+              },
+              {
+                "type": "FOOTER",
+                "text": "This message is from an unverified business."
+              }
+            ]
+          }
+        ],
+        "nextLink": null
+      }
+    }
+  }
+}

specification/communication/Communication.Messages/models.tsp

@@ -14,7 +14,7 @@ using Azure.Core.Traits;
 @versioned(Azure.Communication.MessagesService.Versions)
 namespace Azure.Communication.MessagesService;
 
-@doc("The type of message. Supports text, image, template.")
+@doc("The type of message.")
 union CommunicationMessageKind {
   string,
 
@@ -24,6 +24,18 @@ union CommunicationMessageKind {
   @doc("Image message type.")
   image: "image",
 
+  @added(Versions.c2024_08_30_Preview)
+  @doc("Document message type.")
+  document: "document",
+
+  @added(Versions.c2024_08_30_Preview)
+  @doc("Video message type.")
+  video: "video",
+
+  @added(Versions.c2024_08_30_Preview)
+  @doc("Audio message type.")
+  audio: "audio",
+
   @doc("Template message type.")
   template: "template",
 }
@@ -117,11 +129,9 @@ model TextNotificationContent extends NotificationContent {
   content: string;
 }
 
-@doc("A request to send a media notification.")
-model MediaNotificationContent extends NotificationContent {
-  @doc("Message notification type is image.")
-  kind: CommunicationMessageKind.image;
-
+@added(Versions.c2024_08_30_Preview)
+@doc("A request to send a media notification. Could be an image, document or video.")
+model MediaNotificationContent {
   @doc("Optional text content.")
   content?: string;
 
@@ -130,6 +140,45 @@ model MediaNotificationContent extends NotificationContent {
   mediaUri: url;
 }
 
+@renamedFrom(Versions.c2024_08_30_Preview, "MediaNotificationContent")
+@doc("A request to send an image notification.")
+model ImageNotificationContent extends NotificationContent {
+  @doc("Message notification type is image.")
+  kind: CommunicationMessageKind.image;
+
+  ...MediaNotificationContent;
+}
+
+@added(Versions.c2024_08_30_Preview)
+@doc("A request to send a document notification.")
+model DocumentNotificationContent extends NotificationContent {
+  @doc("Message notification type is image.")
+  kind: CommunicationMessageKind.document;
+
+  @doc("Optional name for the file.")
+  fileName?: string;
+
+  ...MediaNotificationContent;
+}
+
+@added(Versions.c2024_08_30_Preview)
+@doc("A request to send a video notification.")
+model VideoNotificationContent extends NotificationContent {
+  @doc("Message notification type is image.")
+  kind: CommunicationMessageKind.video;
+
+  ...MediaNotificationContent;
+}
+
+@added(Versions.c2024_08_30_Preview)
+@doc("A request to send an audio notification.")
+model AudioNotificationContent extends NotificationContent {
+  @doc("Message notification type is audio.")
+  kind: CommunicationMessageKind.audio;
+
+  ...MediaNotificationContent;
+}
+
 @doc("A request to send a template notification.")
 model TemplateNotificationContent extends NotificationContent {
   @doc("Message notification type is template.")
@@ -368,16 +417,20 @@ alias ListTemplatesQueryParams = ListQueryParametersTrait<{
   maxpagesize?: int32;
 }>;
 
+@doc("Notification messages send request body.")
+model NotificationMessagesSendRequestBody {
+  @doc("Details of the message to send.")
+  @bodyRoot
+  body: NotificationContent;
+}
+
 @doc("Azure Communication Messages Versions")
 enum Versions {
   @doc("Azure Communication Messages 2024-02-01 api version")
   @useDependency(Azure.Core.Versions.v1_0_Preview_2)
   c2024_02_01: "2024-02-01",
-}
 
-@doc("Notification messages send request body.")
-model NotificationMessagesSendRequestBody {
-  @doc("Details of the message to send.")
-  @bodyRoot
-  body: NotificationContent;
+  @doc("Azure Communication Messages 2024-08-30-preview api version")
+  @useDependency(Azure.Core.Versions.v1_0_Preview_2)
+  c2024_08_30_Preview: "2024-08-30-preview",
 }