chat resource type
APIs under the
/beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
A chat is a collection of chatMessages between one or more participants. Participants can be users or apps.
Note: If the chat is associated with an onlineMeeting instance, then some of the listed methods will transitively impact the meeting.
|Get the list of chats a user is part of.
|Create a new chat.
|Read properties and relationships of the chat.
|Update properties of the chat.
|Delete a chat.
|Remove access to a chat for a user.
|List chat members
|Get the list of all users in the chat.
|Add chat member
|Add a user to the chat.
|Get chat member
|Get a single user in the chat.
|Remove chat member
|Remove a user from the chat.
|Get chat between user and app
|Get one-on-one chat between user and the app.
|Mark chat as read
|Mark chat as read for a user.
|Mark chat as unread
|Mark chat as unread for a user.
|Hide a chat for a user.
|Unhide a chat for a user.
|List messages in chat
|Get messages in a chat.
|Get message in chat
|Get a single message in a chat.
|Get messages across all chats for user
|Get messages from all chats that a user is a participant in.
|Get all retained chat messages
|Get all retained messages from all chats that a user is a participant in, including one-on-one chats, group chats, and meeting chats.
|List apps in chat
|List apps installed in a chat (and associated meeting).
|Get app in chat
|Get a specific app installed in a chat (and associated meeting).
|Add app in chat
|Add (install) an app in a chat (and associated meeting).
|Upgrade app in chat
|Update to the latest version of the app installed in chat (and associated meeting).
|Uninstall app from chat
|Remove (uninstall) app from a chat (and associated meeting).
|List permission grants
|List permissions that have been granted to the apps in this chat.
|List tabs in chat
|List tabs pinned to a chat (and associated meeting).
|Get tab in chat
|Get a specific tab pinned to a chat (and associated meeting).
|Add tab to chat
|Add (pin) a tab to a chat (and associated meeting).
|Update tab in chat
|Update the properties of a tab in a chat (and associated meeting).
|Remove tab from chat
|Remove (unpin) a tab from a chat (and associated meeting).
|List operations on chat
|Get the list of async operations that ran or are running on the chat.
|Get operation on chat
|Get a single async operation that ran or is running on the chat.
|List pinned messages
|Get a list of pinned messages in a chat.
|Pin a message
|Pin a chat message in a chat.
|Unpin a message
|Unpin a message from a chat.
Note: When using application permissions, be sure you know how to get the chat ID. Because listing chats with application permissions is not supported, not all scenarios are possible. It is possible to get chat IDs with delegated permissions, and from change notifications for /chats/getAllMessages with application permissions.
|Specifies the type of chat. Possible values are:
|Date and time at which the chat was created. Read-only.
|The chat's unique identifier. Read-only.
|Date and time at which the chat was renamed or list of members were last changed. Read-only.
|Represents details about an online meeting. If the chat isn't associated with an online meeting, the property is empty. Read-only.
|The identifier of the tenant in which the chat was created. Read-only.
|(Optional) Subject or topic for the chat. Only available for group chats.
|Represents caller-specific information about the chat, such as last message read date and time. This property is populated only when the request is made in a delegated context.
|The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.
|Indicates that the chat is a 1:1 chat. The roster size is fixed for this type of chat; members cannot be removed/added.
|Indicates that the chat is a group chat. The roster size (of at least two people) can be updated for this type of chat. Members can be removed/added later.
|Indicates that the chat is associated with an online meeting. This type of chat is only created as part of the creation of an online meeting.
|Evolvable enumeration sentinel value. Do not use.
|A collection of all the apps in the chat. Nullable.
|Preview of the last message sent in the chat. Null if no messages have been sent in the chat. Currently, only the list chats operation supports this property.
|A collection of all the members in the chat. Nullable.
|A collection of all the messages in the chat. Nullable.
|A collection of all the Teams async operations that ran or are running on the chat. Nullable.
|A collection of permissions granted to apps for the chat.
|A collection of all the pinned messages in the chat. Nullable.
|A collection of all the tabs in the chat. Nullable.
The following is a JSON representation of the resource.
"id": "string (identifier)",