Partager via

channel : archive

  • 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 .

Archiver un canal dans une équipe. Lorsqu’un canal est archivé, les utilisateurs ne peuvent pas envoyer de nouveaux messages ou réagir aux messages existants dans le canal, modifier les paramètres du canal ou apporter d’autres modifications au canal.

Vous pouvez supprimer un canal archivé ou y ajouter et supprimer des membres. Si vous archivez une équipe, ses canaux sont également archivés.

L’archivage est une opération asynchrone ; un canal est archivé une fois l’opération d’archivage asynchrone terminée, ce qui peut se produire après le retour de la réponse.

Un canal sans propriétaire ou qui appartient à un groupe qui n’a pas de propriétaire ne peut pas être archivé.

Pour restaurer un canal à partir de son état archivé, utilisez la méthode canal : unarchive . Un canal ne peut pas être archivé ou désarchivé si son équipe est archivée.

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) ChannelSettings.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application ChannelSettings.ReadWrite.All Non disponible.

Remarque: cet API prend en charge les autorisations d’administrateur. Les utilisateurs disposant du rôle Administrateur général ou Administrateur de service Microsoft Teams peuvent accéder aux équipes dont ils ne sont pas membres.

Requête HTTP

POST /teams/{team-id}/channels/{channel-id}/archive
POST /groups/{team-id}/team/channels/{channel-id}/archive

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Facultatif.

Corps de la demande

Dans le corps de la demande, vous pouvez éventuellement fournir un objet JSON avec le paramètre suivant.

Paramètre Type Description
shouldSetSpoSiteReadOnlyForMembers Valeur booléenne Définit s’il faut définir des autorisations pour les membres du canal en lecture seule sur le site SharePoint Online associé à l’équipe. Si vous le définissez sur false ou si vous omettez le paramètre, cette étape est ignorée.

L’exemple suivant montre le corps de la requête avec shouldSetSpoSiteReadOnlyForMembers défini sur true.

{
  "shouldSetSpoSiteReadOnlyForMembers": true
}

Réponse

Si l’archivage est démarré avec succès, cette méthode renvoie un 202 Accepted code de réponse. La réponse contient un Location en-tête qui spécifie l’emplacement de teamsAsyncOperation qui a été créé pour gérer l’archivage du canal dans une équipe. Vérifier l’état de l’opération archivage en faisant une requête GET à cet emplacement.

Exemples

Exemple 1 : Archiver un canal

L’exemple suivant montre une demande d’archivage d’un canal.

Demande

POST https://graph.microsoft.com/beta/teams/16dc05c0-2259-4540-a970-3580ff459721/channels/19:v32db348d9264477abcf18ffa2cf76dc@thread.tacv2/archive

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 202 Accepted
Location: /teams/16dc05c0-2259-4540-a970-3580ff459721/operations/b7ee702a-d87f-4cc6-82b9-e731c16d3aba
Content-Type: text/plain
Content-Length: 0

Exemple 2 : Archiver un canal lorsque l’équipe est archivée

L’exemple suivant montre une demande d’archivage d’un canal qui échoue parce que l’équipe est archivée . l’équipe doit être active pour archiver ou annuler l’archivage d’un canal.

Demande

POST https://graph.microsoft.com/beta/teams/16dc05c0-2259-4540-a970-3580ff459721/channels/19:v32db348d9264477abcf18ffa2cf76dc@thread.tacv2/archive

Réponse

L’exemple suivant montre le code de 400 Bad Request réponse avec un message d’erreur correspondant.

http/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 193

{
    "error": {
        "code": "BadRequest",
        "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
        "innerError": {
            "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
            "code": "Unknown",
            "innerError": {},
            "date": "2023-12-11T04:26:35",
            "request-id": "8f897345980-f6f3-49dd-83a8-a3064eeecdf8",
            "client-request-id": "50a0er33-4567-3f6c-01bf-04d144fc8bbe"
        }
    }
}