Zum Inhalt springen

API & Webhooks

Dialer-API und Webhooks: produktionsreif, keine Roadmap-Folie.

25+ REST-Endpunkte, Echtzeit-Webhooks, JWT-Authentifizierung und interaktive Dokumentation. Jede Funktion, die Sie in der Oberfläche nutzen, ist auch per API verfügbar.

14-tägige kostenlose Testphase · kostenloses KI-Guthaben, um den KI-Voice-Agenten zu testen · keine Kreditkarte nötig

Entwickelt von BroadNet – 22 Jahre in der Telekommunikation 11 Sprachen, dialektsensibel BYOC – Ihre Carrier, keine Bindung Compliance-unterstützend (TCPA, DSGVO, TDRA)

Die kurze Antwort

Was ist die DialerBee API? DialerBee bietet eine produktionsreife REST API mit 25+ Endpunkten für Kampagnen, Kontakte, Anrufe, Agenten, Compliance, Aufzeichnungen, Berichte und Webhooks. Die Authentifizierung erfolgt über JWT-Bearer-Tokens mit 24 Stunden Gültigkeit. Die API unterstützt cursorbasierte Paginierung, liefert Fehlerantworten nach RFC 7807 und begrenzt auf 2.000 Anfragen pro Minute und Mandant. Echtzeit-Webhooks liefern Ereignisse (call.started, call.answered, call.amd_result, disposition.set, compliance.blocked usw.) mit HMAC-SHA256-Signaturprüfung und exponentiellem Retry-Backoff. Die interaktive API-Dokumentation finden Sie unter app.dialerbee.com/admin/api-docs.html.

Das Problem

Die meisten Dialer-APIs sind ein nachträglicher Einfall

Sie haben einen Dialer gekauft, um zu telefonieren. Jetzt müssen Sie ihn mit Ihrem CRM verbinden, Daten in Ihr Data Warehouse übertragen, Workflows aus Anrufereignissen auslösen und eigene Dashboards bauen. Sie sehen sich die API-Dokumentation des Anbieters an und finden … ein PDF von 2019 mit 6 undokumentierten Endpunkten, ohne Webhooks und mit SOAP-Schnittstelle.

Das ist die Realität der meisten Outbound-Teams. Der Dialer funktioniert gut zum Telefonieren, aber sobald Sie darauf aufbauen wollen – Gesprächsergebnisse mit Salesforce synchronisieren, automatisch Tickets in Zendesk anlegen, Analysen an Ihr BI-Tool übertragen oder eine eigene Agentenoberfläche bauen –, bleiben Ihnen nur CSV-Exporte und manuelle Prozesse.

DialerBee wurde API-first entwickelt. Jede Funktion der Oberfläche basiert auf derselben REST API, die Sie aus Ihren eigenen Systemen aufrufen können. Die API ist kein Anbau – sie ist das Fundament, auf dem die gesamte Plattform läuft.

6
Typische Endpunkte von Anbietern
undokumentiert, keine Webhooks
SOAP
Veraltetes Protokoll
viele Dialer nutzen noch XML/SOAP
CSV
Integration nur per Export
manuelle Dateiübertragung, keine Echtzeit

So funktioniert es

API-first aus Prinzip

Die API von DialerBee folgt REST-Konventionen mit JSON-Payloads, Standard-HTTP-Methoden und Fehlerantworten nach RFC 7807. Die Authentifizierung erfolgt über JWT-Bearer-Tokens, die über einen Login-Endpunkt bezogen werden, mit 24 Stunden Gültigkeit und Token-Refresh. Jede API-Antwort enthält Rate-Limit-Header, damit Ihre Integration sich selbst sauber drosseln kann.

Schritt 01

Authentifizieren

POST an /v1/login mit Zugangsdaten. Sie erhalten ein JWT-Bearer-Token mit 24 Stunden Gültigkeit. Nutzen Sie Token-Refresh für lang laufende Integrationen.

Schritt 02

Endpunkte aufrufen

25+ REST-Endpunkte für Kampagnen, Kontakte, Anrufe, Agenten, Compliance, Aufzeichnungen und Berichte. JSON rein, JSON raus.

Schritt 03

Webhooks empfangen

Registrieren Sie Webhook-URLs, um Ereignisse in Echtzeit zu erhalten. Jede Payload ist mit HMAC-SHA256 signiert, sodass Sie die Echtheit prüfen können.

Schritt 04

Fehler behandeln

RFC 7807 Problem Details für jeden Fehler. Rate-Limit-Header in jeder Antwort. Status 429 mit Retry-After-Hinweis.

Direkter Vergleich

