Chat.ReadBasic

Allows an app to read the members and descriptions of one-to-one and group chat threads, on behalf of the signed-in user.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver	Type	Method
V1	D	GET /chats
V1	D	GET /chats/{chat-id}
V1	D	GET /chats/{chat-id}/members
V1	D	GET /chats/{chat-id}/members/{membership-id}
Beta	D	GET /chats/{chat-id}/operations
Beta	D	GET /chats/{chat-id}/operations/{operation-id}
V1	D	GET /chats/{id}/members
V1	D	GET /chats/{id}/members/{id}
V1	D	GET /me/chats
V1	D	GET /me/chats/{chat-id}
V1	D	GET /teams/{id}/channels/{id}/members/{id}
V1	D	GET /users/{user-id \| user-principal-name}/chats
V1	D	GET /users/{user-id \| user-principal-name}/chats/{chat-id}
V1	D	GET /users/{user-id \| user-principal-name}/chats/{chat-id}/members
Beta	D	GET /users/{user-id \| user-principal-name}/chats/{chat-id}/members/{membership-id}
V1	D	GET /users/{user-id} \| user-principal-name/chats/{chat-id}/members/{membership-id}

Delegate Permission


Id	9547fcb5-d03f-419d-9948-5928bbf71b0f
Consent Type	User
Display String	Read names and members of user chat threads
Description	Allows an app to read the members and descriptions of one-to-one and group chat threads, on behalf of the signed-in user.

Resources

channel

Property	Type	Description
description	String	Optional textual description for the channel.
displayName	String	Channel name as it will appear to the user in Microsoft Teams.
id	String	The channel's unique identifier. Read-only.
isFavoriteByDefault	Boolean	Indicates whether the channel should automatically be marked 'favorite' for all members of the team. Can only be set programmatically with Create team. Default: `false`.
email	String	The email address for sending messages to the channel. Read-only.
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.
membershipType	channelMembershipType	The type of the channel. Can be set during creation and can't be changed. Possible values are: `standard` - Channel inherits the list of members of the parent team; `private` - Channel can have members that are a subset of all the members on the parent team.
createdDateTime	dateTimeOffset	Read only. Timestamp at which the channel was created.

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 list of members were 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.
webUrl	String	The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.

chatMessage

Property	Type	Description
id	String	Read-only. Unique ID of the message.
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.)
from	chatMessageFromIdentitySet	Details of the sender of the chat message. Can only be set during migration.
etag	string	Read-only. Version number of the chat 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`.
createdDateTime	dateTimeOffset	Timestamp of when the chat message was created.
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`.
deletedDateTime	dateTimeOffset	Read only. Timestamp at which the chat message was deleted, or null if not deleted.
subject	string	The subject of the chat message, in plaintext.
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.
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.
attachments	chatMessageAttachment collection	References to attached objects like files, tabs, meetings etc.
mentions	chatMessageMention collection	List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel.
importance	string	The importance of the chat message. The possible values are: `normal`, `high`, `urgent`.
reactions	chatMessageReaction collection	Reactions for this chat message (for example, Like).
locale	string	Locale of the chat message set by the client. Always set to `en-us`.
policyViolation	chatMessagePolicyViolation	Defines the properties of a policy violation set by a data loss prevention (DLP) application.
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.
webUrl	string	Read-only. Link to the message in Microsoft Teams.
eventDetail	eventMessageDetail	Read-only. If present, represents details of an event that happened in a **c

conversationMember

Property	Type	Description
id	String	Read-only. Unique ID of the user.
displayName	string	The display name of the user.
roles	string collection	The roles for that user.
visibleHistoryStartDateTime	DateTimeOffset	The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.

teamsAsyncOperation

Property	Type	Description
id	string	Unique operation id.
operationType	teamsAsyncOperationType	Denotes which type of operation is being described.
createdDateTime	DateTimeOffset	Time when the operation was created.
status	teamsAsyncOperationStatus	Operation status.
lastActionDateTime	DateTimeOffset	Time when the async operation was last updated.
attemptsCount	Int32	Number of times the operation was attempted before being marked successful or failed.
targetResourceId	guid	The ID of the object that's created or modified as result of this async operation, typically a team.
targetResourceLocation	string	The location of the object that's created or modified as result of this async operation. This URL should be treated as an opaque value and not parsed into its component paths.
error	operationError	Any error that causes the async operation to fail.