Partager via

Obtenir meetingAttendanceReport

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

Obtenez le meetingAttendanceReport pour un onlineMeeting ou un virtualEvent. À la fin d’une réunion en ligne, un rapport de présence est généré pour cette session.

Avertissement

Cette méthode ne prend pas en charge les réunions de canal.

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

Pour utiliser l’autorisation d’application pour cette API, les administrateurs clients doivent créer une stratégie d’accès à l’application et l’accorder à un utilisateur. L’octroi d’une stratégie d’accès à l’application à l’utilisateur autorise l’application configurée dans la stratégie à récupérer des réunions en ligne et/ou des artefacts de réunion en ligne pour le compte de cet utilisateur (avec l’ID utilisateur spécifié dans le chemin de la demande). Pour plus d’informations, consultez Autoriser les applications à accéder aux réunions en ligne pour le compte d’un utilisateur.

Requête HTTP

Pour obtenir un rapport de présence d’une réunion en ligne par ID avec l’autorisation déléguée (/me) et l’application (/users/{userId}) :

GET /me/onlineMeetings/{meetingId}/attendanceReports/{reportId}
GET /users/{userId}/onlineMeetings/{meetingId}/attendanceReports/{reportId}

Pour obtenir le rapport de présence de la dernière session d’une réunion en ligne avec l’autorisation déléguée (/me) et l’application (/users/{userId}) :

GET /me/onlineMeetings/{meetingId}/meetingAttendanceReport
GET /users/{userId}/onlineMeetings/{meetingId}/meetingAttendanceReport

Pour obtenir un rapport de présence pour une session de webinaire par ID avec l’autorisation déléguée et l’autorisation d’application :

GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports/{reportId}

Conseil

Attention

  • Le chemin d’accès /meetingAttendanceReport est obsolète. À l’avenir, utilisez le /attendanceReports chemin d’accès pour récupérer les rapports de présence pour une réunion en ligne.
  • Le /meetingAttendanceReport chemin d’accès reste en version bêta pour la compatibilité descendante. Toutefois, pour obtenir la même réponse, vous devez ajouter l’option de expand requête. Pour plus d’informations, consultez la section Paramètres de requête facultatifs .
  • La propriété attendanceRecords ne retourne pas d’informations sur une salle pour petit groupe.

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.

Conseil

La propriété attendanceRecords fournit des données sur les participants. Il s’agit d’une propriété de navigation qui n’est pas retournée par défaut. Pour récupérer les enregistrements attendanceRecords, utilisez l’API Répertorier les enregistrements de présence . Pour récupérer les enregistrements attendanceRecords en ligne, utilisez l’option $expand=attendanceRecords de requête, comme illustré dans l’exemple 1.

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 200 OK code de réponse et un objet meetingAttendanceReport dans le corps de la réponse.

Exemples

Exemple 1 : Obtenir le rapport de présence avec les enregistrements de présence pour une réunion en ligne par ID

L’exemple suivant montre comment obtenir le rapport de présence avec les enregistrements de présence inline pour une réunion en ligne avec autorisation déléguée.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZ/attendanceReports/2c2c2454-7613-4d6e-9c7c-4cf7a6cdce89?$expand=attendanceRecords

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 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('16664f75-11dc-4870-bec6-38c1aaa81431')/onlineMeetings('MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZ')/attendanceReports('c9b6db1c-d5eb-427d-a5c0-20088d9b22d7')",
  "id": "c9b6db1c-d5eb-427d-a5c0-20088d9b22d7",
  "totalParticipantCount": 1,
  "meetingStartDateTime": "2021-10-05T04:38:23.945Z",
  "meetingEndDateTime": "2021-10-05T04:43:49.77Z",
  "attendanceRecords": [
    {
      "emailAddress": "(email address)",
      "totalAttendanceInSeconds": 1152,
      "role": "Presenter",
      "identity": {
        "id": "(redacted)",
        "displayName": "(redacted)",
        "tenantId": null
      },
      "attendanceIntervals": [
        {
          "joinDateTime": "2021-03-16T18:59:52.2782182Z",
          "leaveDateTime": "2021-03-16T19:06:47.7218491Z",
          "durationInSeconds": 415
        },
        {
          "joinDateTime": "2021-03-16T19:09:23.9834702Z",
          "leaveDateTime": "2021-03-16T19:16:31.1381195Z",
          "durationInSeconds": 427
        },
        {
          "joinDateTime": "2021-03-16T19:20:27.7094382Z",
          "leaveDateTime": "2021-03-16T19:25:37.7121956Z",
          "durationInSeconds": 310
        }
      ]
    }
  ]
}

