chat resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

A chat is a collection of chatMessages between one or more participants. Participants can be users or apps.

Methods

Method Return Type Description Permissions
List chats chat collection Get the list of chats a user is part of. Delegated only
Get chat chat Read properties and relationships of the chat. Delegated and application
List chat members conversationmember collection Get the list of all users in the chat. Delegated and application (see below)
Get chat member conversationmember Get a single user in the chat. Delegated and application (see note)
List messages in a chat chatMessage Get messages in a 1:1 or group chat. Delegated and application (see note)
Get message in chat chatMessage Get a single message in a chat. Delegated and application (see note)

Note: When using application permissions, be sure you know how you're going 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/allMessages with application permissions.

Properties

Property Type Description
id String The chat's unique identifier. Read-only.
topic String (Optional) Subject or topic for the chat. Only available for group chats.
createdDateTime dateTimeOffset Date and time at which the chat was created. Read-only.
lastUpdatedDateTime dateTimeOffset Date and time at which the chat was updated. Read-only.

Relationships

Relationship Type Description
installedApps teamsAppInstallation collection A collection of all the apps in the chat. Nullable.
members conversationMember collection A collection of all people in the chat. Nullable.
messages chatMessage collection A collection of all the messages in the chat. Nullable.

JSON representation

Here is a JSON representation of the resource.

{
  "id": "string (identifier)",
  "topic": "string",
  "createdDateTime": "dateTimeOffset",
  "lastUpdatedDateTime": "dateTimeOffset"
}

See also