API e Webhooks
API pronta para produção. Não é um slide de roteiro.
Mais de 25 endpoints REST , webhooks em tempo real, autenticação JWT e documentação interativa. Todos os recursos que você usa na interface do usuário estão disponíveis via API .
Teste grátis por 14 dias · Sem necessidade de cartão de crédito
Resposta rápida
O que é a API DialerBee ? DialerBee oferece uma API REST pronta para produção com mais de 25 endpoints que abrangem campanhas, contatos, chamadas, agentes, conformidade, gravações, relatórios e webhooks. A autenticação utiliza tokens JWT com validade de 24 horas. A API suporta paginação baseada em cursor, retorna respostas de erro de acordo com a RFC 7807 e impõe um limite de 2.000 requisições por 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 backoff exponencial de novas tentativas. A documentação interativa API está disponível em dialer.broadnet.me/admin/api-docs.html.
O problema
A maioria das APIs de discagem são uma reflexão tardia
Você comprou um discador para fazer chamadas. Agora precisa integrá-lo ao seu CRM , enviar dados para o seu banco de dados, acionar fluxos de trabalho a partir de eventos de chamadas e criar painéis personalizados. Você consulta a documentação da API do fornecedor e encontra... um PDF de 2019 com 6 endpoints não documentados, nenhum webhook e uma interface SOAP.
Essa é a realidade da maioria das equipes de telemarketing. O discador funciona bem para fazer chamadas, mas no momento em que você precisa... construir em cima disso — sincronizar disposições com o Salesforce, criar tickets automaticamente no Zendesk, enviar análises para sua ferramenta de BI ou criar uma interface de agente personalizada — você fica limitado a exportações em CSV e processos manuais.
DialerBee foi desenvolvido com foco API . Todas as funcionalidades da interface do usuário são suportadas pela mesma API REST , que você pode acessar a partir dos seus próprios sistemas. A API não é um complemento — ela é a base sobre a qual toda a plataforma funciona.
Como funciona
API -first por design
API do DialerBee segue as convenções REST com payloads JSON, métodos HTTP padrão e respostas de erro de acordo com a RFC 7807. A autenticação utiliza tokens JWT (Bearer Tokens) obtidos por meio de um endpoint de login, com expiração de 24 horas e suporte para atualização de token. Cada resposta API inclui cabeçalhos de limitação de taxa para que sua integração possa se autolimitar de forma eficiente.
Autenticar
Envie uma requisição POST para /v1/login com suas credenciais. Receba um token JWT válido por 24 horas. Use a atualização de token para integrações de longa duração.
Pontos finais de chamada
Mais de 25 endpoints RESTful para campanhas, contatos, chamadas, agentes, conformidade, gravações e relatórios. Entrada e saída em JSON.
Receber Webhooks
Registre URLs de webhook para receber eventos em tempo real. Cada payload é assinado com HMAC-SHA256 para que você possa verificar sua autenticidade.
Lidar com erros
Detalhes do problema conforme a RFC 7807 para cada erro. Cabeçalhos de limite de taxa em cada resposta. Status 429 com instruções para tentar novamente após a resposta.
Comparação lado a lado
API DialerBee vs. APIs de discagem típicas
| Capacidade | API de discador típica | API DialerBee |
|---|---|---|
| Pontos finais | 5-10, parcialmente documentado | Mais de 25 versões totalmente documentadas com especificação OpenAPI. |
| Protocolo | SOAP/XML ou proprietário | REST com JSON, erros RFC 7807 |
| Autenticação | Chave API (nunca expira) | JWT com expiração de 24 horas + atualização de token |
| Eventos em tempo real | Votação ou não. | Webhooks assinados com HMAC-SHA256 com repetição |
| Paginação | Com base em deslocamento ou nenhum | Baseado em cursor com next_cursor + has_more |
| Limitação de taxa | Sem documentação | 2.000 requisições/min com cabeçalhos em cada resposta |
| Documentação | PDF ou wiki desatualizada | Documentos Swagger interativos ao vivo |
| multi-tenant | Apenas para um tenant | Definição de escopo por locatário em cada endpoint. |
Referência do ponto final
10 grupos API . Mais de 25 pontos de extremidade.
| Grupo API | Pontos finais |
|---|---|
| Autenticação | POST /login, POST /refresh |
| Campanhas | CRUD + iniciar/pausar |
| Contatos | Carregar, listar, pesquisar |
| Chamadas | História, contagens ao vivo, origem |
| Agentes | Estado, registro SIP |
| Conformidade e DNC | Verificações pré-discagem, listas DNC |
| Gravações | Lista de URLs de reprodução assinadas |
| Relatórios | Exportar (CSV, JSON, PDF) |
| Webhooks | Inscrever-se, gerenciar, verificar |
| Sistema | Saúde, versão |
Início rápido
Autentique-se e comece a discar. em 3 chamadas 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 enviam eventos para seus sistemas em tempo real — sem necessidade de polling. Cada payload de webhook é assinado com HMAC-SHA256 Assim, você pode verificar se a mensagem veio do DialerBee e não foi adulterada. Se o seu endpoint estiver inativo, os webhooks tentarão novamente com um intervalo de espera exponencial de até 2 horas e 35 minutos, garantindo que você nunca perca um evento.
call.started Uma nova chamada de saída foi iniciada.
call.answered O destinatário retirou — classificação AMD incluída
call.ended Chamada concluída com duração, desfecho e URL da gravação.
call.amd_result Resultado da classificação AMD : humano ou máquina, com pontuação de confiança.
agent.state_change O agente ficou disponível, de plantão, finalizou o expediente ou ficou offline.
disposition.set O agente apresentou um relatório com o resultado e anotações.
compliance.blocked Uma chamada foi bloqueada pelo mecanismo 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 de chamada para o contato.
Casos de uso
Construa qualquer coisa em cima do DialerBee
Sincronização CRM
Envie informações sobre decisões, resultados de chamadas e links de gravações para o Salesforce, HubSpot, Zoho ou qualquer CRM por meio de webhooks ou consultas API .
BI e Data Warehouse
Exporte dados de chamadas para seu data warehouse. Crie dashboards no Looker, Tableau, Power BI ou Metabase com exportações de relatórios agendadas.
Fluxos de trabalho personalizados
Acione ações em seus sistemas em eventos de chamadas — crie chamados de suporte automaticamente, atualize pontuações de leads, envie notificações do Slack.
Clique para ligar
Utilize o endpoint de origem de chamadas para adicionar a funcionalidade "clique para ligar" a partir do seu CRM , helpdesk ou aplicativo personalizado.
Sincronização de contatos
Mantenha suas listas de contatos sincronizadas com sua fonte de dados principal. Faça o upload via CSV ou envie contatos individuais via API .
Automação de Conformidade
Consulte o status DNC antes de fazer chamadas, gerencie listas de supressão e exporte registros de auditoria de conformidade programaticamente.
Sob o capô
Feito para desenvolvedores que entregam resultados.
| Protocolo | Somente HTTPS (TLS 1.2 ou superior) |
| Formatar | Corpos de requisição e resposta JSON |
| Autenticação | Tokens JWT Bearer (expiração em 24 horas) com atualização. |
| Controle de versões | /v1 Caminho da URL + versão do esquema em webhooks |
| Paginação | Baseado em cursor com next_cursor e has_more |
| Limitação de taxa | 2.000 requisições/minuto por locatário com cabeçalhos |
| Formato de erro | Detalhes do problema RFC 7807 para APIs HTTP |
| Assinatura de webhook | Verificação de assinatura HMAC-SHA256 |
| Tentativas de webhook | Recuo exponencial (máximo de 2h 35m no total) |
| URLs de gravação | URLs assinadas com expiração de 1 hora via MinIO |
| registros DNC | Emirados Árabes Unidos ( TDRA ), KSA ( CITC ), Egito ( NTRA ), Jordânia ( TRC ) |
| SDKs | JavaScript e Python (em breve) |
Recursos relacionados
Plataforma de marca branca
API de parceiros para provisionamento de tenants, personalização da marca e faturamento.
Análise e Relatórios
Exporte dados de relatórios via API para suas ferramentas de BI.
Traga sua própria operadora
Gerenciamento de trunks SIP via painel de administração e API .
Integrações
Conectores pré-configurados para CRMs, mensagens e muito mais.
Perguntas frequentes sobre a API
A API está disponível em todos os planos?
Onde posso encontrar a documentação API ?
Como funciona a autenticação por webhook?
O que acontece se meu endpoint de webhook estiver inativo?
Posso usar a API para criar uma interface de agente personalizada?
A API é multi-tenant?
Qual é o limite de taxa?
Existem SDKs disponíveis?
Saiba a que você pode se inscrever.
Todo evento é documentado antes de construir
A plataforma publica um evento para tudo o que importa em uma chamada, e cada um é catalogado com o formato de sua carga útil — assim você sabe o que um webhook conterá antes de escrever o manipulador, em vez de descobrir o esquema a partir do que chegar primeiro.
O ciclo de vida da chamada, o estado da campanha, a atividade do agente, a disposição, a disponibilidade da gravação, as decisões de conformidade e a entrega de mensagens, cada um desses elementos publica seus próprios eventos. Inscreva-se apenas nos eventos relevantes para a sua integração e ignore o restante — você não precisa consumir uma quantidade enorme de dados para obter os três eventos de que precisa.
Pronto para integrar?
Explore a documentação API em tempo real ou agende uma demonstração e obtenha acesso API . Crie sua primeira integração em horas, não em semanas.
Teste grátis por 14 dias · sem necessidade de cartão de crédito · ver preços