ChatMessage.Read.Chat

Merill's Note

For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the ChatMessage.Read.Chat permission.

If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the Export-MsIdAppConsentGrantReport command. See How To: Run a quick OAuth app audit of your tenant

Category	Application	Delegated
Identifier	-	-
DisplayText	-	-
Description	-	-
AdminConsentRequired	-	-

Graph Methods

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods
	GET /chats/{chat-id}/messages
	GET /me/chats/{chat-id}/messages
	GET /users/{user-id \| user-principal-name}/chats/{chat-id}/messages

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods
	GET /chats/{chat-id}/messages
	GET /me/chats/{chat-id}/messages
	GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}
	GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/hostedContents
	GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/hostedContents/{hosted-content-id}
	GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/replies/{reply-id}
	GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/replies/{reply-id}/hostedContents
	GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/replies/{reply-id}/hostedContents/{hosted-content-id}
	GET /users/{user-id \| user-principal-name}/chats/{chat-id}/messages

	Commands
	Get-MgChatMessage

→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)

	Commands
	Get-MgBetaChatMessage
	Get-MgBetaChatMessageHostedContent

Resources

Granting this permission allows the calling application to access (and/or update) the following information in your tenant.

Graph reference: change-notifications-api-overview

Graph reference: channel

Property	Type	Description
createdDateTime	dateTimeOffset	Read only. Timestamp at which the channel was created.
description	String	Optional textual description for the channel.
displayName	String	Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters.
email	String	The email address for sending messages to the channel. Read-only.
id	String	The channel's unique identifier. Read-only.
isArchived	Boolean	Indicates whether the channel is archived. Read-only.
isFavoriteByDefault	Boolean	Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list. Note: All recommended channels automatically show in the channels list for education and frontline worker users. The property can only be set programmatically via the Create team method. The default value is `false`.
membershipType	channelMembershipType	The type of the channel. Can be set during creation and can't be changed. The possible values are: `standard`, `private`, `unknownFutureValue`, `shared`. The default value is `standard`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value in this evolvable enum: `shared`.
tenantId	string	The ID of the Microsoft Entra tenant.
webUrl	String	A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.
summary	channelSummary	Contains summary information about the channel, including number of owners, members, guests, and an indicator for members from other tenants. The **s

Graph reference: chat

Property	Type	Description
chatType	chatType	Specifies the type of chat. Possible values are: `group`, `oneOnOne`, `meeting`, `unknownFutureValue`.
createdDateTime	dateTimeOffset	Date and time at which the chat was created. Read-only.
id	String	The chat's unique identifier. Read-only.
lastUpdatedDateTime	dateTimeOffset	Date and time at which the chat was renamed or the list of members was last changed. Read-only.
onlineMeetingInfo	teamworkOnlineMeetingInfo	Represents details about an online meeting. If the chat isn't associated with an online meeting, the property is empty. Read-only.
tenantId	String	The identifier of the tenant in which the chat was created. Read-only.
topic	String	(Optional) Subject or topic for the chat. Only available for group chats.
viewpoint	chatViewpoint	Represents caller-specific information about the chat, such as the last message read date and time. This property is populated only when the request is made in a delegated context.
webUrl	String	The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.

Graph reference: chatMessage

Property	Type	Description
attachments	chatMessageAttachment collection	References to attached objects like files, tabs, meetings etc.
body	itemBody	Plaintext/HTML representation of the content of the chat message. Representation is specified by the contentType inside the body. The content is always in HTML if the chat message contains a chatMessageMention.
chatId	string	If the message was sent in a chat, represents the identity of the chat.
channelIdentity	channelIdentity	If the message was sent in a channel, represents identity of the channel.
createdDateTime	dateTimeOffset	Timestamp of when the chat message was created.
deletedDateTime	dateTimeOffset	Read only. Timestamp at which the chat message was deleted, or null if not deleted.
etag	string	Read-only. Version number of the chat message.
eventDetail	eventMessageDetail	Read-only. If present, represents details of an event that happened in a chat, a channel, or a team, for example, adding new members. For event messages, the messageType property will be set to `systemEventMessage`.
from	chatMessageFromIdentitySet	Details of the sender of the chat message. Can only be set during migration.
id	String	Read-only. Unique ID of the message. IDs are unique within a chat/channel/reply-to-message, but might be duplicated in other chats/channels/reply-to-messages.
importance	string	The importance of the chat message. The possible values are: `normal`, `high`, `urgent`.
lastModifiedDateTime	dateTimeOffset	Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
lastEditedDateTime	dateTimeOffset	Read only. Timestamp when edits to the chat message were made. Triggers an "Edited" flag in the Teams UI. If no edits are made the value is `null`.
locale	string	Locale of the chat message set by the client. Always set to `en-us`.
mentions	chatMessageMention collection	List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel.
messageHistory	chatMessageHistoryItem collection	List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
messageType	chatMessageType	The type of chat message. The possible values are: `message`, `chatEvent`, `typing`, `unknownFutureValue`, `systemEventMessage`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value in this evolvable enum: `systemEventMessage`.
policyViolation	chatMessagePolicyViolation	Defines the properties of a policy violation set by a data loss prevention (DLP) application.
reactions	chatMessageReaction collection	Reactions for this chat message (for example, Like).
replyToId	string	Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)
subject	string	The subject of the chat message, in plaintext.
summary	string	Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
webUrl	string	Read-only. Link to the message in Microsoft Teams.

Graph reference: chatMessageHostedContent

Property	Type	Description
contentBytes	Edm.Binary	Write-only. When posting new chat message hosted content, represents the bytes of the payload and are represented as a base64 encoded string.
contentType	String	Write-only. When posting new chat message hosted content, represents the type of content, such as image/png.
id	String	Read-only. Represents the chat message hosted content identifier.

Graph reference: team

Property	Type	Description
id	string	The unique identifier of the team. The group has the same ID as the team. This property is read-only, and is inherited from the base entity type.
classification	string	An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory.
classSettings	teamClassSettings	Configure settings of a class. Available only when the team represents a class.
createdDateTime	dateTimeOffset	Timestamp at which the team was created.
description	string	An optional description for the team. Maximum length: 1024 characters.
displayName	string	The name of the team.
funSettings	teamFunSettings	Settings to configure use of Giphy, memes, and stickers in the team.
guestSettings	teamGuestSettings	Settings to configure whether guests can create, update, or delete channels in the team.
internalId	string	A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.
isArchived	Boolean	Whether this team is in read-only mode.
memberSettings	teamMemberSettings	Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team.
messagingSettings	teamMessagingSettings	Settings to configure messaging and mentions in the team.
specialization	teamSpecialization	Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case.
summary	teamSummary	Contains summary information about the team, including number of owners, members, and guests.
tenantId	string	The ID of the Microsoft Entra tenant.
visibility	teamVisibilityType	The visibility of the group and team. Defaults to Public.
webUrl	string (readonly)	A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select **G

Table of Contents

ChatMessage.Read.Chat

Graph Methods

Resources