DialerBee API vs. typische Dialer-APIs

Funktion Typische Dialer-API DialerBee API
Endpunkte 5–10, teilweise dokumentiert 25+, vollständig dokumentiert mit OpenAPI-Spezifikation
Protokoll SOAP/XML oder proprietär REST mit JSON, Fehler nach RFC 7807
Authentifizierung API-Schlüssel (läuft nie ab) JWT mit 24 h Gültigkeit + Token-Refresh
Echtzeit-Ereignisse Polling oder gar nicht Mit HMAC-SHA256 signierte Webhooks mit Retry
Paginierung Offset-basiert oder keine Cursorbasiert mit next_cursor + has_more
Rate Limiting Undokumentiert 2.000 Anfragen/Min. mit Headern in jeder Antwort
Dokumentation PDF oder veraltetes Wiki Interaktive Live-Dokumentation mit Swagger
Mandantenfähigkeit Nur ein Mandant Mandantenbezogene Abgrenzung an jedem Endpunkt

Endpunkt-Referenz

10 API-Gruppen. 25+ Endpunkte.

API-Gruppe Endpunkte
Authentifizierung POST /login, POST /refresh
Kampagnen CRUD + Start/Pause
Kontakte Hochladen, auflisten, suchen
Anrufe Verlauf, Live-Zahlen, Anruf starten
Agenten Status, SIP-Registrierung
Compliance & DNC Prüfungen vor dem Wählen, DNC-Listen
Aufzeichnungen Auflisten, signierte Wiedergabe-URLs
Berichte Export (CSV, JSON, PDF)
Webhooks Abonnieren, verwalten, verifizieren
System Health, Version

Schnellstart

Authentifizieren und loswählen in 3 API-Aufrufen

Schritt 1 Authentifizieren
POST /v1/login
Content-Type: application/json

{
  "email": "admin@yourcompany.com",
  "password": "••••••••"
}

→ Response: { "token": "eyJhbG...", "expires_in": 86400 }
Schritt 2 Kampagne anlegen
POST /v1/campaigns
Authorization: Bearer eyJhbG...

{
  "name": "Q3 Collections",
  "mode": "progressive",
  "amd_enabled": true,
  "compliance_profile": "uae-tdra"
}
Schritt 3 Kontakte hochladen und starten
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 dialing

Webhooks

Echtzeit-Ereignisse an Ihre Systeme geliefert

Webhooks liefern Ereignisse in Echtzeit an Ihre Systeme – kein Polling nötig. Jede Webhook-Payload ist signiert mit HMAC-SHA256 , sodass Sie prüfen können, dass sie von DialerBee stammt und nicht manipuliert wurde. Ist Ihr Endpunkt nicht erreichbar, wiederholen Webhooks die Zustellung mit exponentiellem Backoff bis zu 2 Stunden 35 Minuten lang, damit Ihnen kein Ereignis entgeht.

call.started

Ein neuer ausgehender Anruf wurde gestartet

call.answered

Der Empfänger hat abgenommen – inklusive AMD-Klassifizierung

call.ended

Anruf beendet, mit Dauer, Gesprächsergebnis und Aufzeichnungs-URL

call.amd_result

Ergebnis der AMD-Klassifizierung: Mensch oder Anrufbeantworter, mit Konfidenzwert

agent.state_change

Agent ist verfügbar, im Gespräch, in der Nachbearbeitung oder offline

disposition.set

Agent hat ein Gesprächsergebnis mit Resultat und Notizen erfasst

compliance.blocked

Ein Anruf wurde von der Compliance-Engine blockiert, mit Regeldetails

campaign.started

Kampagne hat mit dem Wählen begonnen

campaign.paused

Kampagne von Supervisor oder System pausiert

recording.ready

Gesprächsaufzeichnung ist verarbeitet und abspielbereit

contact.dnc_added

Ein Kontakt wurde der DNC-Sperrliste hinzugefügt

callback.scheduled

Agent hat einen Rückruf für einen Kontakt geplant

Unter der Haube

Für Entwickler, die liefern

Protokoll Nur HTTPS (TLS 1.2+)
Format JSON in Anfragen und Antworten
Authentifizierung JWT-Bearer-Tokens (24 Stunden Gültigkeit) mit Refresh
Versionierung /v1 im URL-Pfad + schema_version in Webhooks
Paginierung Cursorbasiert mit next_cursor und has_more
Rate Limiting 2.000 Anfragen/Minute pro Mandant, mit Headern
Fehlerformat RFC 7807 Problem Details für HTTP-APIs
Webhook-Signierung HMAC-SHA256-Signaturprüfung
Webhook-Wiederholungen Exponentieller Backoff (insgesamt max. 2 h 35 min)
Aufzeichnungs-URLs Signierte URLs mit 1 Stunde Gültigkeit über MinIO
DNC-Register VAE (TDRA), KSA (CST), Ägypten (NTRA), Jordanien (TRC)
SDKs JavaScript und Python (in Kürze)

