Este guia explica como a API REST do Google Meet permite criar e gerenciar reuniões do Google Meet.
Um espaço para reuniões representa um lugar virtual ou um objeto persistente (como uma sala de reunião) onde as conferências são realizadas. Só é possível realizar uma videoconferência ativa em um espaço por vez. Um espaço para reuniões também ajuda os usuários a se encontrar e encontrar recursos compartilhados.
Para trabalhar com espaços de reunião, consulte Gerenciar espaços de reunião. Para saber como configurar um espaço para reuniões de forma programática, consulte Configurar as definições do espaço para reuniões. Para gerenciar participantes do espaço para reuniões, consulte Gerenciar participantes do espaço para reuniões.
Como chamar os métodos do espaço para reuniões
A tabela de comparação a seguir detalha as funções necessárias para usar os métodos do espaço para reuniões:
| Método | Proprietários | Participantes | Outros |
|---|---|---|---|
endActiveConference |
|||
get |
|||
| com configurações | |||
| com uma conferência ativa | |||
patch |
Como o Meet identifica um espaço para reuniões
A API REST do Meet gera um recurso spaces para cada espaço para reuniões. O recurso spaces oferece vários pontos de entrada para participar de uma
conferência.
A tabela a seguir mostra como identificar e entrar em um espaço para reuniões:
| Nome do campo | Descrição |
|---|---|
name |
O nome do espaço. A string {space} é o identificador de recurso do espaço e é formatada como spaces/{space}.
É um ID exclusivo gerado pelo servidor e diferencia maiúsculas de minúsculas. Por exemplo,
spaces/jQCFfuBOdN5z. |
meetingCode |
O alias do nome do espaço. O {meetingCode} é uma string de caracteres exclusiva e digitável que não diferencia maiúsculas de minúsculas. Ele é formatado como
spaces/{meetingCode}. Por exemplo,
spaces/abc-mnop-xyz. O tamanho máximo é de 128 caracteres.
Ele faz parte do meetingUri:
https://meet.google.com/abc-mnop-xyz. |
phoneAccess |
Os métodos de acesso por telefone para este espaço para reuniões. O objeto
phoneAccess contém as informações necessárias para discar
para uma conferência, incluindo os números de telefone regionais do espaço
de reunião e um código PIN específico para esse número de telefone. O PIN consiste apenas em dígitos decimais e o comprimento pode variar. Por exemplo,
"pin": 19707127300. Assim como na interface do Meet, o recurso spaces
inclui um conjunto limitado de números de discagem. Para conferir outros números de telefone de um espaço para reuniões, adicione {meetingCode} ao seguinte URL: https://meet.google.com/tel/. Por
exemplo, https://meet.google.com/tel/abc-mnop-xyz.
|
gatewaySipAccess |
Os métodos de acesso ao protocolo de início de sessão (SIP) para este espaço de reunião. Um endereço SIP detalha como o hardware de videoconferência de terceiros
pode encontrar e participar de uma conferência do Meet. O
objeto gatewaySipAccess contém um URI e um código
de acesso numérico. O Meet é compatível com o esquema de URI SIP.
|
Para gerenciar um espaço para reuniões, use os seguintes valores para o campo
name:
Para ver detalhes sobre um espaço para reuniões, use
spaces/{space}ou o aliasspaces/{meetingCode}. Para mais informações, consulte Reservar um espaço de reunião.Para atualizar os detalhes de um espaço para reuniões, use apenas
spaces/{space}. Para mais informações, consulte Atualizar um espaço de reunião.Para encerrar uma videoconferência ativa em um espaço para reuniões, use apenas
spaces/{space}. Para mais informações, consulte Encerrar uma conferência ativa.Para gerenciar os membros de um espaço para reuniões, use apenas o
spaces/{space}. O alias{meetingCode}não é compatível. Para mais informações, consulte Gerenciar membros do espaço para reuniões.
Escopos do OAuth por caso de uso
O guia Autenticar com o Meet lista todos os escopos da API REST do Meet e os níveis de sensibilidade de verificação deles. No entanto, ao trabalhar com espaços de reunião, os requisitos de escopo variam dependendo se um espaço foi criado pelo seu app ou por um app externo, como o Google Agenda.
A tabela a seguir descreve os escopos OAuth necessários com base no caso de uso específico do espaço para reuniões:
| Caso de uso | Código do escopo |
|---|---|
| Defina a geração automática de artefatos para espaços criados por outros apps. | https://www.googleapis.com/auth/meetings.space.settings |
| Receba ou liste materiais de conferências criadas por outros apps. | https://www.googleapis.com/auth/meetings.space.readonly |
| Receba ou liste outras configurações de pré-reunião de um espaço para reuniões criado por um app de terceiros. | https://www.googleapis.com/auth/meetings.space.createdhttps://www.googleapis.com/auth/meetings.space.readonly |
| Ler e editar as configurações de todos os espaços de reunião a que um usuário pode acessar por qualquer outro app, como o Google Agenda. | https://www.googleapis.com/auth/meetings.space.settings |
Para uma lista completa de todos os escopos compatíveis e os níveis de sensibilidade de autorização, consulte Conheça os escopos da API REST.
Ciclo de vida de um espaço para reuniões
Um espaço para reuniões passa por vários estados durante o ciclo de vida. O diagrama a seguir mostra as etapas gerais do ciclo de vida de um espaço para reuniões:
Ligue para
spaces.create. O espaço para reuniões é criado, e o objetospacesretornado contém a stringmeetingUri. Em seguida, omeetingUrié distribuído aos participantes. Antes do início da conferência, você pode configurar as opções do espaço para reuniões e gerenciar os membros do espaço para reuniões.Sondar o novo espaço para reuniões. Chame o método
spaces.getpara verificar o estado da conferência.Em vez de fazer pesquisas, você também pode se inscrever nos eventos do Meet para receber notificações push.
Inicie a conferência. Quando o primeiro participante clica em
meetingUridentro do espaço para reuniões, uma conferência é iniciada. O objetoactiveConferenceé preenchido e a stringactiveConference.conferenceRecordé definida.(Opcional) Receber dados da conferência. Durante uma conferência ativa, é possível acessar alguns valores de
conferenceRecord. Por exemplo, chame o métodoconferenceRecords.participants.listpara ver todos os participantes da conferência. Você também pode acessar essas informações por até 30 dias após a conferência.(Opcional) Encerre a conferência. Durante a conferência, o proprietário da reunião pode chamar o método
spaces.endActiveConferencepara encerrar programaticamente uma conferência ativa para todos os participantes.A conferência termina. Quando o último participante sai, a conferência termina.
Pesquise artefatos pós-conferência. A conferência terminou (
STATE=ENDED), mas os artefatos ainda não foram gerados. OsstartTimeeendTimeda conferência também são preenchidos. Você precisa consultar o endpoint de artefato até que o objeto de artefatoSTATEleiaFILE_GENERATED.Em vez de fazer consultas, você pode se inscrever em eventos do Meet para receber notificações push.
Receber artefatos pós-conferência. É possível recuperar artefatos como gravações e transcrições depois que eles são gerados. Por exemplo, chame o método
conferenceRecords.recordings.getpara receber uma gravação pelo ID dela.Quando estiver pronto, um URI para o objeto de artefato será preenchido e retornado como parte do objeto de recurso.
Temas relacionados
- Gerenciar espaços de reunião
- Configurar as opções de espaço para reuniões
- Gerenciar membros do espaço para reuniões
- Participar de uma reunião
- Países onde você pode usar um número de telefone no Meet