Casos de uso da API do webinar de eventos virtuais

As APIs de webinar de eventos virtuais do Microsoft Graph permitem que você obtenha dados do webinar do Teams e crie, atualize e cancele programaticamente um webinar do Teams.

Para você fazer o melhor uso das APIs de webinar de eventos virtuais do Graph, é útil entender as personas para os usuários que acessam a experiência do webinar do Teams:

  • Os organizadores são os funcionários (na sua organização) que gerenciam o webinar. Eles são a autoridade no cronograma e nos participantes. Eles configuram os atributos do webinar, como título, tema, experiência do participante e regras de email.  
  • Os apresentadores são funcionários (em sua organização) ou convidados que conduzem o webinar.  
  • Os registrantes são usuários (dentro ou fora da sua organização) que se inscreveram para um webinar. Eles podem ser registrados, colocados na lista de espera ou rejeitados. Eles podem optar por cancelar o registro do webinar.  
  • Os participantes são os inscritos que participaram do webinar. Eles precisam se registrar por meio de um portal e responder a perguntas de registro.
  • O administrador de locatários do Teams deve autorizar aplicativos personalizados com permissões apropriadas.

Você pode usar os seguintes tipos de recursos para criar sua solução de webinar:

  • virtualEventWebinar – usado para criar, obter, atualizar, publicar, cancelar e listar webinars do Teams.
  • virtualEventRegistration – usado para criar, obter, cancelar e listar registros de registro de inscritos em um webinar. Fornece a URL de ingresso exclusiva do webinar do Teams para o registrante registrado.
  • virtualEventRegistrationQuestion – Usado para criar, listar e excluir perguntas de registro personalizadas ou perguntas de registro predefinidas para os inscritos responderem quando se registrarem em um webinar.
  • virtualEventRegistrationConfiguration – Contém informações sobre uma configuração de registro de webinar que armazena a URL do portal de registro do webinar.
  • virtualEventPresenter – usado para criar, obter, listar, atualizar e excluir um apresentador para um webinar do Teams.
  • virtualEventSession – um webinar criado por meio de APIs do Microsoft Graph tem apenas uma sessão que herda as propriedades de reuniões online.
  • meetingAttendanceReport – Sempre que um webinar termina, um relatório de presença é gerado para a sessão, mas não inclui os dados dos participantes.
  • attendanceRecord – fornece dados do participante do webinar no relatório de presença.
  • Webhooks de eventos virtuais – Pode receber notificações de alterações em um webinar, registro de webinar, sessão, relatório de presença e assim por diante.

Soluções que você pode criar

A tabela a seguir lista algumas soluções que você pode criar usando o cliente do Teams e as APIs e webhooks do webinar do Microsoft Graph.

Soluções Descrição
Criar/atualizar/cancelar Criar, atualizar e cancelar programaticamente webinars do Teams.
Sincronização de dados Extrair dados do webinar do Teams em um aplicativo personalizado (como participantes, perguntas de registro, relatório de presença e muito mais).
Registro Hospede sua própria experiência no portal de registro para um webinar do Teams e sincronize os dados de registro com o cliente do Teams.
Comunicação por Email Use sua própria infraestrutura de email para enviar emails de notificação relacionados a webinars.

Observação

Para criar qualquer solução do Microsoft Graph, você precisa se registrar e conceder as permissões corretas ao seu aplicativo. Para obter mais informações, consulte Noções básicas de autenticação e autorização.

O RSC (consentimento específico do recurso) permite que os aplicativos solicitem permissões com escopo para um webinar ou reunião geral específico, em vez de exigir privilégios de administrador global. As permissões RSC melhoram a segurança, simplificam os fluxos de consentimento e permitem que os desenvolvedores criem integrações que respeitem os limites organizacionais.

APIs de eventos virtuais do Microsoft Graph habilitadas e permissões RSC

Permissão RSC APIs Descrição
VirtualEvent.Read. Chat Webinar e reunião geral Leia as informações para este webinar ou reunião geral, incluindo horários, palestrantes, configurações de eventos e registros de webinar.
OnlineMeetingArtifact.Read. Chat Relatório de presença e registo de presença Leia os relatórios de presença e os registros de presença deste webinar ou da reunião geral.
VirtualEventRegistration-Anon.ReadWrite. Chat Registros de eventos virtuais Registre os participantes e cancele as inscrições para este webinar ou reunião geral.

Fluxo de autenticação tradicional

Se o RSC não for necessário ou viável, você poderá usar os seguintes fluxos OAuth tradicionais:

  • Fluxo de token somente aplicativo: use-o para serviços de back-end ou cenários de automação em que o aplicativo atua sem contexto do usuário.
  • Fluxo de token delegado (usuário): use quando as ações exigirem contexto e consentimento do usuário.

Quando usar RSC versus fluxo de token tradicional

Cenário Abordagem recomendada
O aplicativo precisa apenas de acesso a um webinar ou reunião geral específico RSC
O aplicativo requer acesso em todo o locatário a vários eventos Fluxo de token somente aplicativo
Ações orientadas pelo usuário, como organizador gerenciando eventos Fluxo de token delegado
Mandatos de conformidade ou de segurança exigem privilégios mínimos RSC

Introdução ao uso das permissões RSC

As etapas a seguir descrevem como começar a configurar seu aplicativo e usar as permissões RSC:

  1. Registre seu aplicativo e defina as permissões RSC no manifesto do aplicativo.
  2. Publique seu aplicativo por meio do portal do desenvolvedor do Teams ou do Partner Center.
  3. Administração concede RSC no centro de administração do Teams.
  4. Use as APIs do Microsoft Graph para webinars e reuniões gerais com permissões de escopo.

Criar/atualizar/cancelar

  • Use a API Criar webinar para criar um rascunho do evento, seguida pela API Publicar webinar para concluir a criação e torná-la visível para o público.
    • O webinar criado por meio das APIs do Microsoft Graph é um webinar do Teams visível e editável no cliente do Teams.
    • Assim como no Teams, somente o organizador pode criar, publicar e cancelar eventos de webinar. A API de criação de webinar só dá suporte a permissões delegadas em nome do organizador.
  • Assim como no Teams, os coorganizadores podem atualizar os webinars. Para atualizar webinars, use a API atualizar webinar com permissões delegadas em nome do coorganizador.
  • Assine as notificações de alteração para obter atualizações sobre quaisquer alterações feitas no webinar. 

Sincronização de dados

Registro

  • Use Criar registro para registrar programaticamente os usuários em seu webinar. Organizadores, coorganizadores e apresentadores não precisam se registrar. O fato de os registrantes terem ou não contas do Microsoft Entra afeta as permissões necessárias para chamar a API.
  • CRIAR perguntas de registro (predefinidas ou personalizadas) Os participantes devem responder às perguntas necessárias durante o registro.
  • Depois que o registrante se registrar no webinar, use Sessões de lista para obter o exclusivo joinWebURL para o webinar.

Comunicação por Email

  • Você pode desativar as comunicações por email com os participantes ao criar a webinar. Na propriedade settings , defina isAttendeeEmailNotificationEnabled como false. Os emails ainda são enviados para organizadores, coorganizadores e apresentadores (internos e externos).
  • Você pode se inscrever para receber notificações de alteração para criar seu próprio sistema de comunicação por email personalizado.