Usando o Webhook Chatbot de entrada do Zoom

É possível enviar mensagens diretamente de qualquer canal de chat do Zoom para um serviço externo, como Amazon CloudWatch, usando o aplicativo Incoming Webhook. Com o aplicativo de bate-papo, você pode gerar um endpoint exclusivo, juntamente com um token de verificação, em qualquer canal de sua escolha. Essa credencial permitirá que você envie mensagens por meio de solicitações HTTP POST para um canal de bate-papo do Zoom com essas credenciais.

Pré-requisitos para Webhook de entrada

  • Propriedade ou privilégios administrativos de uma conta

  • Tipo de conta: Professional, Business, Educational ou Enterprise

  • A capacidade de enviar solicitações HTTP POST usando um token e um endpoint familiarizado com HTTP POST

  • O Zoom App Marketplace pré-aprovou o chatbot Incoming Webhook para inclusão em seu Marketplace
    Observação: Você precisará entrar em contato com o administrador do Zoom se o aplicativo não tiver sido pré-aprovado.

Como adicionar e configurar Webhook de entrada

Adicionar do Zoom App Marketplace

Observação: O Incoming Webhook Chatbot precisa ser adicionado e configurado em sua conta Zoom se você não tiver privilégios administrativos

  1. Verifique se você está conectado como administrador da sua conta Zoom no Zoom App Marketplace.

  2. O aplicativo Incoming Webhook pode ser encontrado na caixa de pesquisa no canto superior direito da tela. Basta digitar o nome do aplicativo na caixa.

  3. Você encontrará o aplicativo Incoming Webhook nos resultados da pesquisa. Clique no aplicativo para abri-lo.
    Observação: Recomenda-se que você entre em contato com o administrador do Zoom se o aplicativo não for pré-aprovado em sua conta para aprová-lo.

  4. Clique no botão Adicionar.

  5. Depois de confirmar que o aplicativo requer as permissões desejadas, clique em Autorizar.
    Agora adicionei um aplicativo para webhooks de entrada à loja.

Configurar o Webhook de entrada Chatbot

  1. O cliente de desktop do Zoom pode ser acessado fazendo login.

  2. Você encontrará a guia Bate-papo no lado esquerdo da tela.

  3. Você pode encontrar Webhooks de entrada na seção BOTS.
    Além disso, se você quiser receber mensagens em um canal de bate-papo específico, acesse esse canal.

  4. Para conectar -se à conexão, digite /incm conectar ConnectionName>.
    Como resultado desta ação, você será conectado e receberá uma mensagem de chat 1:1 contendo os seguintes detalhes:

    • Ponto final

    • Token de verificação

    • Exemplo ondulação solicitações de.

  5. Usando essas informações, você pode enviar uma solicitação POST ao servidor.
    Observação: para que o chatbot do Webhook de entrada envie mensagens para qualquer canal que você escolher, siga estas etapas para cada canal escolhido.

Como enviar mensagens para o chat do Zoom

Para poder enviar solicitações POST para o endpoint da integração depois de criar sua conexão, você deve primeiro criar sua conexão. O cabeçalho de autorização deve incluir o token de verificação, se você o tiver configurado para incluí-lo.
Observação: uma solicitação POST é o único tipo de solicitação aceita pelo endpoint.

Recomenda-se executar um git-bash (ou equivalente que seja capaz de executar comandos cURL) para testar sua conexão no terminal. O chatbot webhook de entrada enviará a você o Solicitação cURL com base no exemplo cURL na mensagem de bate-papo 1:1 inicial. Você pode copiar o cURL de exemplo e colá-lo em sua solicitação cURL. No canal especificado, você deve ver uma mensagem de teste sendo enviada depois de enviá-la. Uma resposta HTTP 200 OK indica que o teste foi bem-sucedido.

O tipo de mensagem e a complexidade da mensagem podem ser definidos no Incoming Webhook Chatbot escolhendo uma das quatro opções abaixo:

  • Formato simples:é eué importantent saber que este formato permite que você envie texto simples vindo de uma conexão que foi criada. O endpoint pode ser usado sem nenhum parâmetro se você quiser usar esta formatação. O corpo da sua mensagem deve conter uma string que contém o conteúdo que você deseja enviar.

POST <endpoint>
Authorization: <verificationToken>
Body: "This is a test message."
  • Campos formatar: O formato de campo deste formato permite uma formatação simples a ser inserida nos campos. Sua mensagem pode, por exemplo, ser formatada em uma lista de campos que você pode preencher. É necessário adicionar campos como formato no parâmetro de consulta (?format=fields) para que esta formatação funcione.

POST <endpoint>?format=fields
Authorization: <verificationToken>
Content-Type: application/json
Body:
{
    "Field 1": "bar",
    "Field 2": "qux"
}
  • Formato de lista: usando este formato, você pode enviar uma lista de itens formatada simples. Uma lista pode ser usada para formatar sua mensagem, por exemplo, se você quiser que ela apareça nesse formato. Para usar esta formatação, o parâmetro de consulta deve ser definido como lista (?format=lista) para usar este formato.

POST <endpoint>?format=list
Authorization: <verificationToken>
Content-Type: application/json
Body:
{
    "Item 1": "Item 1",
    "Item 2": "Item 2"
}
  • Formato completo: com a ajuda deste formato, a formatação avançada de mensagens também pode ser gerada e enviada nas mensagens do Zoom Chat. O uso dessa formatação permite que você construa suas mensagens de chatbot de várias maneiras, como usar cabeçalhos e subtítulos, link, botão, menu suspenso, anexo e muito mais. Como forma de aproveitar esta formatação, adicione o parâmetro ?format=full ao parâmetro de consulta para que full seja o formato. Para saber mais sobre os objetos JSON compatíveis, consulte o documento a seguir.

Como usar o Incoming Webhook Chatbot

Comandos disponíveis

  • Conectar: Para ganhar tokens e criar uma conexão, você precisará digitar /incm conectar ConnectionName> como a primeira etapa. O token será então usado para enviar mensagens diretamente para o seu canal de chat atual. Existem mensagens diretas 1:1 e canais que podem ser usados ​​por este Chatbot.

  • regenerar parasabe: Para obter informações adicionais, certifique-se de saber o nome da conexão que será usada para gerar o token de verificação.

  • desconectarObservação: ao usar a opção de desconexão /inc, você deseja remover todas as conexões associadas ao nome especificado.

  • Desconectar tudo: O Incoming Webhook Chatbot pode ser removido usando o comando /inc desconectar tudo para remover todas as conexões.

  • configurar: Para obter uma lista de conexões para o canal de bate-papo atual, digite /inc configure no terminal.

  • Configurar tudo: Para obter uma lista de todas as conexões para cada canal, digite /inc configure all.

Como remover o Incoming Webhook Chatbot

  1. Verifique se você está conectado como administrador da sua conta Zoom no Zoom App Marketplace.

  2. Para gerenciar sua conta, clique no botão Gerenciar no canto superior direito da tela.

  3. Selecione a opção Adicionar aplicativos no menu de navegação na parte superior da página.

  4. Se você clicar em Remover à direita do aplicativo Incoming WebHook, o aplicativo será removido.

  5. Clique no botão Remover depois de confirmar a diálogo.
    Observação: Como parte desta etapa, todas as conexões ativas em O Zoom Chat também será removido.

O suporte do Zoom pode fornecer assistência adicional se você precisar.

See also  Enviando uma mensagem para todo o evento em eventos de zoom

Similar Posts