chat-Ressourcen-Typ

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Stellt einen Chat dar, der eine Sammlung von chatMessages zwischen einem oder mehreren Teilnehmern ist. Teilnehmer können Benutzer oder Apps sein.

Hinweis: Wenn der Chat einer onlineMeeting-instance zugeordnet ist, wirken sich einige der aufgeführten Methoden transitiv auf die Besprechung aus.

Methoden

Methode Rückgabetyp Beschreibung
Chatverwaltung
List Sammlung von Chats Abrufen der Liste der Chats, an denen ein Benutzer beteiligt ist.
Create chat Erstellen Sie einen neuen Chat.
Get chat Lesen Sie Eigenschaften und Beziehungen des Chats.
Update chat Aktualisieren Sie die Eigenschaften des Chats.
Delete Keine Löschen eines Chats.
Gesamten Zugriff für Benutzer entfernen Keine Entfernen des Zugriffs auf einen Chat für einen Benutzer.
Mitglieder auflisten conversationMember-Sammlung Rufen Sie die Liste aller Benutzer im Chat ab.
Mitglied hinzufügen Header „Location“ Fügen Sie einen Benutzer zum Chat hinzu.
Mitglied abrufen conversationMember Abrufen eines einzelnen Benutzers im Chat.
Mitglied entfernen Keine Entfernen Sie einen Benutzer aus dem Chat.
Chat zwischen Benutzer und App erhalten chat Erhalten Sie einen Einzelchat zwischen dem Benutzer und der App.
Chat als gelesen markieren Keine Chat für einen Benutzer als gelesen markieren.
Chat als ungelesen markieren Keine Markieren eines Chats als ungelesen für einen Benutzer.
Chat ausblenden Keine Ausblenden eines Chats für einen Benutzer.
Chat einblenden Keine Chat für einen Benutzer einblenden.
Migration starten chat Starten Sie die Migration externer Nachrichten, indem Sie den Migrationsmodus in einem vorhandenen Chat aktivieren.
Migration abschließen chat Schließen Sie die Migration externer Nachrichten ab, indem Sie den Migrationsmodus aus einem Chat entfernen.
Nachrichten
Auflisten von Nachrichten in einem Chat chatMessage Abrufen von Nachrichten in einem Chat.
Antwort auf Nachricht abrufen chatMessage Eine einzelne Nachricht in einem Chat abrufen.
Nachrichten in allen Chats abrufen Sammlung von Chats Dient zum Abrufen von Nachrichten aus allen Chats, an denen ein Benutzer beteiligt ist.
Beibehaltene Nachrichten aller Chats abrufen chatMessage-Auflistung Abrufen aller gespeicherten Nachrichten aus allen Chats , an denen ein Benutzer teilnimmt, einschließlich Einzel-Chats, Gruppenchats und Besprechungschats.
Delta-Chatnachrichten für Benutzer abrufen chatMessage-Auflistung Rufen Sie die Liste der Nachrichten aus allen Chats ab, an denen ein Benutzer teilnimmt, einschließlich Einzelchats, Gruppenchats und Besprechungschats.
Apps
Apps im Chat auflisten teamsAppInstallation-Sammlung Auflisten der in einem Chat (und zugehörigen Besprechung) installierten Apps.
Im Chat installierte App abrufen teamsAppInstallation Installieren Sie eine bestimmte App in einem Chat (und einer zugehörigen Besprechung).
App im Chat hinzufügen Hinzufügen (Installation) einer App in einem Chat (und einer zugehörigen Besprechung).
Im Chat installierte Upgrade-App Keine Aktualisieren Sie auf die neueste Version der App, die im Chat (und in der zugehörigen Besprechung) installiert ist.
App aus Chat entfernen Keine Entfernen (deinstallieren) Sie die App aus einem Chat (und einer zugehörigen Besprechung).
Berechtigungserteilungen auflisten resourceSpecificPermissionGrant-Sammlung Listen Sie die Berechtigungen auf, die den Apps in diesem Chat erteilt wurden.
Registerkarten
Auflisten von Registerkarten im Chat teamsTab Listen Sie Registerkarten auf, die an einen Chat (und die zugehörige Besprechung) angeheftet sind.
Registerkarte im Chat abrufen teamsTab Abrufen einer bestimmten Registerkarte, die an einen Chat (und eine zugehörige Besprechung) angeheftet wird.
Registerkarte zum Chat hinzufügen teamsTab Hinzufügen einer Registerkarte zu einem Chat (und einer zugehörigen Besprechung).
Registerkarte im Kanal aktualisieren teamsTab Aktualisieren der Eigenschaften einer Registerkarte in einem Chat (und einer zugehörigen Besprechung).
Registerkarte aus Chat entfernen Keine Entfernen (Lösen) einer Registerkarte aus einem Chat (und einer zugehörigen Besprechung).
Operations
Vorgänge auflisten teamsAsyncOperation-Auflistung Rufen Sie die Liste der asynchronen Vorgänge ab, die im Chat ausgeführt wurden oder ausgeführt werden.
Vorgang im Chat abrufen teamsAsyncOperation Rufen Sie einen einzelnen asynchronen Vorgang ab, der im Chat ausgeführt wurde oder ausgeführt wird.
Angeheftete Nachrichten
Auflisten angehefteter Nachrichten pinnedChatMessageInfo-Sammlung Abrufen einer Liste der angehefteten Nachrichten in einem Chat.
Nachricht anheften pinnedChatMessageInfo Heften Sie eine Chatnachricht in einem Chat an.
Nachricht lösen Keine Eine Nachricht aus einem Chat lösen.

