Partager via

Supprimer un participant

  • Article

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 .

Espace de noms: microsoft.graph

Supprimer un participant spécifique dans un appel. Dans certains cas, il est approprié pour une application de supprimer un participant d’un appel actif. Cette action peut être effectuée avant ou après que le participant répond à l’appel. Lorsqu’un appelant actif est supprimé, il est immédiatement supprimé de l’appel sans notification préalable ou postérieure à la suppression. Lorsqu’un participant invité est supprimé, toute demande d’ajout de participant en attente est annulé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) Non prise en charge. Non prise en charge.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Calls.JoinGroupCall.All Calls.JoinGroupCallasGuest.All

La configuration d’une réunion d’application au niveau du locataire est requise pour permettre à une application d’appeler cette API. L’administrateur du locataire doit appeler l’applet de commande suivante sur le client distant PowerShell pour accorder l’autorisation à l’application d’appeler cette API. Pour plus d’informations, consultez Set-CsApplicationMeetingConfiguration.

PS C:\> Set-CsApplicationMeetingConfiguration -AllowRemoveParticipantAppIds @{Add="app_id"}

Requête HTTP

DELETE /app/calls/{id}/participants/{id}
DELETE /communications/calls/{id}/participants/{id}

Remarque : le chemin d’accès /app est obsolète. À l’avenir, utilisez le chemin d’accès /communications.

En-têtes de demande

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

Corps de la demande

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

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 204 No Content. Il ne retourne rien dans le corps de la réponse.

Exemples

Exemple 1 : Annuler le participant actif

Demande

L’exemple suivant illustre la demande.

DELETE https://graph.microsoft.com/beta/communications/calls/112f7296-5fa4-42ca-bae8-6a692b15d4b8/participants/a7ebfb2d-871e-419c-87af-27290b22e8db

Réponse

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

HTTP/1.1 204 No Content

Exemple 2 : Annuler un participant invité non actif

Inviter un participant à un appel existant

Note: Fournissez une valeur pour le participantId membre de l’objet invitationParticipantInfo afin de pouvoir l’utiliser pour annuler l’invitation ultérieurement.

POST https://graph.microsoft.com/beta/communications/calls/112f7296-5fa4-42ca-bae8-6a692b15d4b8/participants/invite
Content-Type: application/json
Content-Length: 464

{
  "participants": [
    {
      "@odata.type": "#microsoft.graph.invitationParticipantInfo",
      "identity": {
        "@odata.type": "#microsoft.graph.identitySet",
        "user": {
          "@odata.type": "#microsoft.graph.identity",
          "id": "278405a3-f568-4b3e-b684-009193463064",
          "identityProvider": "AAD"
        }
      },
      "participantId": "a7ebfb2d-871e-419c-87af-27290b22e8db"
    }
  ],
  "clientContext": "f2fa86af-3c51-4bc2-8fc0-475452d9764f"
}

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.type": "#microsoft.graph.inviteParticipantsOperation",
  "id": "eec3812a-fdc3-4fb4-825c-a06c9f35414e",
  "status": "Running",
  "clientContext": "f2fa86af-3c51-4bc2-8fc0-475452d9764f",
  "resultInfo": null,
  "participants": [
    {
      "endpointType": null,
      "id": null,
      "participantId": "a7ebfb2d-871e-419c-87af-27290b22e8db",
      "identity": {
        "user": {
          "id": "278405a3-f568-4b3e-b684-009193463064",
          "identityProvider": "AAD",
          "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
        },
        "application": null,
        "device": null,
        "phone": null
      }
    }
  ]
}

Supprimer le participant invité avant l’ajout du participant à la liste

DELETE https://graph.microsoft.com/beta/communications/calls/112f7296-5fa4-42ca-bae8-6a692b15d4b8/participants/a7ebfb2d-871e-419c-87af-27290b22e8db

Réponse

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

HTTP/1.1 204 No Content