CallerHub
EN
Download

Interface and network

What administrators need for the setup. The examples use 192.168.10.5 as the CallerHub server, port 8080 and the placeholder API-KEY.

Lookup URL for the phone system

The phone system calls this address on every call and receives the name in return. Each interface has its own API key; CallerHub answers the request using that interface's data sources.

http://192.168.10.5:8080/lookup?apikey=API-KEY&number=040 66969000
  → Becker & Partner - Laura Becker   (empty if unknown)

The right address for each system is on the phone systems page; “Copy guide” in CallerHub provides it with the real API key. Instead of the apikey parameter, the key can also be sent in the X-Api-Key header; it then does not appear in proxy logs.

Response codes

CodeMeaning
200Name found (empty for an unknown number)
401API key or access key wrong or missing
403IP address not allowed for this interface
404unknown path or module switched off
405wrong HTTP method
429temporarily locked after too many wrong keys
503no data source ready or phone number list not yet loaded

More help with troubleshooting: common connection errors.

Network connections and ports

CallerHub only establishes the connections you set up. It sends no call or personal data to the provider; it connects to callerhub.de only for the update check and, with its own licence key or a trial, for the licence revocation list and the online licence check.

ConnectionDirectionPort (example)ContentWhen
Phone system → CallerHubinbound8080 HTTP / 8443 HTTPSPhone number, optionally called number and user, API key → name, optionally linkper call
CallerHub → SQL databaseoutbound1433, 1521, 3306, 5432Sign-in, SELECTlist at interval or per call
CallerHub → LDAP/ADoutbound389 / 636Sign-in, searchat interval
CallerHub → Microsoft 365, EWS, RESToutbound443Token request, retrieval of contactsat interval or per call
CallerHub → SMTP / webhookoutbound587 / 465 / 25, 443Failure and recovery, reports; no phone numberson failure or as scheduled
Browser / monitoring → CallerHubinboundsame as interfaceStatistics, call analytics, monitoring with access keyon access
Phones → LDAP phone bookinbound389 / 636Name and reverse searchper search
Live reception of call recordsinbound or outbound5100, 5101, 5038, 1080, 1012 or 443Call records per callcontinuous or at interval
CallerHub → callerhub.deoutbound443Query for the latest version, download of the program file; with its own licence key the signed licence revocation liston “Check for updates” or update; revocation list once a day
CallerHub → STARFACE (REST)outbound443Contacts into its own STARFACE address booknightly, after reload, on demand
Mitel phones → CallerHubinboundHTTP, TFTPConfiguration files, display pageswhen the phone starts, on request
CallerHub → nuget.orgoutbound443Download of the Oracle driveronly if the driver is missing and you confirm
Network discoveryoutboundincl. 1433, 1521, 3306, 5432, 389, 636, 5060, 1012; UDP 1434, 1900Connection attempt without sign-inonly after an explicit start
Diagram: STARFACE Cloud reaches CallerHub through the firewall via HTTPS 8443, CallerHub reads the SQL Server on the internal network.
Example A: STARFACE Cloud, database on your own network. Inbound only port 8443 from STARFACE.
Diagram: 3CX or Asterisk on your own network queries CallerHub via HTTP 8080, CallerHub reads Active Directory via LDAPS and a CSV file via SMB.
Example B: phone system on your own network with Active Directory and CSV file (diagrams in German).

Further interfaces

  • Browser access: statistics and call analytics in the browser, redirect to the CRM record for CTI pop-ups – with its own access key.
  • Monitoring: Nagios, Icinga, Checkmk, PRTG, Zabbix, Prometheus and Grafana – with its own monitoring key.
  • Call records and call events from phone systems and your own scripts.
  • Plugins: your own extensions that run on every call.

Technical details of these interfaces (endpoints and parameters, console commands, plugin and event interface) are available on request from support: info@callerhub.de.