API & Webhooks

Produktionsreife API. Keine Roadmap-Folie.

Mehr als 25 REST-Endpunkte, Echtzeit-Webhooks, JWT-Authentifizierung und interaktive Dokumentation. Alle Funktionen der Benutzeroberfläche sind auch über die API verfügbar.

Kurze Antwort

Was ist die DialerBee-API? DialerBee bietet eine produktionsreife REST-API mit über 25 Endpunkten für Kampagnen, Kontakte, Anrufe, Agenten, Compliance, Aufzeichnungen, Berichte und Webhooks. Die Authentifizierung erfolgt über JWT-Bearer-Token mit einer Gültigkeit von 24 Stunden. Die API unterstützt cursorbasierte Paginierung, gibt RFC-7807-Fehlerantworten zurück und beschränkt die Anzahl der Anfragen auf 2.000 pro Minute und Mandant. Echtzeit-Webhooks übermitteln Ereignisse (z. B. Anruf gestartet, Anruf beantwortet, Anruf-Ergebnis, Disposition festgelegt, Compliance blockiert) mit HMAC-SHA256-Signaturprüfung und exponentiellem Wiederholungs-Backoff. Die interaktive API-Dokumentation finden Sie unter dialer.broadnet.me/admin/api-docs.html.

Das Problem

Die meisten Dialer-APIs sind ein nachträglicher Gedanke

Sie haben einen Dialer gekauft, um Anrufe zu tätigen. Jetzt müssen Sie ihn in Ihr CRM integrieren, Daten in Ihr Data Warehouse übertragen, Workflows durch Anrufereignisse auslösen und benutzerdefinierte Dashboards erstellen. Sie prüfen die API-Dokumentation des Anbieters und finden … ein PDF aus dem Jahr 2019 mit sechs undokumentierten Endpunkten, keinen Webhooks und einer SOAP-Schnittstelle.

Das ist die Realität für die meisten Outbound-Teams. Der Dialer funktioniert einwandfrei zum Tätigen von Anrufen, aber sobald man … Darauf aufbauen — Wenn Sie Dispositionen mit Salesforce synchronisieren, Tickets in Zendesk automatisch erstellen, Analysen an Ihr BI-Tool übertragen oder eine benutzerdefinierte Agentenschnittstelle erstellen möchten — sind Sie auf CSV-Exporte und manuelle Prozesse angewiesen.

DialerBee wurde mit einem API-First-Ansatz entwickelt. Jede Funktion der Benutzeroberfläche basiert auf derselben REST-API, die Sie von Ihren eigenen Systemen aus aufrufen können. Die API ist kein nachträglich hinzugefügtes Element – sie bildet das Fundament der gesamten Plattform.

6
Typische Anbieter-Endpunkte
undokumentiert, keine Webhooks
SEIFE
Legacy-Protokoll
Viele Dialer verwenden immer noch XML/SOAP.
CSV
Integration nur für den Export
manuelle Dateiübertragungen, keine Echtzeit

So funktioniert es

API-First von Grund auf

Die DialerBee-API folgt den REST-Konventionen mit JSON-Nutzdaten, Standard-HTTP-Methoden und RFC-7807-konformen Fehlerantworten. Die Authentifizierung erfolgt über JWT-Bearer-Token, die über einen Login-Endpunkt abgerufen werden und eine Gültigkeitsdauer von 24 Stunden sowie die Möglichkeit zur Token-Aktualisierung bieten. Jede API-Antwort enthält Header zur Ratenbegrenzung, sodass Ihre Integration die Übertragungsrate automatisch drosseln kann.

Schritt 01

Authentifizieren

Senden Sie Ihre Anmeldeinformationen per POST an /v1/login. Sie erhalten ein JWT-Bearer-Token, das 24 Stunden gültig ist. Verwenden Sie die Token-Aktualisierung für länger laufende Integrationen.

Schritt 02

Anrufendpunkte

Über 25 RESTful-Endpunkte für Kampagnen, Kontakte, Anrufe, Agenten, Compliance, Aufzeichnungen und Berichte. JSON-Ein- und Ausgabeformat.

Schritt 03

Webhooks empfangen

Registrieren Sie Webhook-URLs, um Echtzeitereignisse zu empfangen. Jede Nutzlast ist mit HMAC-SHA256 signiert, sodass Sie die Authentizität überprüfen können.

Schritt 04

Fehlerbehandlung

RFC 7807-Problemdetails für jeden Fehler. Ratenbegrenzungs-Header in jeder Antwort. Status 429 mit Hinweisen zum nächsten Wiederholungsversuch.

