Créer un canal

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 .

Créez un canal dans une équipe, comme indiqué dans le corps de la demande. Lorsque vous créez un canal, la longueur maximale du canal est de 50 caractères displayName . Ce nom d’affichage apparaît pour l’utilisateur dans Microsoft Teams.

Vous pouvez ajouter un maximum de 200 membres lorsque vous créez un canal privé.

Remarque

  • Certains caractères spéciaux dans le nom du canal entraînent le renvoi d’une erreur par l’API Get filesFolder . Pour plus d’informations, voir Problèmes connus.
  • Lorsque vous créez un canal privé ou partagé, l’approvisionnement du site SharePoint peut échouer. Si l’approvisionnement du site échoue au bout de cinq minutes, utilisez l’API Get filesFolder pour déclencher l’approvisionnement.
  • Vous pouvez créer des canaux partagés avec un seul propriétaire initialement. L’ajout de plusieurs propriétaires entraîne un 400 Bad Request code d’erreur. Après la demande initiale, vous pouvez ajouter d’autres propriétaires à l’aide de l’API Ajouter un membre au canal .
  • La création d’un canal partagé n’est pas prise en charge dans Microsoft Graph Chine (21Vianet).

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.

Cette API prend en charge les autorisations d’administrateur. Les administrateurs de service Microsoft Teams peuvent accéder aux équipes dont ils ne sont pas membres.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Channel.Create Directory.ReadWrite.All, Group.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Channel.Create.Group Channel.Create, Directory.ReadWrite.All, Group.ReadWrite.All, Teamwork.Migrate.All

Remarque

  • L’autorisation Channel.Create.Group utilise un consentement spécifique aux ressources.
  • Les autorisations Group.ReadWrite.All et Directory.ReadWrite.All sont prises en charge uniquement à des fins de compatibilité descendante. Nous vous recommandons de mettre à jour vos solutions pour utiliser une autorisation différente répertoriée dans le tableau précédent et d’éviter d’utiliser ces autorisations à l’avenir.

Remarque : à l’avenir, Microsoft peut exiger que vous ou vos clients payiez des frais supplémentaires basés sur la quantité de données importées à l’aide des API de migration Teamwork.Migrate.All et/ou de migration.

Requête HTTP

POST /teams/{team-id}/channels

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON d’un objet canal .

Réponse

En cas de réussite, cette méthode renvoie un 201 Created code de réponse et un objet de canal dans le corps de la réponse pour un canal dont la valeur membershipType est ou standardprivate. Pour un canal dont la valeur membershipType est , sharedcette méthode retourne un 202 Accepted code de réponse et un lien vers teamsAsyncOperation.

Si la requête échoue, cette méthode renvoie un code de réponse 400 Bad Request. Voici quelques-unes des raisons qui peuvent être à l’origine de cette réponse :

  • createdDateTime est défini à l’avenir.
  • createdDateTime est correctement spécifié, mais l’attribut d’instance channelCreationMode est manquant ou défini sur une valeur non valide.

Exemples

Exemple 1 : créer un canal standard

Demande

L’exemple suivant illustre une demande de création d’un canal standard.

POST https://graph.microsoft.com/beta/teams/57fb72d0-d811-46f4-8947-305e6072eaa5/channels
Content-type: application/json

{
  "displayName": "Architecture Discussion",
  "description": "This channel is where we debate all future architecture plans",
  "membershipType": "standard"
}

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 201 Created
Content-type: application/json

{
  "id": "19:4b6bed8d24574f6a9e436813cb2617d8@thread.tacv2",
  "displayName": "Architecture Discussion",
  "description": "This channel is where we debate all future architecture plans"
}

Exemple 2 : créer un canal privé pour le compte de l’utilisateur

Demande

L’exemple suivant illustre une demande de création d’un canal privé et d’ajout d’un utilisateur en tant que propriétaire de l’équipe.

POST https://graph.microsoft.com/beta/teams/57fb72d0-d811-46f4-8947-305e6072eaa5/channels
Content-type: application/json

{
  "@odata.type": "#Microsoft.Graph.channel",
  "membershipType": "private",
  "displayName": "My First Private Channel",
  "description": "This is my first private channels",
  "members":
     [
        {
           "@odata.type":"#microsoft.graph.aadUserConversationMember",
           "user@odata.bind":"https://graph.microsoft.com/beta/users('62855810-484b-4823-9e01-60667f8b12ae')",
           "roles":["owner"]
        }
     ]
}

