Uso del chatbot de webhook entrante de Zoom

Es posible enviar mensajes directamente desde cualquier canal de chat de Zoom a un servicio externo, como Amazon CloudWatch, utilizando la aplicación Incoming Webhook. Con la aplicación de chat, puede generar un punto final que será único, junto con un token de verificación, en cualquier canal que elija. Esta credencial le permitirá enviar mensajes a través de solicitudes HTTP POST a un canal de chat de Zoom con estas credenciales.

Requisitos previos para el webhook entrante

• Propiedad o privilegios administrativos para una cuenta

• Tipo de cuenta: profesional, comercial, educativa o empresarial

• La capacidad de enviar solicitudes HTTP POST utilizando un token y un punto final que esté familiarizado con HTTP POST

• Zoom App Marketplace ha aprobado previamente el chatbot Webhook entrante para su inclusión en su Marketplace
  Nota: deberá ponerse en contacto con su administrador de Zoom si la aplicación no ha sido preaprobada.

Cómo agregar y configurar Webhook entrante

Agregar desde el mercado de aplicaciones de Zoom

Nota: El chatbot Webhook entrante debe agregarse y configurarse en su cuenta de Zoom si no tiene privilegios administrativos

1. Asegúrese de haber iniciado sesión como administrador de su cuenta de Zoom en Zoom App Marketplace.

2. La aplicación Incoming Webhook se puede encontrar en el cuadro de búsqueda en la parte superior derecha de la pantalla. Simplemente ingrese el nombre de la aplicación en el cuadro.

3. Encontrará la aplicación Incoming Webhook en sus resultados de búsqueda. Haga clic en la aplicación para abrirla.
   Nota: Se recomienda que se comunique con su administrador de Zoom si la aplicación no está preaprobada en su cuenta para que la apruebe.

4. Haga clic en el botón Agregar.

5. Cuando haya confirmado que la aplicación requiere los permisos que desea, haga clic en Autorizar.
   Ahora he agregado una aplicación para webhooks entrantes a la tienda.

Configurar el chatbot de webhook entrante

1. Se puede acceder al cliente de escritorio de Zoom iniciando sesión.

2. Encontrará la pestaña Chat en el lado izquierdo de la pantalla.

3. Puede encontrar webhooks entrantes en la sección BOTS.
   Además, si desea recibir mensajes en un canal de chat específico, puede ir a ese canal.

4. Para conectarse a la conexión, escriba /Inc Connect ConnectionName>.
   Como resultado de esta acción, se le conectará y recibirá un mensaje de chat 1:1 que contiene los siguientes detalles:

   • punto final

   • token de verificación

   • Ejemplo rizo peticiones.

5. Con esta información, puede enviar una solicitud POST al servidor.
   Nota: Para que el chatbot Webhook entrante envíe mensajes a cualquier canal que elija, debe seguir estos pasos para cada canal que elija.

Cómo enviar mensajes al chat de Zoom

Para que pueda enviar solicitudes POST al extremo de la integración una vez que haya creado su conexión, primero debe crear su conexión. El encabezado de autorización debe incluir el token de verificación, si lo ha configurado para incluirlo.
Nota: Una solicitud POST es el único tipo de solicitud que acepta el punto final.

Se recomienda ejecutar un git-bash (o un equivalente que pueda ejecutar comandos cURL) para probar su conexión en la terminal. El chatbot de webhook entrante le enviará el Solicitud de cURL basada en el cURL de ejemplo en el mensaje de chat 1:1 inicial. Puede copiar el cURL de ejemplo y pegarlo en su solicitud de cURL. En el canal especificado, debería ver que se envía un mensaje de prueba una vez que lo haya enviado. Una respuesta HTTP 200 OK indica que la prueba se ha realizado correctamente.

El tipo de mensaje y la complejidad del mensaje se pueden configurar en el Webhook Chatbot entrante eligiendo entre las cuatro opciones a continuación:

• formato sencillo: yoes importanteNo sepa que este formato le permite enviar texto sin formato proveniente de una conexión que se ha creado. El punto final se puede usar sin ningún parámetro si desea usar este formato. El cuerpo de su mensaje debe contener una cadena que contenga el contenido que desea enviar.

POST <endpoint>
Authorization: <verificationToken>
Body: "This is a test message."

• Campos formato: El formato de campo de este formato permite que se ingrese un formato simple en los campos. Su mensaje puede, por ejemplo, formatearse en una lista de campos que puede completar. Es necesario agregar campos como formato en el parámetro de consulta (?formato=campos) para que este formato funcione.

POST <endpoint>?format=fields
Authorization: <verificationToken>
Content-Type: application/json
Body:
{
    "Field 1": "bar",
    "Field 2": "qux"
}

• Formato de lista: con este formato, puede enviar una lista de elementos con formato simple. Se puede usar una lista para dar formato a su mensaje, por ejemplo, si desea que aparezca en este formato. Para usar este formato, el parámetro de consulta debe establecerse en list (?format=list) 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: Con la ayuda de este formato, también se puede generar y enviar un formato de mensaje enriquecido dentro de los mensajes de Zoom Chat. El uso de dicho formato le permite construir sus mensajes de chatbot de varias maneras, como el uso de encabezados y subencabezados, enlaces, botones, menús desplegables, archivos adjuntos y más. Como una forma de hacer uso de este formato, agregue el parámetro ?format=full al parámetro de consulta para que full sea el formato. Para obtener más información sobre los objetos JSON compatibles, consulte el siguiente documento.

Cómo utilizar el chatbot Webhook entrante

Comandos disponibles

• Conectar: Para ganar tokens y crear una conexión, deberá escribir /Inc Connect ConnectionName> como el primer paso. Luego, el token se usará para enviar mensajes directamente a su canal de chat actual. Hay mensajes directos 1:1 y canales que puede usar este Chatbot.

• regenerar aconocido: para obtener información adicional, asegúrese de conocer el nombre de la conexión que se utilizará para generar el token de verificación.

• Desconectar: cuando utiliza la opción de desconexión /inc, desea eliminar todas las conexiones asociadas con el nombre especificado.

• Desconectar todo: El Chatbot Webhook entrante se puede eliminar con el comando /inc desconectar todo para eliminar todas las conexiones.

• Configurar: Para obtener una lista de conexiones para el canal de chat actual, escriba /inc configure en la terminal.

• Configurar todo: Para obtener una lista de todas las conexiones para cada canal, escriba /inc configure all.

Cómo eliminar el Webhook Chatbot entrante

1. Asegúrese de haber iniciado sesión como administrador de su cuenta de Zoom en Zoom App Marketplace.

2. Para administrar su cuenta, haga clic en el botón Administrar en la esquina superior derecha de su pantalla.

3. Seleccione la opción Agregar aplicaciones en el menú de navegación en la parte superior de la página.

4. Si hace clic en Eliminar a la derecha de la aplicación WebHook entrante, la aplicación se eliminará.

5. Haga clic en el botón Eliminar después de haber confirmado la diálogo.
   Nota: Como parte de este paso, todas las conexiones activas en Zoom Chat también se eliminará.

Zoom Support puede brindarle asistencia adicional si la necesita.