Direkter Vergleich

DialerBee API vs typische Dialer-APIs

Fähigkeit Typische Dialer-API DialerBee-API
Endpunkte 5-10, teilweise dokumentiert Mehr als 25 vollständig dokumentierte Funktionen mit OpenAPI-Spezifikation
Protokoll SOAP/XML oder proprietäre REST mit JSON, RFC 7807-Fehler
Authentifizierung API-Schlüssel (läuft nie ab) JWT mit 24 Stunden Gültigkeit + Token-Aktualisierung
Echtzeitereignisse Umfrage oder keine HMAC-SHA256-signierte Webhooks mit Wiederholungsfunktion
Pagination Offset-basiert oder keine Cursorbasiert mit next_cursor + has_more
Ratenbegrenzung Undokumentiert 2.000 Anfragen/Minute mit Headern in jeder Antwort
Dokumentation PDF oder veraltetes Wiki Live-interaktive Swagger-Dokumente
Mehrmieter Nur für Einzelmieter Mandantenspezifische Bereichsbegrenzung für jeden Endpunkt

Endpunktreferenz

10 API-Gruppen. 25+ Endpunkte.

API-Gruppe Endpunkte
Authentifizierung POST /login, POST /refresh
Kampagnen CRUD + Start/Pause
Kontakte Hochladen, auflisten, suchen
Anrufe Geschichte, Leben zählt, Ursprung
Agenten Staat, SIP-Registrierung
Compliance & DNC Vorwahlprüfungen, DNC-Listen
Aufnahmen Liste, signierte Wiedergabe-URLs
Berichte Export (CSV, JSON, PDF)
Webhooks Abonnieren, verwalten, überprüfen
System Gesundheit, Version

Schnellstart

Authentifizieren und wählen in 3 API-Aufrufen

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

{
  "E-Mail": "admin@yourcompany.com",
  "Passwort": "••••••••"
}

→ Antwort: { "Token": "eyJhbG...", "expires_in": 86400 }
Schritt 2 Kampagne erstellen
POST /v1/campaigns
Autorisierung: Inhaber eyJhbG...

{
  "Name": "Q3-Kollektionen",
  "Modus": "progressiv",
  "amd_enabled": true,
  "Compliance-Profil": "uae-tdra"
}
Schritt 3 Kontakte hochladen und loslegen
POST /v1/campaigns/{id}/contacts
Content-Type: multipart/form-data

→ CSV-Datei mit Telefonnummer, Name und benutzerdefinierten Feldern hochladen

POST /v1/campaigns/{id}/start
→ Die Kampagne wählt jetzt.

Webhooks

Echtzeitereignisse an Ihre Systeme geliefert

Webhooks übermitteln Ereignisse in Echtzeit an Ihre Systeme – ein regelmäßiges Abfragen ist nicht erforderlich. Jede Webhook-Nutzlast ist signiert. HMAC-SHA256 So können Sie überprüfen, ob die Nachricht von DialerBee stammt und nicht manipuliert wurde. Falls Ihr Endpunkt nicht erreichbar ist, werden Webhooks mit exponentiellem Backoff bis zu 2 Stunden und 35 Minuten lang wiederholt, sodass Sie kein Ereignis verpassen.

Anruf gestartet

Ein neuer ausgehender Anruf wurde initiiert.

Anruf angenommen

Der Empfänger nahm den Artikel entgegen – inklusive AMD-Klassifizierung.

Anruf beendet

Anruf abgeschlossen mit Dauer, Ergebnis und Aufzeichnungs-URL

call.amd_result

AMD-Klassifizierungsergebnis: Mensch oder Maschine, mit Konfidenzwert

Agentenstatusänderung

Der Agent war verfügbar, auf Abruf, im Abschlussmodus oder offline.

disposition.set

Der Agent reichte einen Abschlussbericht mit Ergebnis und Vermerken ein.

Compliance blockiert

Ein Anruf wurde von der Compliance-Engine anhand von Regeldetails blockiert.

Kampagne gestartet

Die Kampagne hat begonnen, Anrufe zu tätigen

Kampagne pausiert

Kampagne vom Vorgesetzten oder System pausiert

Aufnahme bereit

Die Anrufaufzeichnung wurde verarbeitet und steht zur Wiedergabe bereit.

contact.dnc_added

Ein Kontakt wurde zur DNC-Sperrliste hinzugefügt.

Rückruf geplant

Der Agent hat einen Rückruf für einen Kontakt vereinbart.

Unter der Motorhaube

