Appel : rejeter

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 .

Permettre à un bot de rejeter un appel entrant. La demande d’appel entrant peut être une invitation d’un participant à un appel de groupe ou à un appel pair à pair. Si une invitation à un appel de groupe est reçue, la notification contient les paramètres chatInfo et meetingInfo .

Le bot doit répondre ou rejeter l’appel avant l’expiration de l’appel. La valeur actuelle du délai d’attente est de 15 secondes.

Cette API ne met pas fin aux appels existants qui ont déjà reçu une réponse. Utilisez Supprimer un appel pour mettre fin à un appel.

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 Non prise en charge. Non prise en charge.

Requête HTTP

POST /app/calls/{id}/reject
POST /communications/calls/{id}/reject

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 les autorisations.
Content-type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, indiquez un objet JSON avec les paramètres suivants.

Paramètre Type Description
reason (Raison) String La raison du rejet. Les valeurs possibles sont les suivantes : None, Busy et Forbidden.
callbackUri String Permet aux bots de fournir un URI de rappel spécifique pour l’appel en cours afin de recevoir des notifications ultérieures. Si cette propriété n’est pas définie, l’URI de rappel global du bot est utilisé à la place. L’URI doit être https.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 202 Accepted. Elle ne renvoie rien dans le corps de la réponse.

Exemples

Les exemples suivants montrent comment appeler cette API.

Exemple 1 : rejeter un appel entrant avec la raison « Occupé »

Demande

Les exemples suivants illustrent une requête.

POST https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/reject
Content-Type: application/json
Content-Length: 24

{
  "reason": "busy"
}
Réponse

Les exemples suivants montrent la réponse.

HTTP/1.1 202 Accepted

Exemple 2 : rejeter un appel entrant avec la raison « Aucun »

Notification - Entrant
POST https://bot.contoso.com/api/call
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "created",
      "resourceUrl": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "@odata.id": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896",
        "state": "incoming",
        "direction": "incoming",
        "source": {
          "identity": {
            "user": {
              "displayName": "John",
              "id": "112f7296-5fa4-42ca-bae8-6a692b15d4b8"
            }
          },
          "region": "westus",
          "languageId": "en-US"
        },
        "targets": [
          {
            "identity": {
              "application": {
                "displayName": "Calling Bot",
                "id": "2891555a-92ff-42e6-80fa-6e1300c6b5c6"
              }
            },
            "region": "westus",
            "languageId": "en-US"
          }
        ],
        "requestedModalities": [ "audio", "video" ]
      }
    }
  ]
}
Demande

Les exemples suivants illustrent une requête.

POST https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/reject
Content-Type: application/json
Content-Length: 24

{
  "reason": "none"
}
Réponse

Les exemples suivants montrent la réponse.

HTTP/1.1 202 Accepted
Notification - supprimée
POST https://bot.contoso.com/api/calls
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "deleted",
      "resourceUrl": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "@odata.id": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896"
      }
    }
  ]
}
  • Last updated on