chat-Ressourcen-Typ
Namespace: microsoft.graph
Ein Chat ist eine Sammlung von chatMessages zwischen einem oder mehreren Teilnehmern. Teilnehmer können Benutzer oder Apps sein.
Hinweis: Wenn der Chat einem onlineMeeting-instance zugeordnet ist, wirken sich einige der aufgeführten Methoden transitiv auf die Besprechung aus.
Methoden
| Methode | Rückgabetyp | Beschreibung |
|---|---|---|
| Chatverwaltung | ||
| Chat erstellen | chat | Erstellen Sie einen neuen Chat. |
| Chat abrufen | chat | Lesen von Eigenschaften und Beziehungen des Chats. |
| Chat aktualisieren | chat | Aktualisieren sie die Eigenschaften des Chats. |
| Delete | Keine | Löschen eines Chats. |
| Mitglieder auflisten | conversationMember-Sammlung | Rufen Sie die Liste aller Benutzer im Chat ab. |
| Mitglied hinzufügen | Header „Location“ | Fügen Sie dem Chat einen Benutzer 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 | 1:1-Chat zwischen Benutzer und App |
| 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 | Chatsammlung | Dient zum Abrufen von Nachrichten aus allen Chats, an denen ein Benutzer beteiligt ist. |
| Beibehaltene Nachrichten aller Chats abrufen | chatMessage-Auflistung | Abrufen aller beibehaltenen Nachrichten aus allen Chats , an denen ein Benutzer beteiligt ist, einschließlich Einzelchats, Gruppenchats und Besprechungschats. |
| Abrufen von Delta-Chatnachrichten für Benutzer | 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 von Apps, die in einem Chat (und einer zugehörigen Besprechung) installiert sind |
| Im Chat installierte App abrufen | teamsAppInstallation | Rufen Sie eine bestimmte App ab, die in einem Chat (und einer zugehörigen Besprechung) installiert ist. |
| App im Chat hinzufügen | Hinzufügen (Installieren) 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 der zugehörigen Besprechung) installiert ist. |
| App aus Chat entfernen | Keine | Entfernen (Deinstallieren) der App aus einem Chat (und der zugehörigen Besprechung). |
| Berechtigungserteilungen auflisten | resourceSpecificPermissionGrant-Sammlung | Listen Sie berechtigungen auf, die den Apps in diesem Chat gewährt wurden. |
| Registerkarten | ||
| Auflisten von Registerkarten im Chat | teamsTab | Auflisten von Registerkarten, die an einen Chat (und die zugehörige Besprechung) angeheftet sind |
| Registerkarte im Chat abrufen | teamsTab | Rufen Sie eine bestimmte Registerkarte ab, die an einen Chat (und eine zugeordnete Besprechung) angeheftet ist. |
| Registerkarte zum Chat hinzufügen | teamsTab | Hinzufügen (Anheften) einer Registerkarte zu einem Chat (und einer zugeordneten Besprechung). |
| Registerkarte im Kanal aktualisieren | teamsTab | Aktualisieren sie die Eigenschaften einer Registerkarte in einem Chat (und der zugeordneten Besprechung). |
| Registerkarte aus Chat entfernen | Keine | Entfernen (Lösen) einer Registerkarte aus einem Chat (und einer zugeordneten Besprechung). |
| Angeheftete Nachrichten | ||
| Auflisten angehefteter Nachrichten | pinnedChatMessageInfo-Sammlung | Ruft eine Liste angehefteter Nachrichten in einem Chat ab. |
| Nachricht anheften | pinnedChatMessageInfo | Heften Sie eine Chatnachricht in einem Chat an. |
| Nachricht lösen | Keine | Lösen Sie eine Nachricht aus einem Chat. |
Anmerkung: 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 aus Änderungsbenachrichtigungen für /chats/getAllMessages mit Anwendungsberechtigungen abzurufen.
Eigenschaften
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| chatType | chatType | Gibt den Typ des Chats an. Mögliche Werte: group, oneOnOne, meeting, unknownFutureValue |
| createdDateTime | dateTimeOffset | Datum und Uhrzeit der Erstellung des Chats. Schreibgeschützt. |
| id | String | 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. |
| Aussichtspunkt | chatViewpoint | Stellt anruferspezifische Informationen zum Chat dar, z. B. Datum und Uhrzeit der letzten Gelesenen Nachricht. Diese Eigenschaft wird nur aufgefüllt, wenn die Anforderung in einem delegierten Kontext erfolgt. |
| webUrl | String | Die URL für den Chat in Microsoft Teams. Die URL sollte als undurchsichtiges Blob behandelt und nicht analysiert werden. Schreibgeschützt. |
chatType-Werte
| Element | Wert | Beschreibung |
|---|---|---|
| oneOnOne | 0 | Gibt an, dass der Chat ein 1:1-Chat ist. Die Listengröße 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 Listengröße (von mindestens zwei Personen) kann für diese Art von Chat aktualisiert werden. Mitglieder können später entfernt/hinzugefügt werden. |
| Treffen | 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 | Wert des Sentinelwerts für die vervolvbare Enumeration. 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 Vorgang listenchats 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. Nullwerte zulassend. |
| permissionGrants | resourceSpecificPermissionGrant-Sammlung | Eine Sammlung von Berechtigungen, die Apps für den Chat gewährt werden. |
| 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
Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.
{
"createdDateTime": "dateTimeOffset",
"chatType": "string",
"id": "string (identifier)",
"lastUpdatedDateTime": "dateTimeOffset",
"onlineMeetingInfo": {
"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
},
"tenantId": "string",
"topic": "string",
"viewpoint": {
"@odata.type": "microsoft.graph.chatViewpoint"
},
"webUrl": "string",
}