Hinweis: Wenn Sie Anwendungsberechtigungen verwenden, stellen Sie sicher, dass Sie wissen, wie Sie die Chat-ID erhalten. Da das Auflisten von Chats mit Anwendungsberechtigungen nicht unterstützt wird, sind nicht alle Szenarien möglich. Es ist möglich, Chat-IDs mit delegierten Berechtigungen und aus Änderungsbenachrichtigungen für /chats/getAllMessages mit Anwendungsberechtigungen zu erhalten.

Eigenschaften

Eigenschaft Typ Beschreibung
chatType chatType Gibt den Chattyp an. Mögliche Werte sind: group, oneOnOne, meeting, unknownFutureValue.
createdBy identitySet Der Benutzer oder die Anwendung, der/die den Chat erstellt hat. Schreibgeschützt.
createdDateTime dateTimeOffset Datum und Uhrzeit der Erstellung des Chats. Schreibgeschützt.
id String Der eindeutige Bezeichner des Chats. Schreibgeschützt.
isHiddenForAllMembers Boolean Gibt an, ob der Chat für alle seine Mitglieder ausgeblendet ist. Schreibgeschützt.
lastUpdatedDateTime dateTimeOffset Datum und Uhrzeit, zu dem der Chat umbenannt wurde bzw. die Liste der Mitglieder zuletzt geändert wurde. Schreibgeschützt.
migrationMode migrationMode Gibt an, ob sich ein Chat im Migrationsmodus befindet. Dieser Wert gilt null für Chats, die nie in den Migrationsmodus gewechselt sind. Die möglichen Werte sind: inProgress, completed, unknownFutureValue.
onlineMeetingInfo teamworkOnlineMeetingInfo Stellt Details zu einer Onlinebesprechung dar. Wenn der Chat keiner Onlinebesprechung zugeordnet ist, ist die Eigenschaft leer. Schreibgeschützt.
originalCreatedDateTime dateTimeOffset Zeitstempel der ursprünglichen Erstellungszeit für den Chat. Der Wert ist null , wenn der Chat nie in den Migrationsmodus gewechselt ist.
tenantId Zeichenfolge Der Bezeichner des Mandanten, in dem der Chat erstellt wurde. Schreibgeschützt.
Thema String (Optional) Betreff oder Thema für den Chat. Nur für Gruppenchats verfügbar.
Aussichtspunkt chatViewpoint Stellt anruferspezifische Informationen über den Chat dar, z. B. Datum und Uhrzeit der letzten gelesenen Nachricht. Diese Eigenschaft wird nur ausgefüllt, wenn die Anforderung in einem delegierten Kontext erfolgt.
webUrl String Die URL für den Chat in Microsoft Teams. Die URL sollte als nicht transparentes Blob behandelt und nicht analysiert werden. Schreibgeschützt.

