How to implement a REST API?
Em muitas ocasiões, precisamos enviar uma mensagem via solicitação HTTP é muito útil para enviar lembretes ou confirmações de Pedidos. Nesse caso, cada provedor implementa uma função handleCtx que permite injetar a instanciação do bot e acessar suas funções a partir de um controlador.
É importante utilizar esta função sob a sua própria responsabilidade, uma vez que o uso abusivo pode ser considerado spam e o seu número pode ser bloqueado.
Send Single Message
Request
curl https://api.example.chat/v1/messages \
-d number="34000000" \
-d message="Hello!"No exercício abaixo, você pode obter um exemplo de como funciona. É interessante entender que internamente a biblioteca já implementa uma versão muito leve do HTTP semelhante ao express, mas chamada 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"No exemplo a seguir, você entenderá como enviar arquivos, imagens ou vídeos de uma api quando o arquivo estiver em um URL público ou também se quiser carregá-lo por meio de uma solicitação.
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.