chat: getAllRetainedMessages

Artikel
04/21/2024

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.

Abrufen aller beibehaltenen Nachrichten aus allen Chats , an denen ein Benutzer beteiligt ist, einschließlich Einzelchats, Gruppenchats und Besprechungschats.

Um mehr darüber zu erfahren, wie Sie die Export-APIs von Microsoft Teams für das Exportieren von Inhalten verwenden, lesen Sie Inhalte mit den Export-APIs von Microsoft Teams exportieren.

Anmerkung: Dies ist eine getaktete API, die die model=A Zahlungsmodelle und model=B unterstützt. Weitere Informationen finden Sie unter Zahlungsmodelle. Wenn Sie in Ihrer Abfrage kein Zahlungsmodell angeben, wird der Standardauswertungsmodus verwendet.

Je nachdem, für welches Zahlungsmodell Sie sich entscheiden, ist möglicherweise auch eine Lizenz erforderlich.

Hinweis

Für diese API müssen Teams-Aufbewahrungsrichtlinien konfiguriert werden. Weitere Informationen finden Sie unter Verwalten von Aufbewahrungsrichtlinien für Microsoft Teams.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst	US Government L4	US Government L5 (DOD)	China, betrieben von 21Vianet
✅	✅	✅	✅

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp	Berechtigungen mit den geringsten Berechtigungen	Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto)	Nicht unterstützt	Nicht unterstützt
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt	Nicht unterstützt
Anwendung	Chat.Read.All	Chat.ReadWrite.All

HTTP-Anforderung

GET /users/{id}/chats/getAllRetainedMessages

Optionale Abfrageparameter

Das folgende Beispiel zeigt, wie Sie den model Abfrageparameter mit Werten A verwenden oder B das bevorzugte Lizenzierungs- und Zahlungsmodell auswählen. Wenn Sie kein Zahlungsmodell angeben, wird standardmäßig der Auswertungsmodus verwendet.

GET /users/{id}/chats/getAllRetainedMessages?model=A
GET /users/{id}/chats/getAllRetainedMessages?model=B

Diese Methode unterstützt die folgenden OData-Abfrageparameter, um die Antwort anzupassen. Allgemeine Informationen finden Sie unter OData-Abfrageparameter.

Name	Beschreibung
$filter	Der abfrageparameter $filter unterstützt Datums- und Uhrzeitbereichsabfragen für die lastModifiedDateTime-Eigenschaft mithilfe von Datumsbereichsparametern.
$top	Verwenden Sie den abfrageparameter $top , um die Anzahl der Elemente pro Antwort zu steuern.

Das folgende Beispiel zeigt eine Anforderung, die die $top Abfrageparameter und $filter verwendet, um eine Liste der beibehaltenen Chatnachrichten abzurufen.

GET /users/{id}/chats/getAllRetainedMessages?$top=50&$filter=lastModifiedDateTime gt 2020-06-04T18:03:11.591Z and lastModifiedDateTime lt 2020-06-05T21:00:09.413Z

Die folgende Tabelle enthält Beispiele für die Verwendung des $filter Parameters.

Szenario	`$filter` Parameter	Mögliche Werte
Abrufen von Nachrichten, die nach Benutzeridentitätstyp gesendet werden	$filter=from/user/userIdentityType eq '{teamworkUserIdentityType}'	`aadUser`, `onPremiseAadUser`, `anonymousGuest`, `federatedUser`, `personalMicrosoftAccountUser`, `skypeUser`, `phoneUser`
Abrufen von Nachrichten, die nach Anwendungstyp gesendet werden	$filter=from/application/applicationIdentityType eq '{teamworkApplicationIdentity}'	`aadApplication`, `bot`, `tenantBot`, `office365Connector`, `outgoingWebhook`
Abrufen von Nachrichten, die nach Benutzer-ID gesendet werden	$filter=from/user/id eq '{oid}'
Abrufen von Steuerungsmeldungen (Systemereignis)	$filter=messageType eq 'systemEventMessage'
Ausschließen von Steuerungsmeldungen (Systemereignismeldungen)	$filter=messageType ne 'systemEventMessage'

Anforderungsheader

Name	Beschreibung
Authorization	Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und eine Sammlung von chatMessage-Objekten im Antworttext zurückgegeben.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllRetainedMessages


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].Chats.GetAllRetainedMessages.GetAsGetAllRetainedMessagesGetResponseAsync();

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



mgc-beta users chats get-all-retained-messages get --user-id {user-id}

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
getAllRetainedMessages, err := graphClient.Users().ByUserId("user-id").Chats().GetAllRetainedMessages().GetAsGetAllRetainedMessagesGetResponse(context.Background(), nil)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.users().byUserId("{user-id}").chats().getAllRetainedMessages().get();

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let getAllRetainedMessages = await client.api('/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllRetainedMessages')
	.version('beta')
	.get();

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->users()->byUserId('user-id')->chats()->getAllRetainedMessages()->get()->wait();

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


Import-Module Microsoft.Graph.Beta.Users.Functions

Get-MgBetaUserChatRetainedMessage -UserId $userId

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.users.by_user_id('user-id').chats.get_all_retained_messages.get()

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(chatMessage)",
  "@odata.count": 10,
  "@odata.nextLink": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllRetainedMessages?$skip=10",
  "value": [
    {
      "@odata.type": "#microsoft.graph.chatMessage",
      "id": "1600457965467",
      "replyToId": null,
      "etag": "1600457965467",
      "messageType": "message",
      "createdDateTime": "2020-09-18T19:39:25.467Z",
      "lastModifiedDateTime": "2020-09-18T19:39:25.467Z",
      "lastEditedDateTime": null,
      "deletedDateTime": null,
      "subject": null,
      "summary": null,
      "chatId": "19:0de69e5e-2da8-4cf2-821f-5e6585b2c65b_5c64e248-3269-4268-a36e-0f80314e9c39@unq.gbl.spaces",
      "importance": "normal",
      "locale": "en-us",
      "webUrl": null,
      "channelIdentity": null,
      "policyViolation": null,
      "eventDetail": null,
      "from": {
        "application": null,
        "device": null,
        "conversation": null,
        "user": {
          "id": "0de69e5e-2da8-4cf2-821f-5e6585b2c65b",
          "displayName": "Richard Wilson",
          "userIdentityType": "aadUser"
        }
      },
      "body": {
        "contentType": "html",
        "content": "<div>\n<blockquote itemscope=\"\" itemtype=\"http://schema.skype.com/Reply\" itemid=\"1600457867820\">\n<strong itemprop=\"mri\" itemid=\"8:orgid:0de69e5e-2da8-4cf2-821f-5e6585b2c65b\">Richard Wilson</strong><span itemprop=\"time\" itemid=\"1600457867820\"></span>\n<p itemprop=\"preview\">1237</p>\n</blockquote>\n<p>this is a reply</p>\n</div>"
      },
      "attachments": [],
      "mentions": [],
      "reactions": []
    }
  ]
}

Microsoft Graph – dienstspezifische Drosselungslimiten

Freigeben über

chat: getAllRetainedMessages

Berechtigungen

HTTP-Anforderung

Optionale Abfrageparameter

Anforderungsheader

Anforderungstext

Antwort

Beispiele

Anforderung

Antwort

Feedback

Zusätzliche Ressourcen

Freigeben über

chat: getAllRetainedMessages

Berechtigungen

HTTP-Anforderung

Optionale Abfrageparameter

Anforderungsheader

Anforderungstext

Antwort

Beispiele

Anforderung

Antwort

Verwandte Inhalte

Feedback

Zusätzliche Ressourcen