Obter meetingAttendanceReport
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 a meetingAttendanceReport para um onlineMeeting ou um virtualEvent. Quando uma reunião online termina, é gerado um relatório de participação para essa sessão.
Aviso
Este método não suporta reuniões de canal.
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. A concessão de uma política de acesso de aplicação ao utilizador 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 um relatório de participação de uma reunião online por ID com permissão delegada (/me
) e aplicação (/users/{userId}
):
GET /me/onlineMeetings/{meetingId}/attendanceReports/{reportId}
GET /users/{userId}/onlineMeetings/{meetingId}/attendanceReports/{reportId}
Para obter o relatório de participação da última sessão de uma reunião online com permissão delegada (/me
) e aplicação (/users/{userId}
):
GET /me/onlineMeetings/{meetingId}/meetingAttendanceReport
GET /users/{userId}/onlineMeetings/{meetingId}/meetingAttendanceReport
Para obter um relatório de participação para uma sessão de webinar por ID com permissão delegada e de aplicação:
GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports/{reportId}
Dica
- userId é o ID de objeto de um utilizador na página de gestão de utilizadores do centro > de administração do Microsoft Entra. Para obter mais informações, consulte Permitir que as aplicações acedam a reuniões online em nome de um utilizador.
-
meetingId
é o ID de um objeto onlineMeeting . -
reportId
é o ID de um objeto meetingAttendanceReport . -
webinarId
é o ID de um objeto virtualEventWebinar . -
sessionId
é o ID de um objeto virtualEventSession . - Apenas o organizador da reunião/webinar ou co-organizador pode aceder a esta API.
Cuidado
- O caminho
/meetingAttendanceReport
foi preterido. No futuro, utilize o/attendanceReports
caminho para obter relatórios de participação para uma reunião online. - O
/meetingAttendanceReport
caminho permanecerá em beta para retrocompatibilidade. No entanto, para obter a mesma resposta, tem de adicionar a opçãoexpand
de consulta. Para obter detalhes, veja a secção Parâmetros de consulta opcionais . - A propriedade attendanceRecords não devolve informações sobre uma sala simultânea.
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 é devolvida por predefinição. Para obter assiduidadeRegistos, utilize a API Listar registos de presença . Para obter assiduidadeRegistos na linha, utilize a opção $expand=attendanceRecords
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, este método devolve um 200 OK
código de resposta e um objeto meetingAttendanceReport no corpo da resposta.
Exemplos
Exemplo 1: Obter o relatório de participação com registos de participação para uma reunião online por ID
O exemplo seguinte mostra como colocar o relatório de participação com registos de participação inline para uma reunião online com permissão delegada.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZ/attendanceReports/2c2c2454-7613-4d6e-9c7c-4cf7a6cdce89?$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/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
}
]
}
]
}
Exemplo 2: obter o relatório de participação mais recente de uma reunião online
O exemplo seguinte mostra um pedido para obter um relatório de participação na reunião para a última sessão de uma reunião online.
Solicitação
O exemplo seguinte mostra um pedido que utiliza a permissão delegada.
GET https://graph.microsoft.com/beta/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy/meetingAttendanceReport
O pedido seguinte utiliza a permissão da aplicação.
GET https://graph.microsoft.com/beta/users/dc74d9bb-6afe-433d-8eaa-e39d80d3a647/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy/meetingAttendanceReport
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#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
}
Exemplo 3: Obter o relatório de participação de uma sessão de webinar por ID
O exemplo seguinte mostra como obter o relatório de participação de uma sessão de webinar com base no respetivo ID.
Dica
A propriedade attendanceRecords fornece os dados dos participantes. É uma propriedade de navegação que não é devolvida por predefinição. Para obter assiduidadeRegistos, utilize a API Listar registos de presença . Em alternativa, para obter attendanceRecords na linha, utilize a opção $expand=attendanceRecords
de consulta, conforme mostrado no exemplo 1.
Solicitação
O exemplo a seguir mostra uma solicitação.
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
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('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"
}