Basics · Functions

Edit this page on GitHub

Features

Estas son las funciones más importantes que debes aprender a la hora de crear flujos o interacciones dinámicas con el bot

Add keyword

addKeyword es el punto de partida de un flujo de conversación, solo necesita pasar una matriz de palabras clave, cuando alguien envía un mensaje de texto con esas palabras clave en el chatbot, la función activará el cuadro de diálogo predefinido que ha configurado.

En el siguiente ejemplo se establece un flujo de conversación que recibió las palabras clave 'hola ' y'hola', luego, el chatbot enviará un mensaje usando addAnswer con el texto 'Hola, bienvenido a mi increíble tienda, ¿en qué puedo ayudarte?' y 'La tienda ofrece: zapatos, camisas, pantalones y sombreros'.

La función agregar palabras clave también tiene una serie de propiedades que lo ayudarán a resolver diferentes casos de uso. Algunas de estas funciones son: regex, sensitive

  import { addKeyword } from '@builderbot/bot';

  const mainFlow = addKeyword(['hello', 'hi'])
      .addAnswer(['Hi, welcome to my amazing shop', 'how can I help you?'])
      .addAnswer(['The shop has: ', 'shoes, shirts, pants, and hats'])
Diagram

El flujo de conversación puede limitarse a un keyword, en el ejemplo, la palabra 'comprar' para activar el siguiente cuadro de diálogo

  import { addKeyword } from '@builderbot/bot';

  const mainFlow = addKeyword('buy')
      .addAnswer(['Great! ', 'What do you want to buy?'])

addKeyword

Regex

El chatbot admite la validación de expresiones regulares, en el siguiente ejemplo se pasa un objeto como segundo parámetro a la función addKeyword, el objeto tiene una propiedad regex establecida en true y la propiedad keywords es un patrón de expresiones regulares.

  import { addKeyword } from '@builderbot/bot';

  const REGEX_GMAIL_EMAIL = /(\w+)@gmail\.com/g;

  const mainFlow = addKeyword(REGEX_GMAIL_EMAIL, 
      { regex: true })
      .addAnswer(`Thanks for the gmail address`)
addKeyword

Sensitive

El chatbot detecta una palabra clave específica en cualquier parte de un mensaje, pero al pasar la propiedad sensitive como true, el chatbot activará el cuadro de diálogo si el usuario escribe exactamente la misma keyword

  import { addKeyword } from '@builderbot/bot';

  const mainFlow = addKeyword('buy', { sensitive: true })
      .addAnswer(['Great! ', 'What do you want to buy?'])

Add answer

addAnswer se utiliza para enviar un mensaje al usuario, puede ser un simple texto o un archivo adjunto. En el siguiente ejemplo se establece un flujo de conversación que recibió la palabra clave'hola', luego, el chatbot enviará un mensaje usando 'addAnswer' con el texto ' Hola, bienvenido a mi increíble tienda, ¿en qué puedo ayudarte?'

  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer('Hi, welcome to my amazing shop, how can I help you?')

Hay diferentes configuraciones para enviar mensajes, algunas funciones como enviar archivos, imágenes, video, retrasos, saltos de línea: line breaks, consecutive, delay , callback


addAnswer

Consecutive Messages

El chatbot puede enviar varios mensajes simplemente agregando la función addAnswer uno tras otro. En el siguiente ejemplo, el chatbot enviará (3) mensajes: Hi, Welcome to my amazing shop, how can I help you? in that order.

  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer('Hi')
      .addAnswer('Welcome to my amazing shop')
      .addAnswer('how can I help you?')
addAnswer

Message with line breaks

Siempre que necesite enviar un mensaje con saltos de línea, puede usar una matriz de cadenas como puede ver en el siguiente ejemplo.

  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer([
        'Hi', 'Welcome to my amazing shop', 
        'how can I help you?'
      ])
addAnswer

Message with delay

El chatbot puede enviar un mensaje con un delay, simplemente agregue la función addAnswer con la propiedad delay establecida en la cantidad de milisegundos que desea esperar antes de enviar el mensaje.

import { addKeyword, addAnswer } from '@builderbot/bot';

const mainFlow = addKeyword('hello')
  .addAnswer('This message will after 2 seconds',
    { delay: 2000 }
  )

Message with callback

Cuando se usan funciones de devolución de llamada en addAnswers, la operación prioriza el envío del mensaje y luego la ejecución de la función.

  import { addKeyword, addAnswer } from '@builderbot/bot';

  const mainFlow = addKeyword('hello')
      .addAnswer('Hi!, Do you know 4+4?', null, async (_, {flowDynamic}) => {
          const sum = 4 + 4
          await flowDynamic(`Total: ${sum}`)
      })
      .addAction(async (_, {flowDynamic}) => {
          await flowDynamic(`Other message`)
      })
Diagram

Add Action

addAction se usa para definir acciones específicas como respuesta cuando se ha recibido un mensaje de whatsapp, esta función permite activar flujos de conversación en función de la entrada del usuario y definir cómo debe actuar el chatbot.

En el siguiente ejemplo puedes ver cómo puedes activar una función cuando el usuario envía un mensaje con la palabra clave 'comprar'.

  import { addKeyword, addAction } from '@builderbot/bot';

  const mainFlow = addKeyword('buy')
      .addAnswer('Great! What do you want to buy?')
      .addAction(async (_, { flowDynamic }): void => {
          return console.log('The user wants to buy something');
      })

Puede usar la función addAction con capture como puede ver en el siguiente ejemplo

  import { addKeyword, addAction } from '@builderbot/bot';

  const mainFlow = addKeyword(['Hello', 'Hi'])
      .addAction(async (_, { flowDynamic }): void => {
          return flowDynamic('Hi! how can I help you?');
      })
      .addAction({ capture: true }, async (ctx, { flowDynamic, state }): void => {
          await state.udpate({ name: ctx.body})
          return console.flowDynamic(`The user said: ${ctx.body}`);
      })

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.