ChannelMessage.Read.All
Allows the app to read all channel messages in Microsoft Teams
Permission Details
Read all channel messages
Allows the app to read all channel messages in Microsoft Teams
7b2449af-6ccd-4f4d-9f78-e550c193f0d1
Read user channel messages
Allows an app to read a channel's messages in Microsoft Teams, on behalf of the signed-in user.
767156cb-16ae-4d10-8f8b-41b657c8c8c8
Properties
Properties is shown from stable Microsoft Graph v1.0 metadata.
| Property | Type | Description |
|---|---|---|
chatType |
chatType |
Specifies the type of chat. The possible values are: group, oneOnOne, meeting, unknownFutureValue. |
createdDateTime |
dateTimeOffsetNullable |
Date and time at which the chat was created. Read-only. |
id |
String |
The chat's unique identifier. Read-only. |
isHiddenForAllMembers |
BooleanNullable |
Indicates whether the chat is hidden for all its members. Read-only. |
lastUpdatedDateTime |
dateTimeOffsetNullable |
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 |
StringNullable |
The identifier of the tenant in which the chat was created. Read-only. |
topic |
StringNullable |
(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 |
StringNullable |
The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only. |
installedApps |
teamsAppInstallation collection |
A collection of all the apps in the chat. Nullable. |
lastMessagePreview |
object |
Preview of the last message sent in the chat. Null if no messages were sent in the chat. Currently, only the list chats operation supports this property. |
members |
conversationMember collection |
A collection of all the members in the chat. Nullable. |
messages |
chatMessage collection |
A collection of all the messages in the chat. Nullable. |
permissionGrants |
resourceSpecificPermissionGrant collection |
A collection of permissions granted to apps for the chat. |
Showing 15 of 17 properties.
JSON Representation
JSON representation is shown from stable Microsoft Graph v1.0 metadata.
{
"createdDateTime": "dateTimeOffset",
"chatType": "string",
"id": "string (identifier)",
"isHiddenForAllMembers": "Boolean",
"lastUpdatedDateTime": "dateTimeOffset",
"onlineMeetingInfo": {
"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
},
"tenantId": "string",
"topic": "string",
"viewpoint": {
"@odata.type": "microsoft.graph.chatViewpoint"
},
"webUrl": "string",
}
Relationships
Relationships is shown from stable Microsoft Graph v1.0 metadata.
| Relationship | Type | Description |
|---|---|---|
installedApps |
teamsAppInstallation collection |
A collection of all the apps in the chat. Nullable. |
lastMessagePreview |
chatMessageInfo |
Preview of the last message sent in the chat. Null if no messages were sent in the chat. Currently, only the list chats operation supports this property. |
members |
conversationMember collection |
A collection of all the members in the chat. Nullable. |
messages |
chatMessage collection |
A collection of all the messages in the chat. Nullable. |
permissionGrants |
resourceSpecificPermissionGrant collection |
A collection of permissions granted to apps for the chat. |
pinnedMessages |
pinnedChatMessageInfo collection |
A collection of all the pinned messages in the chat. Nullable. |
tabs |
teamsTab collection |
A collection of all the tabs in the chat. Nullable. |
chatType |
chatType |
Related chatType data exposed by this resource. |
operations |
teamsAsyncOperation collection |
A collection of all the Teams async operations that ran or are running on the chat. Nullable. |
Graph Methods
Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.
Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.
Code Examples
// 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.Teams["{team-id}"].Channels.GetAllMessages.GetAsGetAllMessagesGetResponseAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Filter = "lastModifiedDateTime gt 2019-11-01T00:00:00Z and lastModifiedDateTime lt 2021-11-01T00:00:00Z";
});
const options = {
authProvider,
};
const client = Client.init(options);
let getAllMessages = await client.api('/teams/01fe12e0-e720-44fd-8854-28c66d1bee40/channels/getAllMessages')
.filter('lastModifiedDateTime gt 2019-11-01T00:00:00Z and lastModifiedDateTime lt 2021-11-01T00:00:00Z')
.get();
Import-Module Microsoft.Graph.Teams
Get-MgTeamChannelRetainedMessage -TeamId $teamId
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.teams.item.channels.get_all_messages.get_all_messages_request_builder import GetAllMessagesRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = GetAllMessagesRequestBuilder.GetAllMessagesRequestBuilderGetQueryParameters(
filter = "lastModifiedDateTime gt 2019-11-01T00:00:00Z and lastModifiedDateTime lt 2021-11-01T00:00:00Z",
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.teams.by_team_id('team-id').channels.get_all_messages.get(request_configuration = request_configuration)
App Registration
Navigate to Azure Portal
Go to App registrations in Microsoft Entra admin center
Add API Permission
Select your app → API permissions → Add a permission → Microsoft Graph
Select Permission Type
Choose Application permissions or delegated permissions and search for ChannelMessage.Read.All
Grant Admin Consent
Application permissions always require admin consent.