chatType-Werte

Member Beschreibung
Eins-zu-Eins Gibt an, dass es sich um einen 1:1-Chat handelt. Die Größe der Liste ist für diese Art von Chat festgelegt. Mitglieder können nicht entfernt/hinzugefügt werden.
Gruppe Gibt an, dass es sich bei dem Chat um einen Gruppenchat handelt. Die Größe der Liste (von mindestens zwei Personen) kann für diese Art von Chat aktualisiert werden. Mitglieder können später entfernt/hinzugefügt werden.
Besprechung Gibt an, dass der Chat einer Onlinebesprechung zugeordnet ist. Diese Art von Chat wird nur im Rahmen der Erstellung einer Onlinebesprechung erstellt.
unknownFutureValue Evolvable Enumeration Sentinel-Wert. Nicht verwenden.

migrationMode-Werte

Member Beschreibung
inProgress Der Chat ist in den Migrationsmodus eingetreten.
abgeschlossen Der Chat befindet sich außerhalb des Migrationsmodus.
unknownFutureValue Evolvable Enumeration Sentinel-Wert. Nicht verwenden.

Beziehungen

Beziehung Typ Beschreibung
installedApps teamsAppInstallation-Sammlung Eine Sammlung aller Apps im Chat. Nullwerte zulassend.
lastMessagePreview chatMessageInfo Vorschau der letzten im Chat gesendeten Nachricht. Null Wenn keine Nachrichten im Chat gesendet werden. Derzeit unterstützt nur der Listenchats-Vorgang diese Eigenschaft.
members conversationMember-Sammlung Eine Auflistung aller Mitglieder im Chat. Lässt NULL-Werte zu.
messages chatMessage-Auflistung Eine Sammlung aller Nachrichten im Chat. Nullwerte zulassend.
operations teamsAsyncOperation-Auflistung Eine Auflistung aller asynchronen Teams-Vorgänge, die im Chat ausgeführt wurden oder ausgeführt werden. Nullwerte zulassend.
permissionGrants resourceSpecificPermissionGrant-Sammlung Eine Auflistung der Berechtigungen, die Apps für den Chat erteilt wurden.
pinnedMessages pinnedChatMessageInfo-Sammlung Eine Sammlung aller angehefteten Nachrichten im Chat. Nullwerte zulassend.
Registerkarten teamsTab-Auflistung Eine Sammlung aller Registerkarten im Chat. Nullwerte zulassend.
targetedMessages targetedChatMessage-Sammlung Eine Sammlung gezielter Nachrichten im Chat, die nur für bestimmte Benutzer sichtbar sind. Nullwerte zulassend. Sie können diese Beziehung nicht mit $expanderweitern. Gezielte Nachrichten können auch über die userTeamwork: getAllTargetedMessages-API abgerufen werden.

JSON-Darstellung

Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.

{
  "chatType": "String",
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "isHiddenForAllMembers": "Boolean",
  "lastUpdatedDateTime": "String (timestamp)",
  "migrationMode": "String",  
  "onlineMeetingInfo": {"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"},
  "originalCreatedDateTime": "String (timestamp)",
  "tenantId": "String",  
  "topic": "String",
  "viewpoint": {"@odata.type": "microsoft.graph.chatViewpoint"},
  "webUrl": "String"
}

Verwandte Inhalte

  • Last updated on