Partilhar via

Listar meetingAttendanceReports

  • Artigo

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Obtenha uma lista de objetos meetingAttendanceReport para um onlineMeeting ou um virtualEvent. Sempre que uma reunião online ou um evento virtual terminar, é gerado um relatório de participação para essa sessão.

Aviso

  • Este método só devolve até 50 dos relatórios mais recentes.
  • Quando utiliza este método para listar relatórios de participação para uma reunião de canal, a API devolve relatórios de participação para cada reunião no canal, em vez de apenas os relatórios de participação da reunião especificada, que é o comportamento esperado para reuniões agendadas. Este comportamento é o mesmo independentemente do local onde a reunião do canal foi criada.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ❌ ❌ ❌

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

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

Para utilizar a permissão de aplicação para esta API, os administradores inquilinos têm de criar uma política de acesso à aplicação e concedê-la a um utilizador. Isto autoriza a aplicação configurada na política a obter reuniões online e/ou artefactos de reunião online em nome desse utilizador (com o ID de utilizador especificado no caminho do pedido). Para obter mais informações, consulte Permitir que as aplicações acedam a reuniões online em nome de um utilizador.

Solicitação HTTP

Para obter todos os relatórios de participação para uma reunião online com permissão delegada (/me) e aplicação (/users/{userId}):

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

Para obter todos os relatórios de participação de uma sessão de webinar com permissão delegada e de aplicação:

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

Dica

Parâmetros de consulta opcionais

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

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, este método devolve um 200 OK código de resposta e uma lista de objetos meetingAttendanceReport no corpo da resposta.

Dica

A propriedade attendanceRecords está vazia na resposta.

Exemplo

Exemplo 1: listar relatórios de participação para uma reunião online

Solicitação

GET https://graph.microsoft.com/beta/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZ/attendanceReports

Resposta

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

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",
  "value": [
    {
      "id": "c9b6db1c-d5eb-427d-a5c0-20088d9b22d7",
      "totalParticipantCount": 1,
      "meetingStartDateTime": "2021-10-05T04:38:23.945Z",
      "meetingEndDateTime": "2021-10-05T04:43:49.77Z",
      "attendanceRecords": []
    },
    {
      "id": "2c2c2454-7613-4d6e-9c7c-4cf7a6cdce89",
      "totalParticipantCount": 2,
      "meetingStartDateTime": "2021-10-04T23:13:31.658Z",
      "meetingEndDateTime": "2021-10-04T23:18:57.563Z",
      "attendanceRecords": []
    }
  ]
}

Exemplo 2: listar relatórios de participação para uma sessão de webinar

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports

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/beta/$metadata#solutions/virtualEvents/webinars('336f94f4-3a81-5130-43e9-88f3-fcb3582cde37')/sessions('a0f934c324b7785c')/attendanceReports/$entity",
  "value": [
    {
      "id": "c9b6db1c-d5eb-427d-a5c0-2022d7",
      "totalParticipantCount": 1,
      "meetingStartDateTime": "2021-10-05T04:38:23.945Z",
      "meetingEndDateTime": "2021-10-05T04:43:49.77Z",
      "externalEventInformation": [
        {
          "applicationId" : "67a527ba-ef0e-4ba2-88b6-4fa5e9711757",
          "externalEventId": "myExternalEventId"
        }
      ]
    },
    {
      "id": "2c2c2454-7613-4d6e-9c7c-4ce89",
      "totalParticipantCount": 2,
      "meetingStartDateTime": "2021-10-04T23:13:31.658Z",
      "meetingEndDateTime": "2021-10-04T23:18:57.563Z",
      "externalEventInformation": [
        {
          "applicationId" : "e3c6e27c-e2a1-4212-8d63-0729828ed4fa",
          "externalEventId": "anotherExternalEventId"
        }
      ]
    }
  ]
}