Obter meetingAttendanceReport

Namespace: microsoft.graph

Obter o meetingAttendanceReport para uma reunião online ou um evento virtual. Quando uma reunião online termina, um relatório de presença é gerado para essa sessão.

Aviso

Esse método não dá suporte a reuniões de canal.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) OnlineMeetingArtifact.Read.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application OnlineMeetingArtifact.Read.All OnlineMeetingArtifact.Read. Chat

Para usar a permissão de aplicativo para essa API, os administradores de locatários devem criar uma política de acesso ao aplicativo e concedê-la a um usuário. A concessão de uma política de acesso ao aplicativo ao usuário autoriza o aplicativo configurado na política a buscar reuniões online e/ou artefatos de reunião online em nome desse usuário (com a ID do usuário especificada no caminho da solicitação). Para obter mais informações, consulte Permitir que os aplicativos acessem reuniões online em nome de um usuário.

Observação

A OnlineMeetingArtifact.Read.Chat permissão usa o consentimento específico do recurso. Aplica-se apenas aos relatórios de presença de reuniões gerais ou webinars.

Solicitação HTTP

Para obter um relatório de presença por ID com permissões delegadas (/me) e aplicativo (/users/{userId}):

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

Para obter um relatório de presença de uma sessão de webinar por ID com permissão delegada e de aplicativo:

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

Para obter um relatório de presença por ID para uma sessão da reunião geral usando permissões delegadas e de aplicativo:

GET /solutions/virtualEvents/townhalls/{townhallId}/sessions/{sessionId}/attendanceReports/{reportId}

Dica

Cuidado

  • O caminho /meetingAttendanceReport foi preterido. No futuro, use o /attendanceReports caminho para recuperar relatórios de presença para uma reunião online.
  • A propriedade attendanceRecords não retorna informações sobre uma sala para sessão de grupo.

Parâmetros de consulta opcionais

Este método dá suporte a Parâmetros de consulta OData para ajudar a personalizar a resposta.

Dica

A propriedade attendanceRecords fornece os dados dos participantes. É uma propriedade de navegação que não é retornada por padrão. Para recuperar attendanceRecords, use a API List attendance records . Para recuperar attendanceRecords em linha, use a $expand=attendanceRecords opção de consulta, conforme mostrado no exemplo 1.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, esse método retornará um código de 200 OK resposta e um objeto meetingAttendanceReport no corpo da resposta.

Exemplos

Exemplo 1: Obter o relatório de presença com registros de presença para uma reunião online por ID

O exemplo a seguir mostra como obter o relatório de presença de uma reunião online com permissão delegada.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZ/attendanceReports/c9b6db1c-d5eb-427d-a5c0-20088d9b22d7?$expand=attendanceRecords

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$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": "frederick.cormier@contoso.com",
      "totalAttendanceInSeconds": 1152,
      "role": "Presenter",
      "identity": {
        "id": "dc17674c-81d9-4adb-bfb2-8f6a442e4623",
        "displayName": "Frederick Cormier",
        "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
        }
      ]
    }
  ]
}

Exemplo 2: obter o relatório de presença de uma sessão de webinar por ID

O exemplo a seguir mostra como obter o relatório de presença de uma sessão de webinar com base em sua id.

Dica

A propriedade attendanceRecords fornece os dados dos participantes. É uma propriedade de navegação que não é retornada por padrão. Para recuperar attendanceRecords, use a API List attendance records . Como alternativa, para recuperar attendanceRecords na linha, use a $expand=attendanceRecords opção de consulta, conforme mostrado no exemplo 1.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$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"
    }
  ]
}

Exemplo 3: obter o relatório de presença de uma sessão da reunião geral por ID

O exemplo a seguir mostra como obter o relatório de presença de uma sessão da reunião geral com base em sua ID.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#solutions/virtualEvents/townhalls('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"
    }
  ]
}