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, bei dem es sich um eine Sammlung von chatMessages zwischen einem oder mehreren Teilnehmern handelt. 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 | ||
| 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 von Eigenschaften und Beziehungen des Chats. |
| Chat aktualisieren | 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 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 | Erhalten Sie einen 1:1-Chat zwischen Dem Benutzer und der App. |
| Chat als gelesen markieren | Keine | Markieren Sie den Chat als gelesen für einen Benutzer. |
| Chat als ungelesen markieren | Keine | Chat als ungelesen für einen Benutzer markieren. |
| Chat ausblenden | Keine | Ausblenden eines Chats für einen Benutzer. |
| Chat einblenden | Keine | Einblenden eines Chats für einen Benutzer |
| 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). |
| 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 | 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 |
| createdBy | identitySet | Der Benutzer oder die Anwendung, der 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 | Boolesch | Gibt an, ob der Chat für alle Mitglieder ausgeblendet ist. Schreibgeschützt. |
| lastUpdatedDateTime | dateTimeOffset | Datum und Uhrzeit, zu dem der Chat umbenannt wurde, oder die Liste der Mitglieder wurde zuletzt geändert. 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
| Member | Beschreibung |
|---|---|
| oneOnOne | 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 | 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 | Gibt an, dass der Chat einer Onlinebesprechung zugeordnet ist. Diese Art von Chat wird nur im Rahmen der Erstellung einer Onlinebesprechung erstellt. |
| unknownFutureValue | 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 werden. 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. |
| 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 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.
{
"chatType": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"id": "string (identifier)",
"isHiddenForAllMembers": "Boolean",
"lastUpdatedDateTime": "String (timestamp)",
"onlineMeetingInfo": {
"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
},
"tenantId": "String",
"topic": "String",
"viewpoint": {
"@odata.type": "microsoft.graph.chatViewpoint"
},
"webUrl": "String"
}