Remarque : Pour ajouter un compte invité au canal, pour la propriété rôles , utilisez la valeur guest.

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#teams('57fb72d0-d811-46f4-8947-305e6072eaa5')/channels/$entity",
    "id": "19:33b76eea88574bd1969dca37e2b7a819@thread.skype",
    "displayName": "My First Private Channel",
    "description": "This is my first private channels",
    "isFavoriteByDefault": null,
    "email": "",
    "webUrl": "https://teams.microsoft.com/l/channel/19:33b76eea88574bd1969dca37e2b7a819@thread.skype/My%20First%20Private%20Channel?groupId=57fb72d0-d811-46f4-8947-305e6072eaa5&tenantId=0fddfdc5-f319-491f-a514-be1bc1bf9ddc",
    "membershipType": "private"
}

Exemple 3 : créer un canal avec le type de disposition de conversation

L’exemple suivant montre comment créer un canal avec le type de disposition de conversation qui offre une expérience de conversation similaire aux conversations de groupe.

Demande

L’exemple suivant illustre une demande de création d’un canal avec layoutType défini sur chat.

POST https://graph.microsoft.com/beta/teams/57fb72d0-d811-46f4-8947-305e6072eaa5/channels
Content-type: application/json

{
  "displayName": "Project Collaboration",
  "description": "Discussion space for project team collaboration",
  "membershipType": "standard",
  "layoutType": "chat"
}

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 201 Created
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#teams('57fb72d0-d811-46f4-8947-305e6072eaa5')/channels/$entity",
  "id": "19:4b6bed8d24574f6a9e436813cb2617d8@thread.tacv2",
  "createdDateTime": "2024-12-08T12:30:45.123Z",
  "displayName": "Project Collaboration",
  "description": "Discussion space for project team collaboration",
  "membershipType": "standard",
  "layoutType": "chat",
  "isFavoriteByDefault": false,
  "email": "",
  "webUrl": "https://teams.microsoft.com/l/channel/19%3A4b6bed8d24574f6a9e436813cb2617d8%40thread.tacv2/Project%20Collaboration?groupId=57fb72d0-d811-46f4-8947-305e6072eaa5&tenantId=0afeb5d5-a667-4716-8fc7-733024389e91",
  "tenantId": "0afeb5d5-a667-4716-8fc7-733024389e91"
}

Exemple 4 : créer un canal en mode de migration

Demande

L’exemple suivant montre comment créer un canal pour importer des messages.

POST https://graph.microsoft.com/beta/teams/57fb72d0-d811-46f4-8947-305e6072eaa5/channels
Content-Type: application/json

{
  "@microsoft.graph.channelCreationMode": "migration",
  "displayName": "Import_150958_99z",
  "description": "Import_150958_99z",
  "createdDateTime": "2020-03-14T11:22:17.067Z"
}

Réponse

L’exemple suivant illustre la réponse. L’en-tête Content-Location dans la réponse spécifie le chemin d’accès au canal qui est provisionné. Une fois approvisionné, ce canal peut être utilisé pour importer des messages.

HTTP/1.1 201 Created
Location: /teams('57fb72d0-d811-46f4-8947-305e6072eaa5')/channels('19:4b6bed8d24574f6a9e436813cb2617d8@thread.tacv2')

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#teams('57fb72d0-d811-46f4-8947-305e6072eaa5')/channels/$entity",
    "id": "19:987c7a9fbe6447ccb3ea31bcded5c75c@thread.tacv2",
    "createdDateTime": null,
    "displayName": "Import_150958_99z",
    "description": "Import_150958_99z",
    "isFavoriteByDefault": null,
    "email": null,
    "webUrl": null,
    "membershipType": null,
    "moderationSettings": null
}

Exemple 5 : créer un canal standard avec des paramètres de modération

Demande

L’exemple suivant illustre une demande de création d’un canal standard avec des paramètres de modération. Cette opération ne peut être effectuée que pour un canal standard.

POST https://graph.microsoft.com/beta/teams/57fb72d0-d811-46f4-8947-305e6072eaa5/channels
Content-type: application/json

