API e webhook
API e webhook del dialer: pronti per la produzione, non una slide di roadmap.
Oltre 25 endpoint REST, webhook in tempo reale, autenticazione JWT e documentazione interattiva. Ogni funzionalità che usi nell'interfaccia è disponibile tramite API.
Prova gratuita di 14 giorni · credito IA gratuito per provare l'agente vocale IA · senza carta di credito
Risposta rapida
Che cos'è l'API di DialerBee? DialerBee offre un'API REST pronta per la produzione con oltre 25 endpoint che coprono campagne, contatti, chiamate, agenti, conformità, registrazioni, report e webhook. L'autenticazione utilizza token bearer JWT con scadenza a 24 ore. L'API supporta la paginazione basata su cursore, restituisce risposte di errore RFC 7807 e applica un limite di 2.000 richieste/minuto per tenant. I webhook in tempo reale inviano eventi (call.started, call.answered, call.amd_result, disposition.set, compliance.blocked, ecc.) con verifica della firma HMAC-SHA256 e nuovi tentativi con backoff esponenziale. La documentazione API interattiva è disponibile su app.dialerbee.com/admin/api-docs.html.
Il problema
La maggior parte delle API dei dialer è un ripensamento
Hai acquistato un dialer per fare chiamate. Ora devi integrarlo con il tuo CRM, inviare dati al tuo data warehouse, avviare workflow dagli eventi di chiamata e creare dashboard personalizzate. Consulti la documentazione API del fornitore e trovi... un PDF del 2019 con 6 endpoint non documentati, nessun webhook e un'interfaccia SOAP.
Questa è la realtà della maggior parte dei team outbound. Il dialer funziona bene per fare chiamate, ma nel momento in cui devi costruirci sopra (sincronizzare gli esiti con Salesforce, creare automaticamente ticket in Zendesk, inviare analytics al tuo strumento di BI o creare un'interfaccia agente personalizzata) resti bloccato con esportazioni CSV e processi manuali.
DialerBee è nato API-first. Ogni funzionalità dell'interfaccia si basa sulla stessa API REST che puoi chiamare dai tuoi sistemi. L'API non è un'aggiunta: è la base su cui funziona l'intera piattaforma.
Come funziona
API-first per progettazione
L'API di DialerBee segue le convenzioni REST con payload JSON, metodi HTTP standard e risposte di errore RFC 7807. L'autenticazione utilizza token bearer JWT ottenuti tramite un endpoint di login, con scadenza a 24 ore e supporto al refresh del token. Ogni risposta API include header sui limiti di frequenza, così la tua integrazione può autoregolarsi senza problemi.
Autenticazione
Invia una POST a /v1/login con le credenziali. Ricevi un token bearer JWT valido per 24 ore. Usa il refresh del token per le integrazioni di lunga durata.
Chiamata agli endpoint
Oltre 25 endpoint RESTful per campagne, contatti, chiamate, agenti, conformità, registrazioni e report. JSON in ingresso, JSON in uscita.
Ricezione dei webhook
Registra gli URL dei webhook per ricevere eventi in tempo reale. Ogni payload è firmato con HMAC-SHA256, così puoi verificarne l'autenticità.
Gestione degli errori
RFC 7807 Problem Details per ogni errore. Header sui limiti di frequenza in ogni risposta. Stato 429 con indicazione retry-after.
Confronto diretto
API DialerBee vs API tipiche dei dialer
| Funzionalità | API tipica di un dialer | API DialerBee |
|---|---|---|
| Endpoint | 5-10, parzialmente documentati | Oltre 25, completamente documentati con specifica OpenAPI |
| Protocollo | SOAP/XML o proprietario | REST con JSON, errori RFC 7807 |
| Authentication | Chiave API (senza scadenza) | JWT con scadenza a 24 ore + refresh del token |
| Eventi in tempo reale | Polling o nessuno | Webhook firmati HMAC-SHA256 con nuovi tentativi |
| Paginazione | Basata su offset o assente | Basata su cursore con next_cursor + has_more |
| Limiti di frequenza | Non documentati | 2.000 richieste/min con header in ogni risposta |
| Documentazione | PDF o wiki obsoleta | Documentazione Swagger interattiva e aggiornata |
| Multi-tenant | Solo single-tenant | Ambito per tenant su ogni endpoint |
Riferimento degli endpoint
10 gruppi di API. Oltre 25 endpoint.
| Gruppo di API | Endpoint |
|---|---|
| Authentication | POST /login, POST /refresh |
| Campagne | CRUD + avvio/pausa |
| Contatti | Caricamento, elenco, ricerca |
| Chiamate | Storico, conteggi live, origination |
| Operatori | Stato, registrazione SIP |
| Conformità e DNC | Controlli pre-chiamata, liste DNC |
| Registrazioni | Elenco, URL di riproduzione firmati |
| Report | Esportazione (CSV, JSON, PDF) |
| Webhook | Sottoscrizione, gestione, verifica |
| Sistema | Stato, versione |
Guida rapida
Autenticati e inizia a chiamare con 3 chiamate 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 dialingWebhook
Eventi in tempo reale inviati ai tuoi sistemi
I webhook inviano eventi ai tuoi sistemi in tempo reale, senza bisogno di polling. Ogni payload dei webhook è firmato con HMAC-SHA256 così puoi verificare che provenga da DialerBee e che non sia stato manomesso. Se il tuo endpoint non è raggiungibile, i webhook ritentano con backoff esponenziale per un massimo di 2 ore e 35 minuti, così non perdi mai un evento.
call.started È stata avviata una nuova chiamata in uscita
call.answered Il destinatario ha risposto, classificazione AMD inclusa
call.ended Chiamata completata con durata, esito e URL della registrazione
call.amd_result Risultato della classificazione AMD: persona o segreteria, con punteggio di confidenza
agent.state_change L'agente è passato a disponibile, in chiamata, post-chiamata o offline
disposition.set L'agente ha inserito un esito con risultato e note
compliance.blocked Una chiamata è stata bloccata dal motore di conformità, con i dettagli della regola
campaign.started La campagna ha iniziato a chiamare
campaign.paused Campagna messa in pausa dal supervisore o dal sistema
recording.ready La registrazione della chiamata è stata elaborata ed è pronta per la riproduzione
contact.dnc_added Un contatto è stato aggiunto alla lista di esclusione DNC
callback.scheduled L'agente ha pianificato un richiamo per un contatto
Casi d'uso
Costruisci qualsiasi cosa su DialerBee
Sincronizzazione CRM
Invia esiti, risultati delle chiamate e link alle registrazioni a Salesforce, HubSpot, Zoho o qualsiasi CRM tramite webhook o polling API.
BI e data warehouse
Esporta i dati delle chiamate nel tuo data warehouse. Crea dashboard in Looker, Tableau, Power BI o Metabase con esportazioni pianificate dei report.
Workflow personalizzati
Attiva azioni nei tuoi sistemi in base agli eventi di chiamata: crea automaticamente ticket di assistenza, aggiorna i punteggi dei lead, invia notifiche Slack.
Click-to-call
Usa l'endpoint di origination delle chiamate per aggiungere il click-to-call al tuo CRM, helpdesk o applicazione personalizzata.
Sincronizzazione dei contatti
Mantieni le liste di contatti allineate con la tua fonte di riferimento. Carica tramite CSV o invia singoli contatti tramite API.
Automazione della conformità
Verifica lo stato DNC prima delle chiamate, gestisci le liste di esclusione ed esporta i log di audit di conformità in modo programmatico.
Dietro le quinte
Pensato per sviluppatori che rilasciano
| Protocollo | Solo HTTPS (TLS 1.2+) |
| Formato | Corpi di richiesta e risposta in JSON |
| Authentication | Token bearer JWT (scadenza a 24 ore) con refresh |
| Versionamento | Percorso URL /v1 + schema_version nei webhook |
| Paginazione | Basata su cursore con next_cursor e has_more |
| Limiti di frequenza | 2.000 richieste/minuto per tenant con header |
| Formato degli errori | RFC 7807 Problem Details per API HTTP |
| Firma dei webhook | Verifica della firma HMAC-SHA256 |
| Nuovi tentativi dei webhook | Backoff esponenziale (massimo 2 h 35 min in totale) |
| URL delle registrazioni | URL firmati con scadenza di 1 ora tramite MinIO |
| Registri DNC | EAU (TDRA), Arabia Saudita (CST), Egitto (NTRA), Giordania (TRC) |
| SDK | JavaScript e Python (in arrivo) |
Funzionalità correlate
Piattaforma white-label
API per partner per provisioning dei tenant, branding e fatturazione.
Analytics e report
Esporta i dati dei report tramite API verso i tuoi strumenti di BI.
Bring Your Own Carrier
Gestione dei trunk SIP tramite pannello di amministrazione e API.
Integrazioni
Connettori predefiniti per CRM, messaggistica e altro.
Domande frequenti sull'API
L'API è disponibile in tutti i piani?
Dove trovo la documentazione API?
Come funziona l'autenticazione dei webhook?
Cosa succede se il mio endpoint webhook non è raggiungibile?
Posso usare l'API per creare un'interfaccia agente personalizzata?
L'API è multi-tenant?
Qual è il limite di frequenza?
Sono disponibili SDK?
Sapere a cosa puoi iscriverti
Ogni evento è documentato prima che tu inizi a sviluppare
La piattaforma pubblica un evento per tutto ciò che conta durante una chiamata, e ciascuno è catalogato con la struttura del suo payload: così sai cosa conterrà un webhook prima di scrivere l'handler, invece di scoprire lo schema da ciò che arriva per primo.
Ciclo di vita della chiamata, stato della campagna, attività degli agenti, esito, disponibilità delle registrazioni, decisioni di conformità e consegna dei messaggi pubblicano ciascuno i propri eventi. Iscriviti a quelli che interessano alla tua integrazione e ignora il resto: non sei obbligato a consumare un flusso ininterrotto per ottenere i tre eventi che ti servono.
Pronto a integrare?
Esplora la documentazione API live o prenota una demo e ottieni l'accesso all'API. Crea la tua prima integrazione in ore, non in settimane.
Prova gratuita di 14 giorni · credito IA gratuito · senza carta · vedi i prezzi