Merge pull request #25358 from microsoftgraph/users/sumanac/getforwardedmessage

Lauragra · web-flow · commit e435db3a0e7d · 2024-10-22T18:23:11.000-07:00
Get forwarded message as an attachment
diff --git a/api-reference/beta/api/chatmessage-get.md b/api-reference/beta/api/chatmessage-get.md
@@ -658,6 +658,89 @@ Content-type: application/json
 }
 ```
 
+### Example 6: Get a chat message with a forwarded message
+
+The following example shows a request that gets a chat message with a forwarded message as an attachment.
+
+#### Request
+
+The following example shows a request.
+
+<!-- {
+  "blockType": "request",
+  "name": "get_chatmessage_6",
+  "sampleKeys": ["19:e2ed97baac8e4bffbb91299a38996790@thread.v2", "1727903166936"]
+}-->
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/chats/19:e2ed97baac8e4bffbb91299a38996790@thread.v2/messages/1727903166936
+```
+
+#### Response
+
+The following example shows the response. The message body contains a forwarded message as an attachment. The **contentType** for the forwarded message is identified as `forwardedMessageReference`. The original message that was forwarded is also available in the attachment **content**.
+
+<!-- {
+  "blockType": "response",
+  "truncated": true,
+  "@odata.type": "microsoft.graph.chatMessage"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+    "@odata.context": "https://graph.microsoft.com/beta/$metadata#chats('19%3Ae2ed97baac8e4bffbb91299a38996790%40thread.v2')/messages/$entity",
+    "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET chats('<key>')/messages('<key>')?$select=attachments,body",
+    "id": "1727903166936",
+    "replyToId": null,
+    "etag": "1727903166936",
+    "messageType": "message",
+    "createdDateTime": "2024-10-02T21:06:06.936Z",
+    "lastModifiedDateTime": "2024-10-02T21:06:06.936Z",
+    "lastEditedDateTime": null,
+    "deletedDateTime": null,
+    "subject": null,
+    "summary": null,
+    "chatId": "19:e2ed97baac8e4bffbb91299a38996790@thread.v2",
+    "importance": "normal",
+    "locale": "en-us",
+    "webUrl": null,
+    "channelIdentity": null,
+    "onBehalfOf": null,
+    "policyViolation": null,
+    "eventDetail": null,
+    "from": {
+        "application": null,
+        "device": null,
+        "user": {
+            "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+            "id": "28c10244-4bad-4fda-993c-f332faef94f0",
+            "displayName": null,
+            "userIdentityType": "aadUser",
+            "tenantId": "2432b57b-0abd-43db-aa7b-16eadd115d34"
+        }
+    },
+    "body": {
+        "contentType": "html",
+        "content": "<attachment id=\"1727881360458\"></attachment>"
+    },
+    "attachments": [
+        {
+            "id": "1727881360458",
+            "contentType": "forwardedMessageReference",
+            "contentUrl": null,
+            "content": "{\"originalMessageId\":\"1727881360458\",\"originalMessageContent\":\"\\n<p>hello</p>\\n\",\"originalConversationId\":\"19:97641583cf154265a237da28ebbde27a@thread.v2\",\"originalSentDateTime\":\"2024-10-02T15:02:40.458+00:00\",\"originalMessageSender\":{\"application\":null,\"device\":null,\"user\":{\"userIdentityType\":\"aadUser\",\"tenantId\":\"2432b57b-0abd-43db-aa7b-16eadd115d34\",\"id\":\"28c10244-4bad-4fda-993c-f332faef94f0\",\"displayName\":null}}}",
+            "name": null,
+            "thumbnailUrl": null,
+            "teamsAppId": null
+        }
+    ],
+    "mentions": [],
+    "reactions": []
+}
+```
+
 ## Related content
 
 - [List messages in a channel](channel-list-messages.md)
diff --git a/api-reference/beta/resources/chatmessageattachment.md b/api-reference/beta/resources/chatmessageattachment.md
@@ -15,15 +15,15 @@ Namespace: microsoft.graph
 
 Represents an attachment to a chat message entity.
 
-An entity of type `chatMessageAttachment` is returned as part of the [Get channel messages](../api/channel-list-messages.md) API, as a part of [chatMessage](chatmessage.md) entity.
+An entity of type **chatMessageAttachment** is returned as part of the [Get channel messages](../api/channel-list-messages.md) API, as a part of [chatMessage](chatmessage.md) entity.
 
 ## Properties
 | Property	   | Type	|Description|
 |:---------------|:--------|:----------|
-|id|string| Read-only. The unique id of the attachment.|
-|contentType| string | The media type of the content attachment. It can have the following values: <br><ul><li>`reference`: Attachment is a link to another file. Populate the <b>contentURL</b> with the link to the object.</li><li>Any <b>contentType</b> that is supported by the Bot Framework's [Attachment object](/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference?#attachment-object).</li><li>`application/vnd.microsoft.card.codesnippet`: A code snippet. </li><li>`application/vnd.microsoft.card.announcement`: An announcement header. </li>|
-|contentUrl|string|The URL for the content of the attachment. |
 |content|string|The content of the attachment. If the attachment is a [rich card](/microsoftteams/platform/task-modules-and-cards/cards/cards-reference), set the property to the rich card object. This property and **contentUrl** are mutually exclusive.|
+|contentType| string | The media type of the content attachment. The possible values are: <br><ul><li>`reference`: The attachment is a link to another file. Populate the <b>contentURL</b> with the link to the object.</li><li>`forwardedMessageReference`: The attachment is a reference to a forwarded message. Populate the <b>content</b> with the original message context.</li><li>Any <b>contentType</b> that is supported by the Bot Framework's [Attachment object](/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference?#attachment-object).</li><li>`application/vnd.microsoft.card.codesnippet`: A code snippet. </li><li>`application/vnd.microsoft.card.announcement`: An announcement header. </li>|
+|contentUrl|string|The URL for the content of the attachment. |
+|id|string| Read-only. The unique ID of the attachment.|
 |name|string|Name of the attachment.|
 |teamsAppId| string |The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.|
 |thumbnailUrl| string |The URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of **content** or **contentUrl**. For example, if you set **contentType** to application/word and set **contentUrl** to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user selects the image, the channel would open the document.|
@@ -46,10 +46,10 @@ An entity of type `chatMessageAttachment` is returned as part of the [Get channe
 
 ```json
 {
-  "id": "string (identifier)",
+  "content": "string",
   "contentType": "string",
   "contentUrl": "string",
-  "content": "string",
+  "id": "string (identifier)",
   "name": "string",
   "teamsAppId": "string",
   "thumbnailUrl": "string"
diff --git a/changelog/Microsoft.Teams.Core.json b/changelog/Microsoft.Teams.Core.json
@@ -5645,6 +5645,24 @@
       "CreatedDateTime": "2024-09-16T18:15:55.2254479Z",
       "WorkloadArea": "Teamwork and communications",
       "SubArea": "Messaging"
+    },
+    {
+      "ChangeList": [ 
+        {
+          "Id": "3a5a736c-80cd-4f40-b4dc-d3c3a6ea14c0",
+          "ApiChange": "Property",
+          "ChangedApiName": "contentType",
+          "ChangeType": "Change",
+          "Description": "Added `forwardedMessageReference` as a supported value for the **contentType** property in the [chatMessageAttachment](https://learn.microsoft.com/en-us/graph/api/resources/chatmessageattachment?view=graph-rest-beta) resource.",
+          "Target": "chatMessageAttachment"
+        }
+      ],
+      "Id": "3a5a736c-80cd-4f40-b4dc-d3c3a6ea14c0",
+      "Cloud": "Prod",
+      "Version": "beta",
+      "CreatedDateTime": "2024-10-22T18:15:55.2254479Z",
+      "WorkloadArea": "Teamwork and communications",
+      "SubArea": "Messaging"
     }
   ]
 }
