Chats: getAllMessages

  • Artikel

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.

Rufen Sie alle Nachrichten aus allen Chats ab, an denen ein Benutzer beteiligt ist, einschließlich der 1:1-Chats, Gruppenchats und Besprechungschats.

Hinweis: 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.

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 | user-principal-name}/chats/getAllMessages

Optionale Abfrageparameter

Sie können den model Abfrageparameter verwenden, der die Werte A und B unterstützt, basierend auf dem bevorzugten Lizenzierungs- und Zahlungsmodell, wie in den folgenden Beispielen gezeigt.

GET /users/{id | user-principal-name}/chats/getAllMessages?model=A
GET /users/{id | user-principal-name}/chats/getAllMessages?model=B

Wenn kein model-Parameter angegeben ist, wird Auswertungsmodus verwendet.

Diese Methode unterstützt auch Datumsbereichsparameter , um die Antwort anzupassen, wie im folgenden Beispiel gezeigt.

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

Diese Methode unterstützt auch $filter. In der folgenden Tabelle sind Beispiele aufgeführt.

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 Control(Systemereignis)-Meldungen $filter=messageType eq 'systemEventMessage'
Ausschließen von Steuerungsmeldungen (Systemereignismeldungen) $filter=messageType ne 'systemEventMessage'

Hinweis: Diese Filterklauseln können mithilfe des or -Operators verknüpft werden. Eine Filterklausel kann mehrmals in einer Abfrage angezeigt werden, und sie kann jedes Mal nach einem anderen Wert filtern, wenn sie in der Abfrage angezeigt wird.

Anforderungsheader

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

Antwort

Wenn die Methode erfolgreich verläuft, werden ein 200 OK Antwortcode und eine Liste von chatMessages im Antworttext zurückgegeben.

Beispiel

Anforderung

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

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/getAllMessages?$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":[

         ]
      }
   ]
}

Verwandte Inhalte

Microsoft Graph – dienstspezifische Drosselungslimiten