Exemple 2 : Obtenir le dernier rapport de présence pour une réunion en ligne

L’exemple suivant montre une demande d’obtention d’un rapport de présence à une réunion pour la dernière session d’une réunion en ligne.

Demande

L’exemple suivant montre une requête qui utilise une autorisation déléguée.

GET https://graph.microsoft.com/beta/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy/meetingAttendanceReport

La requête suivante utilise l’autorisation d’application.

GET https://graph.microsoft.com/beta/users/dc74d9bb-6afe-433d-8eaa-e39d80d3a647/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy/meetingAttendanceReport

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 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('dc74d9bb-6afe-433d-8eaa-e39d80d3a647')/onlineMeetings('MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy')/meetingAttendanceReport/$entity",
  "attendanceRecords": [
    {
      "emailAddress": "email address",
      "totalAttendanceInSeconds": 1558,
      "role": "Organizer",
      "identity": {
        "id": "dc74d9bb-6afe-433d-8eaa-e39d80d3a647",
        "displayName": "(redacted)",
        "tenantId": null
      },
      "attendanceIntervals": [
        {
          "joinDateTime": "2021-03-16T18:59:46.598956Z",
          "leaveDateTime": "2021-03-16T19:25:45.4473057Z",
          "durationInSeconds": 1558
        }
      ]
    },
    {
      "emailAddress": "email address",
      "totalAttendanceInSeconds": 1152,
      "role": "Presenter",
      "identity": {
        "id": "(redacted)",
        "displayName": "(redacted)",
        "tenantId": null
      },
      "attendanceIntervals": [
        {
          "joinDateTime": "2021-03-16T18:59:52.2782182Z",
          "leaveDateTime": "2021-03-16T19:06:47.7218491Z",
          "durationInSeconds": 415
        },
        {
          "joinDateTime": "2021-03-16T19:09:23.9834702Z",
          "leaveDateTime": "2021-03-16T19:16:31.1381195Z",
          "durationInSeconds": 427
        },
        {
          "joinDateTime": "2021-03-16T19:20:27.7094382Z",
          "leaveDateTime": "2021-03-16T19:25:37.7121956Z",
          "durationInSeconds": 310
        }
      ]
    }
  ],
  "totalParticipantCount": 2
}

Exemple 3 : Obtenir le rapport de présence pour une session de webinaire par ID

L’exemple suivant montre comment obtenir le rapport de présence pour une session de webinaire en fonction de son ID.

Conseil

La propriété attendanceRecords fournit des données sur les participants. Il s’agit d’une propriété de navigation qui n’est pas retournée par défaut. Pour récupérer les enregistrements attendanceRecords, utilisez l’API Répertorier les enregistrements de présence . Sinon, pour récupérer les enregistrements attendanceRecords en ligne, utilisez l’option $expand=attendanceRecords de requête, comme illustré dans l’exemple 1.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/f8ce2a5f-0e6a-4186-aa90-1f64bc023566@5466a424-aadf-425c-9b24-034ca28d4bdd/sessions/8d62dd52-4dff-4c75-96a9-f905cc3ff942/attendanceReports/b76965d4-0763-496e-9980-b323c5f3aa3b

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 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#solutions/virtualEvents/webinars('f8ce2a5f-0e6a-4186-aa90-1f64bc023566@5466a424-aadf-425c-9b24-034ca28d4bdd')/sessions('8d62dd52-4dff-4c75-96a9-f905cc3ff942')/attendanceReports('b76965d4-0763-496e-9980-b323c5f3aa3b')",
  "id": "b76965d4-0763-496e-9980-b323c5f3aa3b",
  "totalParticipantCount": 2,
  "meetingStartDateTime": "2021-10-04T23:13:31.658Z",
  "meetingEndDateTime": "2021-10-04T23:18:57.563Z",
  "externalEventInformation": [
    {
      "applicationId" : "67a527ba-ef0e-4ba2-88b6-4fa5e9711757",
      "externalEventId": "myExternalEventId"
    }
  ]
}