diff --git a/concepts/teams-messaging-overview.md b/concepts/teams-messaging-overview.md
@@ -22,47 +22,6 @@ The [chatMessage](/graph/api/resources/chatMessage) resource type represents mes
 
 The [chatMessageAttachment](/graph/api/resources/chatmessageattachment) resource type represents entities that can be referenced from a [chatMessage](/graph/api/resources/chatMessage?preserve-view=true). These entities include files, tabs, cards, meetings, or other messages. The items themselves might be located somewhere else. For example, files might be stored in SharePoint. The following sections describe the possible types of attachments on a **chatMessage** object.
 
-#### file attachment
-
-When an [attachment](/graph/api/resources/chatmessageattachment) object refers to a file, it contains information about the file, including the link to open the file. The file itself is located in an accessible store like SharePoint. When a **chatMessage** has an attachment of type file, the value of the **contentType** property on the [attachment](/graph/api/resources/chatmessageattachment) resource is set to `reference`, and the **contentUrl** property contains the file URL.
-
-> **Note:** The SharePoint URL is the link that opens the file; it is not the Microsoft Graph URL. Callers can, however, use the [access shared items](/graph/api/shares-get) API to get the information about the contents of the file.
-
-The following example shows the schema for a file attachment.
-
-```json
-    "attachments": [
-        {
-            "id": "924D1F74-E0D2-4927-8A67-15ECEF455527",
-            "contentType": "reference",
-            "contentUrl": "https://testing.sharepoint.com/sites/Samples/Shared Documents/General/color.png",
-            "content": null,
-            "name": "color.png",
-            "thumbnailUrl": null,
-            "teamsAppId": null
-        }
-    ],
-```
-
-#### tab attachment
-
-When an [attachment](/graph/api/resources/chatmessageattachment) object refers to a [tab](/graph/api/resources/teamstab) hosted in the present context, the **contentType** property is set to `tabReference`, the **id** property is set to the ID of the tab, and the **name** property is set to the tab name. This scenario often applies when tabs are newly added. 
-
-The following example shows the schema for an tab attachment.
-
-``` json
-"attachments": [
-        {
-            "id": "tab::d64ea8d0-8b63-4f53-9bf6-806648176968",
-            "contentType": "tabReference",
-            "contentUrl": null,
-            "content": null,
-            "name": "Bing",
-            "thumbnailUrl": null,
-            "teamsAppId": null
-        }
-    ],
-```
 #### card attachment
 
 Cards represent visual elements backed by a predefined schema. Teams supports the cards defined by the [Bot Framework](/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference?view=azure-bot-service-4.0&preserve-view=true#attachment-object) in addition to the following card types:
@@ -108,7 +67,49 @@ The following example shows the schema for an adaptive card attachment when the
     ]
 ```
 
-> **Note:** Microsoft Graph only supports cards that have the **OpenUrl** action set. Other actions like **ShowCard** are not supported. Microsoft Graph does allow messages posted by bots that have other actions in them to be read.
+> **Note:** Microsoft Graph only supports cards that have the **OpenUrl** action set. Other actions like **ShowCard** aren't supported. Microsoft Graph does allow messages posted by bots that have other actions in them to be read.
+
+#### file attachment
+
+When an [attachment](/graph/api/resources/chatmessageattachment) object refers to a file, it contains information about the file, including the link to open the file. The file itself is located in an accessible store like SharePoint. When a **chatMessage** has an attachment of type file, the value of the **contentType** property on the [attachment](/graph/api/resources/chatmessageattachment) resource is set to `reference`, and the **contentUrl** property contains the file URL.
+
+> **Note:** The SharePoint URL is the link that opens the file; it isn't the Microsoft Graph URL. Callers can, however, use the [access shared items](/graph/api/shares-get) API to get the information about the contents of the file.
+
+The following example shows the schema for a file attachment.
+
+```json
+    "attachments": [
+        {
+            "id": "924D1F74-E0D2-4927-8A67-15ECEF455527",
+            "contentType": "reference",
+            "contentUrl": "https://testing.sharepoint.com/sites/Samples/Shared Documents/General/color.png",
+            "content": null,
+            "name": "color.png",
+            "thumbnailUrl": null,
+            "teamsAppId": null
+        }
+    ],
+```
+
+#### forwarded message attachment
+
+An [attachment](/graph/api/resources/chatmessageattachment) object contains a forwarded message that was forwarded to a [chat](/graph/api/resources/chat). For message attachments, the **id** property contains the ID of the forwarded message. The **content** property contains more details about the message; for example, the original message context and original sender detail. For message attachments, the **contentType** property is set to `forwardedMessageReference`.
+
+The following example shows the schema for a forwarded message attachment.
+
+```json
+    "attachments": [
+        {
+            "id": "1727881360458",
+            "contentType": "forwardedMessageReference",
+            "contentUrl": null,
+            "content": "{\"originalMessageId\":\"1727881360458\",\"originalMessageContent\":\"\\n<p>hello</p>\\n\",\"originalConversationId\":\"19:97641583cf154265a237da28ebbde27a@thread.v2\",\"originalSentDateTime\":\"2024-10-02T15:02:40.458+00:00\",\"originalMessageSender\":{\"application\":null,\"device\":null,\"user\":{\"userIdentityType\":\"aadUser\",\"tenantId\":\"2432b57b-0abd-43db-aa7b-16eadd115d34\",\"id\":\"28c10244-4bad-4fda-993c-f332faef94f0\",\"displayName\":null}}}",
+            "name": null,
+            "thumbnailUrl": null,
+            "teamsAppId": null
+        }
+    ],
+```
 
 #### meeting attachment
 
@@ -147,6 +148,26 @@ The following example shows the schema for a message attachment.
     ],
 ```
 
