Basics · Events

Edit this page on GitHub

Events

En ocasiones los usuarios envían mensajes como una imagen, un video o mensajes de ubicación especial, entre otros, para recibir e iniciar una conversación cuando llega un mensaje de este tipo podemos utilizar los eventos.

Diagram

WELCOME

Default

Cuando un usuario envía un mensaje de "texto" que no existe en una palabra clave en otro flujo, el WELCOME el evento se activará de forma predeterminada, que es el evento predeterminado.

Imaginemos el caso en el que una persona escribe la palabra ¡Gracias!

  import { addKeyword, EVENTS } from '@builderbot/bot'
  
  const welcomeFlow = addKeyword(EVENTS.WELCOME).addAnswer('Ey welcome?')
  const greetingFlow = addKeyword(['hello','hi']).addAnswer('Hi!')
Diagram
Diagram

Podemos ver en el diagrama anterior que el bot realiza una búsqueda en todos los flujos para obtener el mejor flujo que pueda responder a la palabra clave "Thank You" pero como no encuentra, se activa la "WELCOME".


MEDIA

Received Image or Video

Cuando un usuario envía una imagen o un video, el evento MEDIA, que es el evento predeterminado, se activará de forma predeterminada. Esto es ideal para cuando necesitamos que envíen información y necesitamos almacenarla.

  import { addKeyword, EVENTS } from '@builderbot/bot'
  
  const mediaFlow = addKeyword(EVENTS.MEDIA).addAnswer('I received a media image/video')

Para guardar el archivo multimedia, debe invocar la función saveFile del proveedor que está utilizando.

  import { addKeyword, EVENTS } from '@builderbot/bot'
  import { BaileysProvider } from '@builderbot/provider-baileys'

  const mediaFlow = addKeyword<BaileysProvider>(EVENTS.MEDIA)
  .addAnswer('I received a media image/video', async (ctx, { provider }) => {
    const localPath = await provider.saveFile(ctx, {path:'...'})
    //console.log(localPath)
  })

DOCUMENT

Received Document

Cuando un usuario envía un documento, el evento del DOCUMENT se activará de forma predeterminada, que es el evento predeterminado.

  import { addKeyword, EVENTS } from '@builderbot/bot'
  
  const documentFlow = addKeyword(EVENTS.DOCUMENT)
  .addAnswer("Wow! I'm sorry I can't read this document right now", async (ctx, { provider }) => {
    const localPath = await provider.saveFile(ctx, {path:'...'})
    //console.log(localPath)
  })

LOCATION

Received Location

LOCATION debe enviarse a través de WhatsApp, aún no permite enlaces de ubicación desde aplicaciones externas

Cuando su chatbot necesita acceder a la ubicación de un usuario, es importante asegurarse de que la ubicación se envíe directamente desde la aplicación WhatsApp para obtener resultados. Una vez recibida la ubicación, puede realizar un registro de consola de ctx para ver los detalles de la ubicación recibida.

El contexto de ubicación recibido se verá así en la consola:

ctx:  {
  ...
  message: Message {
    locationMessage: LocationMessage {
      degreesLatitude: -2.1462137699127197,
      degreesLongitude: -79.88981628417969,
      name: 'Doctor Miguel Angel Jijón Teran',
      address: 'Doctor Miguel Angel Jijón Teran, Guayaquil, Ecuador',
    },
  },
  body: '_event_location__0d5c9f57-0909-44a1-995f-902f9df3b21f',
  name: 'yeyodev 👨🏾‍💻',
  from: '593000000000'
}

Esto generará la latitud y longitud del usuario en la consola, lo que le permitirá utilizar de manera efectiva los datos de ubicación para la funcionalidad de su chatbot.

Para acceder a los datos de ubicación, puede utilizar el siguiente enfoque:

import { EVENTS, addKeyword } from "@builderbot/bot";

export default addKeyword(EVENTS.LOCATION)
.addAnswer("I have received your location!", null, async (ctx) => {
  const userLatitude = ctx.message.locationMessage.degreesLatitude;
  const userLongitude = ctx.message.locationMessage.degreesLongitude;
})

VOICE_NOTE

Received Voice Note

Cuando un usuario envía una nota de voz, el evento VOICE_NOTE se activará de forma predeterminada, que es el evento previsto para este comportamiento, es importante comprender que una nota de voz es diferente de un archivo de imagen o video.

  import { addKeyword, EVENTS } from '@builderbot/bot'
  
  const voiceNoteFlow = addKeyword(EVENTS.VOICE_NOTE)
  .addAnswer('Give me a second to hear you!', async (ctx, { provider }) => {
    const localPath = await provider.saveFile(ctx, {path:'...'})
    //console.log(localPath)
  })
  

Guides

My first chatbot

Learn how build your first chatbot in few minutes

Read more

Concepts

Understand the essential concepts for building bots

Read more

Add Functions

The key to learning how to write flows is add-functions.

Read more

Plugins

Unlimitate and start implementing the community plugins.

Read more

Resources

Modularize

Learn how to modularise flows so that you can have a more maintainable bot.

Send Message

How to send a message via HTTP to start conversations, you can send multimedia as well.

Dockerizer

A good practice is to dockerise your bots to make them more maintainable and effective.

Events

Learning about events will make us more fluent when creating chatbots.