Créer un canal

Espace de noms: microsoft.graph

Important

Les API sous /beta la version dans Microsoft Graph sont sujettes à modification. 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 la version 1.0, utilisez le sélecteur de version.

Créez un canal dans une équipe, comme spécifié dans le corps de la requête.

Important

Les canaux partagés sont actuellement en préversion publique. Pendant ce temps, Microsoft API Graph pour créer un canal partagé est disponible pour un public limité. Nous vous recommandons de créer des canaux partagés dans le client Teams et d’utiliser les API Microsoft Graph pour les gérer. Pour plus d’informations sur l’activation des canaux partagés dans le client Teams, consultez Canaux partagés dans Microsoft Teams (préversion).

Autorisations

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire) Channel.Create, Group.ReadWrite.All , Directory.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge.
Application Channel.Create.Group , Channel.Create, Teamwork.Migrate.All, Group.ReadWrite.All*, Directory.ReadWrite.All**

Remarque :

  • Les autorisations marquées avec * utilisent consentement spécifique à la ressource.
  • Les autorisations marquées avec ** sont uniquement pris en charge pour la compatibilité ascendante. 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’Api prend en charge les autorisations d’administrateurs. Les administrateurs généraux et les administrateurs de services Microsoft Teams peuvent accéder à des équipes dont ils ne sont pas membres.

Remarque : À l’avenir, Microsoft vous obligera peut-être, vous ou vos clients, à payer des frais supplémentaires en fonction de la quantité de données importées à l’aide des API 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.
Content-Type application/json. Obligatoire.

Corps de la demande

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

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet de canal dans le corps de la réponse pour le canal avec une valeur membershipType de standard ou private. Pour le canal avec une valeur membershipType de shared, cette méthode retourne 202 Accepted la réponse qui contient 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 montre 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

Voici un exemple de 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 montre une demande de création d’un canal privé et d’ajout d’un utilisateur en tant que propriétaire d’é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"]
        }
     ]
}

Réponse

Voici un exemple de 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 en mode de migration

Demande

L’exemple suivant montre comment créer un canal qui sera utilisé 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

Voici un exemple de réponse. L’en-tête Content-Location de la réponse spécifie le chemin d’accès au canal en cours d’approvisionnement. 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 4 : Créer un canal standard avec des paramètres de modération

Demande

L’exemple suivant montre 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

Voici un exemple de 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 5 : Créer un canal privé pour le compte de l’utilisateur à l’aide du nom d’utilisateur principal

Demande

L’exemple suivant montre une demande de création d’un canal privé et d’ajout d’un utilisateur en tant que propriétaire d’é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"]
        }
     ]
}

Réponse

Voici un exemple de 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 6 : 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

Voici un exemple de 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

Voir aussi