Schnittstelle (HTTP), Konsole und Plugins

Namensabfrage /lookup

GET /lookup?number=+4930123456                  Header X-Api-Key: <Schlüssel>
  → 200, Text: "Musterfirma AG - Frau Beispiel"   (leer, wenn unbekannt)
GET /lookup?number=…&format=json
  → {"found":true,"name":"…","phone":"+4930123456","url":"…","source":"CRM"}
GET /lookup?number=…&format=xml
  → <lookup found="true"><name>…</name><phone>…</phone></lookup>
GET /lookup?number=…&format=yealink|snom       → XML-Telefonbuch

curl -H "X-Api-Key: API-KEY" "http://192.168.10.5:8080/lookup?format=json&number=%2B49301234560"

Jede Schnittstelle hat einen eigenen API-Key; CallerHub beantwortet die Anfrage mit den Datenquellen dieser Schnittstelle. Antworten sind UTF-8.

Anrufe melden: /event und /cdr

…/event?apikey=API-KEY&event=incoming&callid=4711&number=07111234567&called=0711999200
…/event?apikey=API-KEY&event=answered&callid=4711&extension=201
…/event?apikey=API-KEY&event=ended&callid=4711&duration=95

Ereignisse mit derselben callid bilden einen Anruf. Parameter: event (auch type, direction oder die Buchstaben I, O, R, C, A, E), number, called, extension, user, name. GET und POST mit Formulardaten werden angenommen; die Antwort lautet 200 OK. Es gelten die erlaubten IP-Adressen der Schnittstelle.

CSV-Aufbau der Verbindungsdaten

Start;Direction;From;To;Extension;Answered;Wait;Duration
2026-10-16 09:12:05;incoming;+49711456789;200;201;yes;8;00:03:41
2026-10-16 09:15:40;incoming;+4930123456;200;;no;35;0

Netzwerkverbindungen und Ports

CallerHub baut nur die Verbindungen auf, die Sie einrichten. Es gibt keine Verbindung zum Anbieter.

Plugin-Schnittstelle

Ein Plugin ist eine .NET-Klassenbibliothek für netstandard2.0 mit einem Verweis auf Plugins\CallerHub.Plugins.dll. Sie implementiert ICallerHubPlugin mit den Eigenschaften id, name, description, settingsExample und den Methoden configure und process.

' MeinPlugin.vb – dotnet new classlib -lang VB -f netstandard2.0 -n MeinPlugin
Public Function process(callInfo As PluginCall) As PluginResult Implements ICallerHubPlugin.process
    If callInfo.calledNumber <> "200" OrElse String.IsNullOrEmpty(callInfo.displayName) Then Return Nothing
    Return New PluginResult With {.displayName = callInfo.displayName & suffix, .note = "Zentrale"}
End Function

Die DLL kommt in den Ordner Plugins; danach unter Administration → Modul: Plugins „Neu laden“ wählen und das Plugin einschalten. Optional lädt CallerHub nur Plugins mit gültiger Authenticode-Signatur. Das vollständige Beispiel steht in der Hilfe.