How to implement a REST API?
En muchas ocasiones necesitamos enviar un mensaje a través de una solicitud HTTP es muy útil para enviar recordatorios o confirmaciones de pedidos. En este caso, cada proveedor implementa una función 'handleCtx' que le permite inyectar la instanciación del bot y acceder a sus funciones desde un controlador.
Es importante utilizar esta función bajo su propia responsabilidad, ya que el uso abusivo puede considerarse spam y su número puede ser bloqueado.
Send Single Message
Request
curl https://api.example.chat/v1/messages \
-d number="34000000" \
-d message="Hello!"En el ejercicio a continuación puede obtener un ejemplo de cómo funciona. Es interesante entender que internamente la biblioteca ya implementa una versión muy ligera de HTTP similar a express pero llamada polka.
app.ts
import 'dotenv/config'
import { createBot, MemoryDB, createProvider } from '@builderbot/bot'
import { BaileysProvider } from '@builderbot/provider-baileys'
import flow from './flows';
const PORT = process.env.PORT ?? 3001
const main = async () => {
const provider = createProvider(BaileysProvider)
const { handleCtx, httpServer } = await createBot({
database: new MemoryDB(),
provider,
flow,
})
httpServer(+PORT)
provider.server.post('/v1/messages', handleCtx(async (bot, req, res) => {
const { number, message } = req.body
await bot.sendMessage(number, message, {})
return res.end('send')
}))
}
main()Send with Media
Request
curl https://api.example.chat/v1/messages \
-d number="34000000" \
-d message="Ey! send media"En el siguiente ejemplo entenderás cómo enviar archivos, imágenes o videos desde una api cuando el archivo se encuentra en una URL pública o también si quieres subirlo a través de una solicitud.
import 'dotenv/config'
import { createBot, MemoryDB, createProvider } from '@builderbot/bot'
import { BaileysProvider } from '@builderbot/provider-baileys'
import flow from './flows';
const PORT = process.env.PORT ?? 3001
const main = async () => {
const provider = createProvider(BaileysProvider)
const { handleCtx, httpServer } = await createBot({
database: new MemoryDB(),
provider,
flow,
})
httpServer(+PORT)
provider.server.post('/v1/messages', handleCtx(async (bot, req, res) => {
const { number, message, media } = req.body
await bot.sendMessage(number, message, { media }) // https://i.imgur.com/0HpzsEm.png
return res.end('send')
}))
}
main()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.