Partager via

conversations : getAllMessages

  • Article

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Obtenir tous les messages de toutes les conversations auxquelles un utilisateur participe, y compris les conversations en un seul, les conversations de groupe et les conversations de réunion.

Note: Il s’agit d’une API limitée qui prend en charge les model=A modèles de paiement et .model=B Pour plus d’informations, consultez Modèles de paiement. Si vous ne spécifiez pas de modèle de paiement dans votre requête, le mode d’évaluation par défaut est utilisé.

Selon le modèle de paiement que vous choisissez, une licence peut également être requise.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Non prise en charge. Non prise en charge.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Chat.Read.All Chat.ReadWrite.All

Requête HTTP

GET /users/{id | user-principal-name}/chats/getAllMessages

Paramètres facultatifs de la requête

Vous pouvez utiliser le paramètre de requête model , qui prend en charge les valeurs A et B, en fonction du modèle de licence et de paiement préféré, comme illustré dans les exemples suivants.

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

Si aucun model paramètre n’est spécifié, le mode d’évaluation est utilisé.

Cette méthode prend également en charge les paramètres de plage de dates pour personnaliser la réponse, comme illustré dans l’exemple suivant.

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

Cette méthode prend également en charge $filter. Le tableau suivant répertorie des exemples.

Scénario Paramètre $filter Valeurs possibles
Obtenir les messages envoyés par type d’identité d’utilisateur $filter=from/user/userIdentityType eq « {teamworkUserIdentityType} » aadUser, onPremiseAadUser, anonymousGuest, federatedUser, personalMicrosoftAccountUser, skypeUser, phoneUser
Obtenir les messages envoyés par type d’application $filter=from/application/applicationIdentityType eq « {teamworkApplicationIdentity} » aadApplication, bot, tenantBot, office365Connector, outgoingWebhook
Obtenir les messages envoyés par id d’utilisateur $filter=from/user/id eq '{oid}'
Obtenir des messages de contrôle(événement système) $filter=messageType eq 'systemEventMessage'
Exclure les messages de contrôle (événement système) $filter=messageType ne 'systemEventMessage'

Note: Ces clauses de filtre peuvent être jointes à l’aide de l’opérateur or . Une clause de filtre peut apparaître plusieurs fois dans une requête, et elle peut filtrer sur une valeur différente chaque fois qu’elle apparaît dans la requête.

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et une liste de chatMessages dans le corps de la réponse.

Exemple

Demande

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

Réponse

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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":[

         ]
      }
   ]
}

Contenu connexe

Limites de limitation spécifiques au service Microsoft Graph