ChatMessage.Read.All | Graph Permissions

Permission Details

Application Permission

Read all chat messages

Allows the app to read all one-to-one and group chats messages in Microsoft Teams, without a signed-in user.

Permission ID: b9bb2381-47a4-46cd-aafb-00cb12f68504

Properties

Microsoft Graph v1.0 exact-category-docs

Properties is shown from stable Microsoft Graph v1.0 metadata.

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`Nullable	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`Nullable	Timestamp of when the chat message was created.
`deletedDateTime`	`dateTimeOffset`Nullable	Read only. Timestamp at which the chat message was deleted, or null if not deleted.
`etag`	`string`Nullable	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`Nullable	Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
`lastEditedDateTime`	`dateTimeOffset`Nullable	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, channel, chat, and tag.

Showing 15 of 25 properties.

JSON Representation

Microsoft Graph v1.0 exact-category-docs

JSON representation is shown from stable Microsoft Graph v1.0 metadata.

JSON representation

{
  "attachments": [
    {
      "@odata.type": "microsoft.graph.chatMessageAttachment"
    }
  ],
  "body": {
    "@odata.type": "microsoft.graph.itemBody"
  },
  "channelIdentity": {
    "@odata.type": "microsoft.graph.channelIdentity"
  },
  "chatId": "String",
  "createdDateTime": "String (timestamp)",
  "deletedDateTime": "String (timestamp)",
  "etag": "String",
  "eventDetail": {
    "@odata.type": "microsoft.graph.eventMessageDetail"
  },
  "from": {
    "@odata.type": "microsoft.graph.chatMessageFromIdentitySet"
  },
  "id": "String (identifier)",
  "importance": "String",
  "lastEditedDateTime": "String (timestamp)",
  "lastModifiedDateTime": "String (timestamp)",
  "locale": "String",
  "mentions": [
    {
      "@odata.type": "microsoft.graph.chatMessageMention"
    }
  ],
  "messageHistory": [
    {
      "@odata.type": "microsoft.graph.chatMessageHistoryItem"
    }
  ],
  "messageType": "String",
  "policyViolation": {
    "@odata.type": "microsoft.graph.chatMessagePolicyViolation"
  },
  "reactions": [
    {
      "@odata.type": "microsoft.graph.chatMessageReaction"
    }
  ],
  "replyToId": "String (identifier)",
  "subject": "String",
  "summary": "String",
  "webUrl": "String"
}

Relationships

Microsoft Graph v1.0 exact-category-docs

Relationships is shown from stable Microsoft Graph v1.0 metadata.

Relationship	Type	Description
`hostedContents`	`chatMessageHostedContent collection`	Content in a message hosted by Microsoft Teams - for example, images or code snippets.
`replies`	`chatMessage collection`	Replies for a specified message. Supports $expand for channel messages.
`attachments`	`chatMessageAttachment collection`	References to attached objects like files, tabs, meetings etc.
`body`	`itemBody`	Related body data exposed by this resource.
`importance`	`chatMessageImportance`	Related importance data exposed by this resource.
`mentions`	`chatMessageMention collection`	List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, chat, and tag.
`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`	Related messageType data exposed by this resource.
`reactions`	`chatMessageReaction collection`	Reactions for this chat message (for example, Like).

Graph Methods

Delegated access App-only access

Exact Microsoft Learn match

Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/chats/{chat-id}/pinnedMessages`

Exact Microsoft Learn match

Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/chats/{chat-id}/pinnedMessages`

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgChatPinnedMessage` /chats/{chat-id}/pinnedMessages List pinnedChatMessages in a chat

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgBetaChatPinnedMessage` /chats/{chat-id}/pinnedMessages List pinnedChatMessages in a chat

Code Examples

C# / .NET SDK

List pinnedChatMessages in a chat

View official example on Microsoft Learn

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Chats["{chat-id}"].PinnedMessages.GetAsync();

JavaScript

List pinnedChatMessages in a chat

View official example on Microsoft Learn

const options = {
	authProvider,
};

const client = Client.init(options);

let pinnedMessages = await client.api('/chats/19:[email protected]/pinnedMessages')
	.get();

PowerShell

List pinnedChatMessages in a chat

View official example on Microsoft Learn

Import-Module Microsoft.Graph.Teams

Get-MgChatPinnedMessage -ChatId $chatId

Python

List pinnedChatMessages in a chat

View official example on Microsoft Learn

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.chats.by_chat_id('chat-id').pinned_messages.get()

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Application permissions and search for ChatMessage.Read.All

4

Grant Admin Consent

Application permissions always require admin consent.