{
    "displayName": "TestChannelModeration",
    "description": "Test channel moderation.",
    "membershipType": "standard",
    "moderationSettings": {
        "userNewMessageRestriction": "everyoneExceptGuests",
        "replyRestriction": "everyone",
        "allowNewMessageFromBots": true,
        "allowNewMessageFromConnectors": true
    }
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#teams('57fb72d0-d811-46f4-8947-305e6072eaa5')/channels/$entity",
    "id": "19:12b76eea88574bd1969dca37e2b7a819@thread.skype",
    "displayName": "My First Private Channel",
    "description": "This is my first private channels",
    "isFavoriteByDefault": null,
    "email": "",
    "webUrl": "https://teams.microsoft.com/l/channel/19:12b76eea88574bd1969dca37e2b7a819@thread.skype/My%20First%20Private%20Channel?groupId=57fb72d0-d811-46f4-8947-305e6072eaa5&tenantId=0fddfdc5-f319-491f-a514-be1bc1bf9ddc",
    "membershipType": "standard"
}

Exemple 6 : Créer un canal privé pour le compte de l’utilisateur à l’aide du nom d’utilisateur principal

Demande

L’exemple suivant illustre une demande de création d’un canal privé et d’ajout d’un utilisateur en tant que propriétaire de l’équipe.

POST https://graph.microsoft.com/beta/teams/57fb72d0-d811-46f4-8947-305e6072eaa5/channels
Content-type: application/json

{
  "@odata.type": "#Microsoft.Graph.channel",
  "membershipType": "private",
  "displayName": "My First Private Channel",
  "description": "This is my first private channels",
  "members":
     [
        {
           "@odata.type":"#microsoft.graph.aadUserConversationMember",
           "user@odata.bind":"https://graph.microsoft.com/beta/users('jacob@contoso.com')",
           "roles":["owner"]
        }
     ]
}

Remarque : Pour ajouter un compte invité au canal, pour la propriété rôles , utilisez la valeur guest.

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 0

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#teams('57fb72d0-d811-46f4-8947-305e6072eaa5')/channels/$entity",
    "id": "19:33b76eea88574bd1969dca37e2b7a819@thread.skype",
    "displayName": "My First Private Channel",
    "description": "This is my first private channels",
    "isFavoriteByDefault": null,
    "email": "",
    "webUrl": "https://teams.microsoft.com/l/channel/19:33b76eea88574bd1969dca37e2b7a819@thread.skype/My%20First%20Private%20Channel?groupId=57fb72d0-d811-46f4-8947-305e6072eaa5&tenantId=0fddfdc5-f319-491f-a514-be1bc1bf9ddc",
    "membershipType": "private"
}

Exemple 7 : créer un canal partagé pour le compte d’un utilisateur

Demande

L’exemple suivant montre comment créer un canal partagé.

POST https://graph.microsoft.com/beta/teams/57fb72d0-d811-46f4-8947-305e6072eaa5/channels
Content-type: application/json

{
  "displayName": "My First Shared Channel",
  "description": "This is my first shared channel",
  "membershipType": "shared",
  "members": [
    {
      "@odata.type": "#microsoft.graph.aadUserConversationMember",
      "user@odata.bind": "https://graph.microsoft.com/beta/users('7640023f-fe43-gv3f-9gg4-84a9efe4acd6')",
      "roles": [
        "owner"
      ]
    }
  ]
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Location: /teams/7640023f-fe43-4cc7-9bd3-84a9efe4acd6/operations/359d75f6-2bb8-4785-ab2d-377bf3d573fa
Content-Length: 0

Exemple 8 : Créer un canal partagé avec l’équipe hôte

Demande

L’exemple suivant montre comment créer un canal partagé avec l’équipe hôte.

POST https://graph.microsoft.com/beta/teams/57fb72d0-d811-46f4-8947-305e6072eaa5/channels
Content-type: application/json

{
  "displayName": "My First Shared Channel",
  "description": "This is my first shared channel",
  "membershipType": "shared",
  "members": [
    {
      "@odata.type": "#microsoft.graph.aadUserConversationMember",
      "user@odata.bind": "https://graph.microsoft.com/beta/users('7640023f-fe43-gv3f-9gg4-84a9efe4acd6')",
      "roles": [
        "owner"
      ]
    }
  ],
  "sharedWithTeams":[
    {
      "id": "57fb72d0-d811-46f4-8947-305e6072eaa5"
    }
  ]
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Location: /teams/7640023f-fe43-4cc7-9bd3-84a9efe4acd6/operations/359d75f6-2bb8-4785-ab2d-377bf3d573fa
Content-Length: 0