Häufige Fragen zur API

Ist die API in allen Tarifen verfügbar?
Zugriff auf die REST API ist in allen Tarifen enthalten. Starter-Tarife haben einen eingeschränkten API-Umfang (bei einigen Endpunkten nur Lesezugriff). Professional- und Enterprise-Tarife bieten vollen API-Zugriff mit Schreiboperationen, Webhooks und höheren Rate Limits.
Wo finde ich die API-Dokumentation?
Die interaktive API-Dokumentation finden Sie unter app.dialerbee.com/admin/api-docs.html. Sie enthält Beschreibungen der Endpunkte, Beispiele für Anfragen und Antworten, Anleitungen zur Authentifizierung und einen Live-API-Explorer, in dem Sie Aufrufe direkt testen können.
Wie funktioniert die Webhook-Authentifizierung?
Jede Webhook-Payload enthält im Header X-Signature eine HMAC-SHA256-Signatur. Ihr Endpunkt berechnet den HMAC des unveränderten Request-Body mit Ihrem Webhook-Secret und vergleicht ihn mit der Signatur. So ist belegt, dass die Payload von DialerBee stammt und unterwegs nicht verändert wurde.
Was passiert, wenn mein Webhook-Endpunkt nicht erreichbar ist?
DialerBee wiederholt fehlgeschlagene Webhook-Zustellungen mit exponentiellem Backoff. Die Wiederholungen laufen insgesamt bis zu 2 Stunden und 35 Minuten. Sind alle Versuche ausgeschöpft, wird das Ereignis als nicht zugestellt protokolliert und ist in Ihrem Webhook-Dashboard sichtbar.
Kann ich mit der API eine eigene Agentenoberfläche bauen?
Ja. Die API stellt alle agentenbezogenen Endpunkte bereit: Statusverwaltung, Anrufsteuerung, Erfassen von Gesprächsergebnissen, Kontaktsuche und Wiedergabe von Aufzeichnungen. Zusammen mit WebSocket-Ereignissen für Echtzeit-Updates können Sie eine vollständig eigene Agentenoberfläche bauen.
Ist die API mandantenfähig?
Ja. Jeder API-Aufruf ist auf den authentifizierten Mandanten beschränkt. Partner- und Reseller-Konten können über die Partner-API mehrere Mandanten verwalten, einschließlich Provisionierung, Konfiguration und Abrechnung.
Wie hoch ist das Rate Limit?
2.000 Anfragen pro Minute und Mandant. Jede Antwort enthält die Header X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset. Wenn Sie das Limit überschreiten, erhalten Sie den Status 429 mit einem Retry-After-Header.
Gibt es SDKs?
SDKs für JavaScript und Python sind in Entwicklung. Bis dahin folgt die API gängigen REST-Konventionen mit JSON-Payloads, sodass jeder HTTP-Client in jeder Sprache funktioniert. Die interaktive Dokumentation enthält curl-Beispiele für jeden Endpunkt.

Wissen, was Sie abonnieren können

Jedes Ereignis ist dokumentiert, bevor Sie entwickeln

Die Plattform veröffentlicht für alles, was bei einem Anruf wichtig ist, ein Ereignis, und jedes ist mit seiner Payload-Struktur katalogisiert. So wissen Sie, was ein Webhook enthält, bevor Sie den Handler schreiben, statt das Schema aus dem ersten eintreffenden Ereignis abzuleiten.

Anruflebenszyklus, Kampagnenstatus, Agentenaktivität, Gesprächsergebnis, Verfügbarkeit von Aufzeichnungen, Compliance-Entscheidungen und Nachrichtenzustellung veröffentlichen jeweils eigene Ereignisse. Abonnieren Sie die, die für Ihre Integration relevant sind, und ignorieren Sie den Rest – Sie müssen keinen kompletten Datenstrom verarbeiten, nur um die drei Ereignisse zu bekommen, die Sie brauchen.

Bereit für die Integration?

Erkunden Sie die Live-API-Dokumentation oder buchen Sie eine Demo und erhalten Sie API-Zugang. Bauen Sie Ihre erste Integration in Stunden, nicht in Wochen.

14-tägige kostenlose Testphase · kostenloses KI-Guthaben · keine Kreditkarte · Preise ansehen

Vollständige Website auf Englisch ansehen →