Referência da API

Plugins funcionam interagindo com a API do ManyBot. Ela expõe um conjunto de recursos que permite aos plugins enviar e receber mensagens, acessar informações e utilizar funcionalidades do WhatsApp sem precisar lidar diretamente com o socket ou sua implementação — e, pro caso raro de precisar de algo que a API não cobre, existe um escape hatch (ctx.wa) com acesso direto a ele.

TypeScript/JSDoc: o ManyBot publica seu próprio pacote de tipos, @manybot/types. Ao criar um plugin com manyplug init, ele já entra como devDependency no package.json gerado — é ele que dá autocomplete no seu editor, tanto em JS (via JSDoc) quanto em TS. Veja como configurar.

  1. Anatomia de um plugin & guardOptions
  2. O objeto ctx (setup vs runtime)
  3. ctx.send & ctx.msg
  4. ctx.chat, ctx.admin & ctx.me
  5. ctx.contacts
  6. ctx.events
  7. ctx.poll
  8. ctx.config, i18n, utils, download, storage, plugins, scheduler, settings, log, botId, ctx.wa
  9. Padrões comuns