API e webhook
API pronta per la produzione. Non si tratta di una diapositiva che illustra una tabella di marcia.
Oltre 25 endpoint REST, webhook in tempo reale, autenticazione JWT e documentazione interattiva. Ogni funzionalità utilizzata nell'interfaccia utente è disponibile tramite API.
Risposta rapida
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 JWT bearer con scadenza di 24 ore. L'API supporta la paginazione basata su cursore, restituisce risposte di errore conformi a RFC 7807 e impone un limite di 2.000 richieste al 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 backoff di retry esponenziale. La documentazione interattiva dell'API è disponibile all'indirizzo dialer.broadnet.me/admin/api-docs.html.
Il problema
La maggior parte delle API dei dialer sono un ripensamento
Hai acquistato un dialer per effettuare chiamate. Ora devi integrarlo con il tuo CRM, inviare dati al tuo data warehouse, attivare flussi di lavoro dagli eventi di chiamata e creare dashboard personalizzate. Controlli 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à per la maggior parte dei team outbound. Il dialer funziona bene per effettuare chiamate, ma nel momento in cui hai bisogno di costruire sopra di esso — sincronizzare le decisioni con Salesforce, creare automaticamente ticket in Zendesk, inviare analisi al tuo strumento di BI o creare un'interfaccia agente personalizzata — sei costretto a usare esportazioni CSV e processi manuali.
DialerBee è stato progettato con un approccio API-first. Ogni funzionalità dell'interfaccia utente è supportata dalla stessa API REST che è possibile richiamare dai propri sistemi. L'API non è un'aggiunta posticcia, ma il fondamento su cui si basa 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 conformi a RFC 7807. L'autenticazione utilizza token JWT bearer ottenuti tramite un endpoint di login, con scadenza a 24 ore e supporto per il rinnovo del token. Ogni risposta API include intestazioni di limitazione della frequenza, in modo che l'integrazione possa autoregolarsi in modo controllato.
Autenticare
Invia una richiesta POST a /v1/login con le tue credenziali. Riceverai un token JWT bearer valido per 24 ore. Utilizza il refresh del token per le integrazioni di lunga durata.
Punti di chiamata
Oltre 25 endpoint RESTful per campagne, contatti, chiamate, agenti, conformità, registrazioni e report. JSON in ingresso, JSON in uscita.
Ricevi webhook
Registra gli URL dei webhook per ricevere eventi in tempo reale. Ogni payload è firmato con HMAC-SHA256, in modo da poterne verificare l'autenticità.
Gestione degli errori
RFC 7807 Dettagli del problema per ogni errore. Intestazioni di limitazione della velocità in ogni risposta. Stato 429 con indicazioni di retry-after.
Confronto affiancato
API DialerBee vs API tipiche dei dialer
| Capacità | API tipica del dialer | API di DialerBee |
|---|---|---|
| Punti terminali | 5-10, parzialmente documentato | Oltre 25 progetti completamente documentati con le specifiche OpenAPI |
| Protocollo | SOAP/XML o proprietario | REST con JSON, errori RFC 7807 |
| Autenticazione | Chiave API (non scade mai) | JWT con scadenza 24 ore + aggiornamento del token |
| Eventi in tempo reale | Sondaggio o no | Webhook firmati con HMAC-SHA256 e funzione di ritentativo |
| Paginazione | Basato su offset o no | Basato sul cursore con next_cursor + has_more |
| Limitazione della velocità | Senza documenti | 2.000 richieste/minuto con intestazioni in ogni risposta |
| Documentazione | PDF o wiki obsoleto | Documentazione Swagger interattiva in tempo reale |
| Multi-inquilino | Solo inquilino singolo | Definizione dell'ambito per ogni tenant su ogni endpoint |
Riferimento all'endpoint
10 gruppi API. Oltre 25 endpoint.
| API Group | Punti terminali |
|---|---|
| Autenticazione | POST /login, POST /refresh |
| Campagne | CRUD + avvio/pausa |
| Contatti | Carica, elenca, cerca |
| Chiamate | Storia, la vita conta, origine |
| agenti | Stato, registrazione SIP |
| Conformità e DNC | Controlli preliminari alla chiamata, liste DNC |
| Registrazioni | Elenco degli URL di riproduzione firmati |
| Rapporti | Esporta (CSV, JSON, PDF) |
| Webhooks | Iscriviti, gestisci, verifica |
| Sistema | Salute, versione |
Avvio rapido
Autenticati e inizia a comporre il numero in 3 chiamate API
INVIARE /v1/login
Content-Type: application/json
{
"e-mail": "admin@yourcompany.com",
"password": "••••••••"
}
→ Risposta: { "token": "eyJhbG...", "scadenza": 86400 }INVIARE /v1/campagne
Autorizzazione: Portatore eyJhbG...
{
"nome": "Collezioni del terzo trimestre",
"modalità": "progressista",
"amd_enabled": true,
"profilo di conformità": "uae-tdra"
}INVIARE /v1/campagne/{id}/contatti
Content-Type: multipart/form-data
→ Carica il file CSV con numero di telefono, nome e campi personalizzati
INVIARE /v1/campagne/{id}/inizio
→ La campagna sta chiamandoWebhooks
Eventi in tempo reale consegnato ai vostri sistemi
I webhook inviano eventi ai tuoi sistemi in tempo reale, senza bisogno di polling. Ogni payload webhook è firmato con HMAC-SHA256 In questo modo puoi verificare che provenga da DialerBee e non sia stato manomesso. Se il tuo endpoint non è disponibile, i webhook riprovano con un backoff esponenziale fino a 2 ore e 35 minuti, assicurandoti di non perdere mai un evento.
chiamata avviata È stata avviata una nuova chiamata in uscita.
chiamata.risposta Il destinatario ha preso — Classificazione AMD inclusa
chiamata terminata Chiamata conclusa con durata, esito e URL della registrazione.
call.amd_result Risultato della classificazione AMD: umano o macchina, con punteggio di confidenza
agente_stato_cambio L'agente è diventato disponibile, reperibile, ha terminato o è offline
disposizione. L'agente ha presentato una relazione con esito e note.
conformità bloccata Una chiamata è stata bloccata dal motore di conformità con i dettagli della regola
campagna.iniziata La campagna ha iniziato a chiamare
campagna.in pausa Campagna sospesa dal supervisore o dal sistema.
registrazione.pronta La registrazione della chiamata è stata elaborata ed è pronta per la riproduzione.
contact.dnc_added Un contatto è stato aggiunto all'elenco di soppressione del DNC.
richiamata programmata L'agente ha programmato una richiamata per un contatto
Casi d'uso
Costruisci qualsiasi cosa sopra DialerBee
Sincronizzazione CRM
Invia i dati relativi a esiti delle chiamate, risultati delle chiamate e link alle registrazioni a Salesforce, HubSpot, Zoho o qualsiasi altro CRM tramite webhook o interrogazioni API.
Business Intelligence e Data Warehouse
Esporta i dati delle chiamate nel tuo data warehouse. Crea dashboard in Looker, Tableau, Power BI o Metabase con esportazioni di report programmate.
Flussi di lavoro personalizzati
Attiva azioni nei tuoi sistemi in caso di chiamate: crea automaticamente ticket di supporto, aggiorna i punteggi dei lead, invia notifiche Slack.
Clicca per chiamare
Utilizza l'endpoint di origine della chiamata per aggiungere la funzione "clicca per chiamare" dal tuo CRM, help desk o applicazione personalizzata.
Sincronizzazione contatti
Mantieni sincronizzate le liste contatti con la tua fonte di riferimento. Carica i dati tramite CSV o invia i singoli contatti tramite API.
Automazione della conformità
Verifica lo stato del tuo account DNC prima delle chiamate, gestisci gli elenchi di esclusione ed esporta i registri di controllo della conformità in modo programmatico.
Sotto il cofano
Creato per gli sviluppatori che rilasciano
| Protocollo | Solo HTTPS (TLS 1.2+) |
| Formato | Corpi di richiesta e risposta JSON |
| Autenticazione | Token JWT Bearer (scadenza 24 ore) con aggiornamento |
| Versione | Percorso URL /v1 + schema_version nei webhook |
| Paginazione | Basato sul cursore con next_cursor e has_more |
| Limitazione della velocità | 2.000 richieste/minuto per tenant con intestazioni |
| Formato di errore | Dettagli del problema RFC 7807 per le API HTTP |
| Firma Webhook | Verifica della firma HMAC-SHA256 |
| Tentativi di webhook | Backoff esponenziale (massimo 2 ore e 35 minuti in totale) |
| Registrazione degli URL | URL firmati con scadenza di 1 ora tramite MinIO |
| Registri DNC | Emirati Arabi Uniti (TDRA), Arabia Saudita (CITC), Egitto (NTRA), Giordania (TRC) |
| SDK | JavaScript e Python (in arrivo a breve) |
Funzionalità correlate
Piattaforma White-Label
API per i partner per la gestione degli account, la personalizzazione del marchio e la fatturazione.
Analisi e reporting
Esporta i dati dei report tramite API nei tuoi strumenti di Business Intelligence.
Porta il tuo supporto
Gestione dei trunk SIP tramite pannello di amministrazione e API.
Integrazioni
Connettori preconfigurati per CRM, messaggistica e altro ancora.
Domande frequenti sull'API
L'API è disponibile in tutti i piani?
Dove posso trovare la documentazione dell'API?
Come funziona l'autenticazione tramite webhook?
Cosa succede se il mio endpoint webhook non è disponibile?
Posso utilizzare l'API per creare un'interfaccia agente personalizzata?
L'API è multi-tenant?
Qual è il limite di velocità?
Sono disponibili degli SDK?
Pronti per l'integrazione?
Esplora la documentazione API in tempo reale o prenota una demo e ottieni l'accesso all'API. Crea la tua prima integrazione in poche ore, non in settimane.