Skip to main content
A API REST da BluBash conecta seu sistema à plataforma. Com ela, você encaminha mensagens para o agente de IA por um canal API e alimenta campanhas contínuas do WhatsApp com contatos vindos do seu CRM, site ou ERP.

​
APIs disponíveis

Channels API

Envie para a BluBash as mensagens dos seus usuários (texto, imagem, áudio, vídeo ou documento) por um canal API e receba a resposta do agente de IA na mesma chamada.

Campaigns API

Adicione contatos a uma Campanha Contínua, agende envios por contato, cancele mensagens na fila e consulte o status de entrega.

​
URL base

​
Autenticação

Toda requisição precisa da API Key do workspace no cabeçalho X-API-Key. O nome do cabeçalho não diferencia maiúsculas de minúsculas: x-api-key também funciona.

​
Obter a API Key

A interface da BluBash não tem uma tela para gerar chaves de API. Solicite a API Key do workspace ao suporte da BluBash. Para usar a Channels API, peça também a configuração do canal API, que é feita pelo suporte.
Trate a API Key como uma senha. Não a coloque em código que roda no navegador ou no aplicativo do cliente, nem em repositórios públicos. Faça as chamadas a partir do seu servidor.

​
Idempotência

A Channels API aceita o cabeçalho opcional X-Idempotency-Key. Envie um valor único por operação para que uma nova tentativa da mesma requisição não gere mensagens duplicadas.
Use um UUID por operação lógica ou um hash do conteúdo da requisição. Reutilize a mesma chave só quando estiver repetindo exatamente a mesma operação.

​
Códigos de resposta

​
Boas práticas

  • Use sempre o mesmo identificador para o mesmo contato. Na Channels API, o contactIdentifier. Na Campaigns API, o identifier ou o contact_id. Identificadores diferentes criam contatos duplicados.
  • Trate erros por código. Erros 4xx exigem correção; erros 5xx podem ser repetidos.
  • Repita com backoff exponencial. Espere cada vez mais entre as tentativas e limite o número de repetições.
  • Valide antes em um ambiente de testes. Use um canal e uma campanha de teste antes de apontar o tráfego de produção.
  • Registre os IDs retornados. Guarde contactId, conversationId e messageId para rastrear o atendimento e a entrega.

​
Como a API se conecta ao restante da BluBash

  • Contatos criados pela API aparecem em Contatos, com etiquetas e campos adicionais enviados no payload.
  • Conversas do canal API são atendidas pelo agente de IA configurado para o canal. Veja O que são agentes de IA →.
  • Contatos adicionados por API em uma Campanha Contínua aparecem com a origem API nos detalhes da campanha. Veja Gerenciar campanhas →.

​
Suporte

Para obter a API Key, configurar o canal API ou tirar dúvidas de integração, fale com o suporte da BluBash em suporte@blubash.io.