Entwickelt für Entwickler, die ausliefern

Protokoll Nur HTTPS (TLS 1.2+)
Format JSON-Anfrage- und Antwortkörper
Authentifizierung JWT-Bearer-Token (24 Stunden Gültigkeit) mit Aktualisierung
Versionierung /v1 URL-Pfad + Schemaversion in Webhooks
Pagination Cursorbasiert mit next_cursor und has_more
Ratenbegrenzung 2.000 Anfragen/Minute pro Mandant mit Headern
Fehlerformat RFC 7807 Problemdetails für HTTP-APIs
Webhook-Signatur HMAC-SHA256-Signaturprüfung
Webhook-Wiederholungsversuche Exponentieller Backoff (maximal 2 Stunden 35 Minuten insgesamt)
Aufzeichnungs-URLs Signierte URLs mit einer Gültigkeitsdauer von 1 Stunde über MinIO
DNC-Register VAE (TDRA), KSA (CITC), Ägypten (NTRA), Jordanien (TRC)
SDKs JavaScript und Python (demnächst verfügbar)

Häufig gestellte Fragen zur API

Ist die API in allen Tarifen verfügbar?
Der Zugriff auf die REST-API ist in allen Tarifen enthalten. Starter-Tarife bieten einen eingeschränkten API-Umfang (einige Endpunkte sind nur lesbar). Professional- und Enterprise-Tarife beinhalten vollen API-Zugriff mit Schreibvorgängen, Webhooks und höheren Ratenlimits.
Wo finde ich die API-Dokumentation?
Die interaktive API-Dokumentation finden Sie unter dialer.broadnet.me/admin/api-docs.html. Sie enthält Endpunktbeschreibungen, Beispiele für Anfragen und Antworten, Anleitungen zur Authentifizierung sowie einen Live-API-Explorer, mit dem Sie Aufrufe direkt testen können.
Wie funktioniert die Webhook-Authentifizierung?
Jede Webhook-Nutzlast enthält eine HMAC-SHA256-Signatur im X-Signature-Header. Ihr Endpunkt sollte den HMAC des Rohdaten-Anfragetextes mithilfe Ihres Webhook-Geheimnisses berechnen und mit der Signatur vergleichen. Dadurch wird sichergestellt, dass die Nutzlast von DialerBee stammt und während der Übertragung nicht verändert wurde.
Was passiert, wenn mein Webhook-Endpunkt nicht erreichbar ist?
DialerBee wiederholt fehlgeschlagene Webhook-Zustellungsversuche mit exponentiellem Backoff. Die Wiederholungsversuche dauern maximal 2 Stunden und 35 Minuten. Nach Abschluss aller Versuche wird das Ereignis als nicht zugestellt protokolliert und in Ihrem Webhook-Dashboard angezeigt.
Kann ich die API verwenden, um eine benutzerdefinierte Agentenschnittstelle zu erstellen?
Ja. Die API stellt alle agentenbezogenen Endpunkte bereit: Statusverwaltung, Anrufsteuerung, Statusmeldung, Kontaktsuche und Wiedergabe von Aufzeichnungen. In Kombination mit WebSocket-Ereignissen für Echtzeitaktualisierungen können Sie ein vollständig individualisiertes Agentenerlebnis gestalten.
Ist die API mandantenfähig?
Ja. Jeder API-Aufruf ist auf den authentifizierten Mandanten beschränkt. Partner-/Reseller-Konten können mehrere Mandanten über die Partner-API verwalten, einschließlich Mandantenbereitstellung, -konfiguration und Abrechnungsmanagement.
Wie hoch ist die Ratenbegrenzung?
Pro Mandant sind 2.000 Anfragen pro Minute zulässig. Jede Antwort enthält die Header „X-RateLimit-Limit“, „X-RateLimit-Remaining“ und „X-RateLimit-Reset“. Bei Überschreitung des Limits erhalten Sie den Statuscode 429 mit dem Header „Retry-After“.
Sind SDKs verfügbar?
JavaScript- und Python-SDKs sind in Entwicklung. Bis dahin verwendet die API Standard-REST-Konventionen mit JSON-Nutzdaten, sodass jeder HTTP-Client in jeder Programmiersprache funktioniert. Die interaktive Dokumentation enthält curl-Beispiele für jeden Endpunkt.

Bereit zur Integration?

Entdecken Sie die Live-API-Dokumentation oder buchen Sie eine Demo und erhalten Sie API-Zugriff. Erstellen Sie Ihre erste Integration in Stunden, nicht in Wochen.

View full site in English →