API e Webhooks
API e webhooks do discador: prontos para produção, não um slide de roadmap.
Mais de 25 endpoints REST, webhooks em tempo real, autenticação JWT e documentação interativa. Todo recurso que você usa na interface está disponível via API.
Teste grátis de 14 dias · crédito de IA gratuito para testar o agente de voz com IA · sem cartão
Resposta rápida
O que é a API da DialerBee? A DialerBee oferece uma API REST pronta para produção com mais de 25 endpoints que cobrem campanhas, contatos, chamadas, agentes, conformidade, gravações, relatórios e webhooks. A autenticação usa tokens bearer JWT com validade de 24 horas. A API oferece paginação baseada em cursor, retorna respostas de erro no padrão RFC 7807 e aplica o limite de 2.000 requisições/minuto por tenant. Webhooks em tempo real entregam eventos (call.started, call.answered, call.amd_result, disposition.set, compliance.blocked etc.) com verificação de assinatura HMAC-SHA256 e novas tentativas com backoff exponencial. A documentação interativa da API está disponível em app.dialerbee.com/admin/api-docs.html.
O problema
A maioria das APIs de discador é uma reflexão tardia
Você comprou um discador para fazer chamadas. Agora precisa integrá-lo ao seu CRM, enviar dados para o seu data warehouse, disparar fluxos a partir de eventos de chamada e criar dashboards personalizados. Você abre a documentação da API do fornecedor e encontra... um PDF de 2019 com 6 endpoints não documentados, sem webhooks e com uma interface SOAP.
Essa é a realidade da maioria das equipes de ativo. O discador funciona bem para fazer chamadas, mas no momento em que você precisa construir em cima dele — sincronizar tabulações com o Salesforce, criar tickets automaticamente no Zendesk, enviar analytics para sua ferramenta de BI ou criar uma interface de agente personalizada — você fica preso a exportações CSV e processos manuais.
A DialerBee foi criada com abordagem API-first. Cada recurso da interface usa a mesma API REST que você pode chamar a partir dos seus próprios sistemas. A API não é um complemento — é a base sobre a qual toda a plataforma funciona.
Como funciona
API-first por concepção
A API da DialerBee segue as convenções REST, com payloads JSON, métodos HTTP padrão e respostas de erro RFC 7807. A autenticação usa tokens bearer JWT obtidos por um endpoint de login, com validade de 24 horas e suporte a renovação de token. Toda resposta da API inclui cabeçalhos de limite de requisições, para que sua integração consiga reduzir o ritmo de forma controlada.
Autenticar
Faça um POST em /v1/login com as credenciais. Receba um token bearer JWT válido por 24 horas. Use a renovação de token em integrações de longa duração.
Chamar endpoints
Mais de 25 endpoints RESTful para campanhas, contatos, chamadas, agentes, conformidade, gravações e relatórios. Entra JSON, sai JSON.
Receber webhooks
Cadastre URLs de webhook para receber eventos em tempo real. Cada payload é assinado com HMAC-SHA256 para que você possa verificar a autenticidade.
Tratar erros
RFC 7807 Problem Details para todo erro. Cabeçalhos de limite de requisições em toda resposta. Status 429 com orientação de retry-after.
Comparação lado a lado
API da DialerBee vs. APIs típicas de discador
| Recurso | API típica de discador | API da DialerBee |
|---|---|---|
| Endpoints | 5 a 10, parcialmente documentados | Mais de 25, totalmente documentados com especificação OpenAPI |
| Protocolo | SOAP/XML ou proprietário | REST com JSON, erros RFC 7807 |
| Authentication | Chave de API (nunca expira) | JWT com validade de 24h + renovação de token |
| Eventos em tempo real | Polling ou nenhum | Webhooks assinados com HMAC-SHA256 e novas tentativas |
| Paginação | Por offset ou nenhuma | Por cursor, com next_cursor + has_more |
| Limite de requisições | Não documentado | 2.000 req/min com cabeçalhos em toda resposta |
| Documentação | PDF ou wiki desatualizada | Documentação Swagger interativa ao vivo |
| Multi-tenant | Apenas single-tenant | Escopo por tenant em todos os endpoints |
Referência de endpoints
10 grupos de API. Mais de 25 endpoints.
| Grupo de API | Endpoints |
|---|---|
| Authentication | POST /login, POST /refresh |
| Campanhas | CRUD + iniciar/pausar |
| Contatos | Upload, listagem, busca |
| Chamadas | Histórico, contagens ao vivo, originação |
| Agentes | Status, registro SIP |
| Conformidade e DNC | Verificações pré-discagem, listas DNC |
| Gravações | Listagem, URLs de reprodução assinadas |
| Relatórios | Exportação (CSV, JSON, PDF) |
| Webhooks | Assinar, gerenciar, verificar |
| Sistema | Saúde, versão |
Início rápido
Autentique-se e comece a discar em 3 chamadas de API
POST /v1/login
Content-Type: application/json
{
"email": "admin@yourcompany.com",
"password": "••••••••"
}
→ Response: { "token": "eyJhbG...", "expires_in": 86400 }POST /v1/campaigns
Authorization: Bearer eyJhbG...
{
"name": "Q3 Collections",
"mode": "progressive",
"amd_enabled": true,
"compliance_profile": "uae-tdra"
}POST /v1/campaigns/{id}/contacts
Content-Type: multipart/form-data
→ Upload CSV with phone, name, and custom fields
POST /v1/campaigns/{id}/start
→ Campaign is now dialingWebhooks
Eventos em tempo real entregues aos seus sistemas
Os webhooks entregam eventos aos seus sistemas em tempo real — sem necessidade de polling. Cada payload de webhook é assinado com HMAC-SHA256 para que você possa verificar que veio da DialerBee e não foi adulterado. Se o seu endpoint estiver fora do ar, os webhooks fazem novas tentativas com backoff exponencial por até 2 horas e 35 minutos, para que você nunca perca um evento.
call.started Uma nova chamada de saída foi iniciada
call.answered O destinatário atendeu — classificação do AMD incluída
call.ended Chamada concluída com duração, tabulação e URL da gravação
call.amd_result Resultado da classificação do AMD: humano ou máquina, com índice de confiança
agent.state_change O agente ficou disponível, em chamada, em pós-atendimento ou offline
disposition.set O agente registrou uma tabulação com resultado e observações
compliance.blocked Uma chamada foi bloqueada pelo motor de conformidade, com detalhes da regra
campaign.started A campanha começou a discar
campaign.paused Campanha pausada pelo supervisor ou pelo sistema
recording.ready A gravação da chamada foi processada e está pronta para reprodução
contact.dnc_added Um contato foi adicionado à lista de supressão DNC
callback.scheduled O agente agendou um retorno para um contato
Casos de uso
Construa o que quiser sobre a DialerBee
Sincronização com CRM
Envie tabulações, resultados de chamadas e links de gravações para Salesforce, HubSpot, Zoho ou qualquer CRM via webhooks ou polling da API.
BI e data warehouse
Exporte dados de chamadas para o seu data warehouse. Crie dashboards no Looker, Tableau, Power BI ou Metabase com exportações agendadas de relatórios.
Fluxos personalizados
Dispare ações nos seus sistemas a partir de eventos de chamada — crie tickets de suporte automaticamente, atualize a pontuação de leads, envie notificações no Slack.
Click-to-call
Use o endpoint de originação de chamadas para adicionar click-to-call ao seu CRM, help desk ou aplicação personalizada.
Sincronização de contatos
Mantenha as listas de contatos sincronizadas com sua fonte oficial de dados. Envie por CSV ou envie contatos individuais via API.
Automação de conformidade
Consulte o status DNC antes das chamadas, gerencie listas de supressão e exporte logs de auditoria de conformidade de forma programática.
Por dentro
Feito para desenvolvedores que entregam
| Protocolo | Somente HTTPS (TLS 1.2+) |
| Formato | Corpos de requisição e resposta em JSON |
| Authentication | Tokens bearer JWT (validade de 24 horas) com renovação |
| Versionamento | Caminho de URL /v1 + schema_version nos webhooks |
| Paginação | Por cursor, com next_cursor e has_more |
| Limite de requisições | 2.000 requisições/minuto por tenant, com cabeçalhos |
| Formato de erro | RFC 7807 Problem Details for HTTP APIs |
| Assinatura de webhooks | Verificação de assinatura HMAC-SHA256 |
| Novas tentativas de webhooks | Backoff exponencial (máximo de 2h35min no total) |
| URLs de gravações | URLs assinadas com validade de 1 hora via MinIO |
| Registros DNC | Emirados Árabes Unidos (TDRA), Arábia Saudita (CST), Egito (NTRA), Jordânia (TRC) |
| SDKs | JavaScript e Python (em breve) |
Recursos relacionados
Plataforma de marca branca
API de parceiros para provisionamento de tenants, branding e faturamento.
Análises e relatórios
Exporte dados de relatórios via API para suas ferramentas de BI.
Traga a sua própria operadora
Gestão de troncos SIP pelo painel administrativo e pela API.
Integrações
Conectores prontos para CRMs, mensageria e muito mais.
Perguntas frequentes sobre a API
A API está disponível em todos os planos?
Onde encontro a documentação da API?
Como funciona a autenticação de webhooks?
O que acontece se o meu endpoint de webhook estiver fora do ar?
Posso usar a API para criar uma interface de agente personalizada?
A API é multi-tenant?
Qual é o limite de requisições?
Existem SDKs disponíveis?
Saiba em quais eventos você pode se inscrever
Cada evento é documentado antes de você desenvolver
A plataforma publica um evento para tudo o que importa em uma chamada, e cada um é catalogado com o formato do seu payload — assim você sabe o que um webhook vai conter antes de escrever o handler, em vez de descobrir o schema pelo que chegar primeiro.
Ciclo de vida da chamada, estado da campanha, atividade dos agentes, tabulação, disponibilidade de gravações, decisões de conformidade e entrega de mensagens publicam, cada um, seus próprios eventos. Inscreva-se nos que interessam à sua integração e ignore o resto — você não precisa consumir uma enxurrada de dados para obter os três eventos de que precisa.
Pronto para integrar?
Explore a documentação da API ao vivo ou agende uma demonstração e obtenha acesso à API. Crie sua primeira integração em horas, não em semanas.
Teste grátis de 14 dias · crédito de IA gratuito · sem cartão · ver preços