+#### tab attachment
+
+When an [attachment](/graph/api/resources/chatmessageattachment) object refers to a [tab](/graph/api/resources/teamstab) hosted in the present context, the **contentType** property is set to `tabReference`, the **id** property is set to the ID of the tab, and the **name** property is set to the tab name. This scenario often applies when tabs are newly added. 
+
+The following example shows the schema for an tab attachment.
+
+``` json
+"attachments": [
+        {
+            "id": "tab::d64ea8d0-8b63-4f53-9bf6-806648176968",
+            "contentType": "tabReference",
+            "contentUrl": null,
+            "content": null,
+            "name": "Bing",
+            "thumbnailUrl": null,
+            "teamsAppId": null
+        }
+    ],
+```
+
 ### body
 
 The **body** property of a **chatMessage** object represents the body of the message. The **body** property can refer to other elements in the schema such as mentions or attachments. The contents can be `text` or `html`, as specified by the **contentType** property of the [itemBody](/graph/api/resources/itembody) resource type.
diff --git a/concepts/whats-new-overview.md b/concepts/whats-new-overview.md
@@ -103,6 +103,7 @@ The Microsoft Entra Health monitoring alerts APIs enable you to detect anomalous
 ### Teamwork and communications | Messaging
 
 - Updated the [chatMessage: delta](/graph/api/chatmessage-delta?view=graph-rest-beta&preserve-view=true) method to use a new endpoint that gets the list of delta messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats.
+- [Get](/graph/api/chatmessage-get?view=graph-rest-beta&preserve-view=true#example-6-get-a-chat-message-with-a-forwarded-message) a chat message that has a forwarded message as an attachment.
 - [Remove multiple members](/graph/api/conversationmember-remove?view=graph-rest-beta&preserve-view=true) from a [team](/graph/api/resources/team?view=graph-rest-beta&preserve-view=true) in a single request.
 
 ### Users
