userTeamwork : getAllRetainedTargetedMessages

Espace de noms: microsoft.graph

Obtenez tous les messages ciblés retenus envoyés à un utilisateur spécifique dans des conversations de groupe et des canaux.

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

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

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

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
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 TeamworkTargetedMessage.Read.All Non disponible.

Requête HTTP

GET /users/{user-id | userPrincipalName}/teamwork/getAllRetainedTargetedMessages

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête OData suivants pour personnaliser la réponse. Pour des informations générales, consultez paramètres de la requête OData.

Nom Description
$filter Le paramètre de requête $filter prend en charge les requêtes de plages de dates et d’heures sur la propriété lastModifiedDateTime à l’aide de paramètres de plage de dates.
$top Utilisez le paramètre de requête $top pour contrôler le nombre d’éléments par réponse.

Opérateurs $filter pris en charge

Les expressions de filtre suivantes sont prises en charge :

  • lastModifiedDateTime gt {datetime} - Renvoie les messages modifiés après la date et l’heure spécifiées.
  • lastModifiedDateTime lt {datetime} - Renvoie les messages modifiés avant la date et l’heure spécifiées.
  • from/application/id eq '{id}' - Renvoie les messages envoyés par un ID d’application spécifique.

Vous pouvez combiner plusieurs expressions de filtre à l’aide de l’opérateur and . Par exemple :

GET /users/{user-id | userPrincipalName}/teamwork/getAllRetainedTargetedMessages?$filter=lastModifiedDateTime gt 2024-01-01T00:00:00Z and lastModifiedDateTime lt 2024-12-31T23:59:59Z

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

En cas de réussite, cette fonction renvoie un 200 OK code de réponse et une collection d’objets targetedChatMessage dans le corps de la réponse.

La réponse inclut la propriété @odata.nextLink pour la pagination, le cas échéant.

Exemples

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/users/f47b5f54-6968-4706-a522-31e842b12345/teamwork/getAllRetainedTargetedMessages

Réponse

L’exemple suivant illustre la 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/v1.0/$metadata#Collection(targetedChatMessage)",
  "@odata.count": 1,
  "@odata.nextLink": "https://graph.microsoft.com/v1.0/users/f47b5f54-6968-4706-a522-31e842b12345/teamwork/getAllRetainedTargetedMessages?$top=1&$skiptoken=Token",
  "value": [
    {
      "@odata.type": "#microsoft.graph.targetedChatMessage",
      "id": "1684961612345",
      "replyToId": null,
      "etag": "1684962512345",
      "messageType": "message",
      "createdDateTime": "2023-05-24T20:54:49.858Z",
      "lastModifiedDateTime": "2023-05-24T21:13:15Z",
      "lastEditedDateTime": "2023-05-24T21:09:00.224Z",
      "deletedDateTime": null,
      "subject": "",
      "summary": null,
      "chatId": "19:1a546d42d8b54a16903716f49b512345@thread.v2",
      "importance": "normal",
      "locale": "en-us",
      "webUrl": null,
      "channelIdentity": null,
      "onBehalfOf": null,
      "policyViolation": null,
      "eventDetail": null,
      "from": {
        "device": null,
        "user": null,
        "application": {
          "@odata.type": "#microsoft.graph.teamworkApplicationIdentity",
          "id": "6d23e712-527b-406f-8d59-d02927885918",
          "displayName": "Breakthru",
          "applicationIdentityType": "bot"
        }
      },
      "body": {
        "contentType": "html",
        "content": "<p>5/24 group chat</p>"
      },
      "attachments": [],
      "mentions": [],
      "reactions": [],
      "messageHistory": [],
      "recipient": {
        "@odata.type": "#microsoft.graph.identity",
        "id": "1273a016-201d-4f95-8083-1b7f99b3edeb",
        "displayName": "Adele Vance"
      }
    }
  ]
}
  • Last updated on