chat resource type

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
List chats chat collection Get the list of chats a user is part of.
Get chat chat Read properties and relationships of the chat.
List chat members conversationmember collection Get the list of all users in the chat.
Get chat member conversationmember Get a single user in the chat.
List messages in a chat chatMessage Get messages in a 1:1 or group chat.
Get message in chat chatMessage Get a single message in a chat.

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
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