Chatressourcentyp
Namespace: microsoft.graph
Wichtig
APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .
Ein Chat ist eine Sammlung von chatMessages zwischen einem oder mehreren Teilnehmern. Teilnehmer können Benutzer oder Apps sein.
Hinweis: Wenn der Chat einer onlineMeeting-Instanz zugeordnet ist, wirken sich einige der aufgeführten Methoden transitiv auf die Besprechung aus.
Methoden
| Methode | Rückgabetyp | Beschreibung |
|---|---|---|
| Chatverwaltung | ||
| Chats auflisten | Chatsammlung | Rufen Sie die Liste der Chats ab, zu der ein Benutzer gehört. |
| Chat erstellen | chat | Erstellen sie einen neuen Chat. |
| Chat abrufen | chat | Lesen sie die Eigenschaften und Beziehungen des Chats. |
| Chat aktualisieren | chat | Dient zum Aktualisieren der Eigenschaften des Chats. |
| Chatmitglieder auflisten | conversationMember-Sammlung | Rufen Sie die Liste aller Benutzer im Chat ab. |
| Chatmitglied hinzufügen | Header „Standort“ | Fügen Sie dem Chat einen Benutzer hinzu. |
| Chatmitglied abrufen | conversationMember | Rufen Sie einen einzelnen Benutzer im Chat ab. |
| Chatmitglied entfernen | Keine | Entfernen sie einen Benutzer aus dem Chat. |
| Chat zwischen Benutzer und App erhalten | chat | Rufen Sie einen Einzelchat zwischen Benutzer und App ab. |
| Chat als gelesen markieren | Keine | Markieren Sie den Chat als gelesen für einen Benutzer. |
| Chat als ungelesen markieren | Keine | Markieren Sie den Chat als ungelesen für einen Benutzer. |
| Chat ausblenden | Keine | Ausblenden eines Chats für einen Benutzer. |
| Chat einblenden | Keine | Einblenden eines Chats für einen Benutzer. |
| Nachrichten | ||
| Nachrichten im Chat auflisten | chatMessage | Abrufen von Nachrichten in einem Chat. |
| Nachricht in Chat abrufen | chatMessage | Eine einzelne Nachricht in einem Chat abrufen. |
| Erhalten von Nachrichten in allen Chats für Benutzer | Chatsammlung | Dient zum Abrufen von Nachrichten aus allen Chats, an denen ein Benutzer beteiligt ist. |
| Apps | ||
| Apps im Chat auflisten | teamsAppInstallation-Sammlung | Apps auflisten, die in einem Chat (und der zugehörigen Besprechung) installiert sind. |
| App im Chat abrufen | teamsAppInstallation | Abrufen einer bestimmten App, die in einem Chat (und der zugehörigen Besprechung) installiert ist. |
| App im Chat hinzufügen | Hinzufügen (Installieren) einer App in einem Chat (und einer zugehörigen Besprechung). | |
| Aktualisieren der App im Chat | Keine | Aktualisieren Sie auf die neueste Version der App, die im Chat (und der zugehörigen Besprechung) installiert ist. |
| Deinstallieren der App aus dem Chat | Keine | Entfernen (Deinstallieren) der App aus einem Chat (und einer zugehörigen Besprechung). |
| Berechtigungserteilungen auflisten | resourceSpecificPermissionGrant-Sammlung | Listet Berechtigungen auf, die den Apps in diesem Chat gewährt wurden. |
| Registerkarten | ||
| Registerkarten im Chat auflisten | teamsTab | Listenregisterkarten, die an einen Chat (und die zugehörige Besprechung) angeheftet sind. |
| Registerkarte im Chat abrufen | teamsTab | Dient zum Abrufen einer bestimmten Registerkarte, die an einen Chat (und die zugehörige Besprechung) angeheftet ist. |
| Registerkarte zum Chat hinzufügen | teamsTab | Hinzufügen (Anheften) einer Registerkarte zu einem Chat (und einer zugehörigen Besprechung). |
| Registerkarte "Aktualisieren" im Chat | teamsTab | Aktualisieren sie die Eigenschaften einer Registerkarte in einem Chat (und der zugehörigen Besprechung). |
| Registerkarte aus Chat entfernen | Keine | Entfernen (Lösen) einer Registerkarte aus einem Chat (und der zugehörigen Besprechung). |
| Operations | ||
| Auflisten von Vorgängen im Chat | teamsAsyncOperation-Auflistung | Rufen Sie die Liste der asynchronen Vorgänge ab, die im Chat ausgeführt wurden oder ausgeführt werden. |
| Abrufen des Chatvorgangs | teamsAsyncOperation | Rufen Sie einen einzelnen asynchronen Vorgang ab, der im Chat ausgeführt wurde oder ausgeführt wird. |
| Angeheftete Nachrichten | ||
| Angeheftete Nachrichten auflisten | pinnedChatMessageInfo-Sammlung | Ruft eine Liste der angehefteten Nachrichten in einem Chat ab. |
| Anheften einer Nachricht | pinnedChatMessageInfo | Anheften einer Chatnachricht in einem Chat. |
| Lösen einer Nachricht | Keine | Lösen sie eine Nachricht aus einem Chat. |
Hinweis: Wenn Sie Anwendungsberechtigungen verwenden, stellen Sie sicher, dass Sie wissen, wie Sie die Chat-ID abrufen. 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 von Änderungsbenachrichtigungen für /chats/getAllMessages mit Anwendungsberechtigungen abzurufen.
Eigenschaften
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| chatType | chatType | Gibt den Chattyp an. Mögliche Werte: group, oneOnOne, meeting, unknownFutureValue. |
| createdDateTime | dateTimeOffset | Datum und Uhrzeit der Erstellung des Chats. Schreibgeschützt. |
| id | Zeichenfolge | Der eindeutige Bezeichner des Chats. Schreibgeschützt. |
| lastUpdatedDateTime | dateTimeOffset | Datum und Uhrzeit, zu dem der Chat umbenannt wurde oder die Liste der Mitglieder zuletzt geändert wurde. Schreibgeschützt. |
| onlineMeetingInfo | teamworkOnlineMeetingInfo | Stellt Details zu einer Onlinebesprechung dar. Wenn der Chat keiner Onlinebesprechung zugeordnet ist, ist die Eigenschaft leer. Schreibgeschützt. |
| 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. |
| Sicht | chatViewpoint | Stellt anruferspezifische Informationen zum Chat dar, z. B. Datum und Uhrzeit der letzten Nachricht. Diese Eigenschaft wird nur aufgefüllt, wenn die Anforderung in einem delegierten Kontext erfolgt. |
| webUrl | Zeichenfolge | Die URL für den Chat in Microsoft Teams. Die URL sollte als undurchsichtiger Blob behandelt und nicht analysiert werden. Schreibgeschützt. |
chatType-Werte
| Element | Wert | Beschreibung |
|---|---|---|
| oneOnOne | 0 | Gibt an, dass es sich bei dem Chat um einen 1:1-Chat handelt. Die Größe der Teilnehmerliste ist für diese Art von Chat festgelegt. Mitglieder können nicht entfernt/hinzugefügt werden. |
| Gruppe | 1 | Gibt an, dass der Chat ein Gruppenchat ist. Die Teilnehmerlistengröße (von mindestens zwei Personen) kann für diese Art von Chat aktualisiert werden. Mitglieder können später entfernt/hinzugefügt werden. |
| Sitzung | 2 | Gibt an, dass der Chat einer Onlinebesprechung zugeordnet ist. Diese Art von Chat wird nur im Rahmen der Erstellung einer Onlinebesprechung erstellt. |
| unknownFutureValue | 3 | 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 im Chat keine Nachrichten gesendet wurden. Derzeit unterstützt nur der Listenchatvorgang diese Eigenschaft. |
| members | conversationMember-Sammlung | Eine Sammlung aller Mitglieder im Chat. Lässt NULL-Werte zu. |
| messages | chatMessage-Auflistung | Eine Sammlung aller Nachrichten im Chat. Lässt Nullwerte zu. |
| operations | teamsAsyncOperation-Auflistung | Eine Sammlung aller asynchronen Teams-Vorgänge, die im Chat ausgeführt wurden oder ausgeführt werden. Nullwerte zulassend. |
| permissionGrants | resourceSpecificPermissionGrant-Sammlung | Eine Sammlung von 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. |
JSON-Darstellung
Es folgt eine JSON-Darstellung der Ressource.
{
"id": "string (identifier)",
"topic": "string",
"createdDateTime": "dateTimeOffset",
"lastUpdatedDateTime": "dateTimeOffset",
"chatType": "string",
"webUrl": "string",
"tenantId": "string",
"viewpoint": {
"@odata.type": "microsoft.graph.chatViewpoint"
},
"onlineMeetingInfo": {
"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
}
}
Siehe auch
Feedback
Feedback senden und anzeigen für