Overview
phonebridge is your single door to tons of CRM integrations for you as a PBX provider:
- Bitrix24
- DATEV
- DocBee
- Google Kontakte / Contacts
- Google G Suite
- Google Workspace
- HubSpot
- Microsoft Active Directory
- Microsoft Outlook
- Microsoft Office 365
- Microsoft 365
- Microsoft Exchange
- Microsoft Dynamics 365
- salesforce
- SugarCRM
- SuiteCRM
- weclapp
- Zendesk
- Zoho
- ...and many more
"CRM integration" means to provide:
* Click to dial
* CRM screen pop on incoming call
* Sync CRM contacts to PBX phonebook (=resolve caller names / click to dial for connected devices)
Partner programs for PBX providers
If you want to offer such integrations your own customers and partners, you can choose between our partner programs:
* Affiliate: You promote phonebridge to your customers and get a recurring commission. We charge your customers directly.
* Distributor: You sell phonebridge in your shop or marketplace to your customers. We charge you, you charge your customers.
* Integrator (OEM/whitelabel): You integrate phonebridge technology directly into your product or offer phonebridge apps with your own branding. We charge you, you charge your customers.
Preparation
- Create your personal free test account at https://app.phonebridge.io/common/register.jsp?brand=pb&language=en.
- Write a short email to service@phonebridge.io with your login email address so you can use your test account for free for unlimited time (not just 14 days).
phonebridge CLIENT
Features
* CRM screen pops: opens default browser with special URL to show CRM search results by caller number (example: https://www.any-crm.com/search/#tel#; '#tel#' will be replaced by caller number by phonebridge CLIENT)
* Click to dial: user can select any phone number in any Windows application by mouse, hit keyboard shortcut and phonebridge CLIENT initiates and outgoing call.
* Resolve caller name (work in progress): Lookup caller name on phonebridge LDAP server (connected to any CRM via phonebridge CONTACTS).
Operating systems
Full features:
* Microsoft Windows >= 7 (32 or 64 bits)
* Microsoft Server >= 2013 (32 or 64 bits) (also with remote desktop/terminal server role)
Limited features (currently only CRM screen pops):
* Any operating system with Google Chrome like any Windows, Mac and Linux
Installation (Windows)
phonebridge CLIENT comes as a simple to distribute .msi file for Windows.
Most recent version can be found at https://support.phonebridge.io/hc/de/articles/360012886519-phonebridge-CLIENT-einrichten (English version is work in progress).
Configuration
phonebridge CLIENT's configuration is saved as simple XML file %APPDATA%\phonebridge CLIENT\user.config. Example content:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<userSettings>
<DatevConnector.GUI.Properties.Settings>
<setting name="UseTapiLine" serializeAs="String">True</setting>
<setting name="ResetCallTimeOnTransfer" serializeAs="String">False</setting>
<setting name="SettingsNeedUpgrade" serializeAs="String">False</setting>
<setting name="AutoSendCallOnlyOnSddMatch" serializeAs="String">False</setting>
<setting name="UseWebhook" serializeAs="String">False</setting>
<setting name="enableOpenURLOutgoing" serializeAs="String">False</setting>
<setting name="StarfaceLogin" serializeAs="String"></setting>
<setting name="WebhookAPIKEY" serializeAs="String">XXX</setting>
<setting name="Lcode" serializeAs="String"></setting>
<setting name="CRM" serializeAs="String">Browser</setting>
<setting name="StarfacePort" serializeAs="String">5222</setting>
<setting name="onlyCRMNotification" serializeAs="String">False</setting>
<setting name="CountryPrefix" serializeAs="String">+49</setting>
<setting name="BindingKey" serializeAs="String"></setting>
<setting name="HttpsPort" serializeAs="String">443</setting>
<setting name="UseStarfaceConnection" serializeAs="String">False</setting>
<setting name="PrioritizeSdd" serializeAs="String">True</setting>
<setting name="DialPrefix" serializeAs="String"></setting>
<setting name="Amts" serializeAs="String"></setting>
<setting name="OpenCallWindow" serializeAs="String">True</setting>
<setting name="openPbContacts" serializeAs="String">False</setting>
<setting name="AutoSendCallOnlyOnExternal" serializeAs="String">False</setting>
<setting name="StarfacePassword" serializeAs="String"></setting>
<setting name="UseFritzBox" serializeAs="String">False</setting>
<setting name="MeineNUM" serializeAs="String">+4922199980XXX</setting>
<setting name="UseDATEV" serializeAs="String">False</setting>
<setting name="ClientID" serializeAs="String">C9IGPU878R1XXX</setting>
<setting name="openURL" serializeAs="String">True</setting>
<setting name="urlToOpen" serializeAs="String">http://XXX</setting>
<setting name="AutoSelectFirstContact" serializeAs="String">True</setting>
<setting name="ConnectorId" serializeAs="String"></setting>
<setting name="FritzBoxURL" serializeAs="String">fritz.box</setting>
<setting name="StarfaceAddress" serializeAs="String"></setting>
<setting name="OpenCallWindowOnAnswer" serializeAs="String">False</setting>
<setting name="SelectedTapiLine" serializeAs="String">XXX</setting>
<setting name="AutoSendCallToDatev" serializeAs="String">False</setting>
<setting name="countryCode" serializeAs="String">DE</setting>
<setting name="IgnoreInternalCalls" serializeAs="String">False</setting>
<setting name="AutoSendCallOnlyOnAnswered" serializeAs="String">False</setting>
<setting name="ShowBrowserPopupOnIncomingCall" serializeAs="String">True</setting>
<setting name="PBX" serializeAs="String">TAPI</setting>
<setting name="AllowSendingFromCallWindow" serializeAs="String">True</setting>
<setting name="CallURL" serializeAs="String"></setting>
<setting name="pbWebhookServer" serializeAs="String">pb-webhook.phonebridge.io</setting>
<setting name="deviceID" serializeAs="String">XXX@fpbx.de</setting>
<setting name="openURLSilent" serializeAs="String">False</setting>
<setting name="prefix" serializeAs="String">+</setting>
</DatevConnector.GUI.Properties.Settings>
</userSettings>
</configuration>
The phonebridge CLIENT needs a manual application restart after config changed.
Multilanguage
phonebridge CLIENT comes with a plain text file for every language provided. [work in progress]
Call Notify APIs
phonebridge CLIENT reacts to basic call events like RINGING, CONNECTED, HANGUP.
You can choose one of these protocols via phonebridge CLIENT configuration:
Webhook
Receive
When choosing "webhook" as PBX call protocol, phonebridge CLIENT connects to a central phonebridge webhook server via WebSocket protocol. The phonebridge webhook server redirects all call events received via WebSocket to phonebridge CLIENT. As phonebridge CLIENT connects to external webhook server (encrypted communication to TCP Port 443), there are no firewall problems to expect.
Any PBX or device (softphone, hardphone, DECT manager) may send call events so phonebridge CLIENT reacts.
For example, a Yealink hardphone can use this action URL when receiving an incoming call to notify phonebridge CLIENT:
https://pb-webhook.phonebridge.io/call-notify/yealink/v1/<your phonebridge webhook API key>?from=$remote&to=<your phone number>&call_id=$call_id
Other IP hardphone related tutorials for sending call events can be found here (English version is work in progress).
phonebridge CLIENT as a webhook receiver reacts when the configured "your phonebridge webhook API key" (a random string like AB20375HJKSDH) and "your phone number" (like +4923648873300) do match with the same parameters sent by the webhook sender.
You can use our general existing webhook server endpoint when sending your PBX call events to phonebridge webhook server like:
https://pb-webhook.phonebridge.io/call-notify/asterisk/v1/<your phonebridge webhook API key>?from=<your caller number in format +4923648873300>}&to=<your called number in format +4923648873300>&event_type=<your call event type like 'IncomingCall', 'OutgoingCall', 'CallAccepted' or 'HungUp'>&call_id=<your unique call ID>&areacode=<your optional area code like '0'>
Or we will create a new endpoint for your PBX on our webhook server which matches your existing webhook sender API.
Send
phonebridge CLIENT will initiate a webhook call on your PBX server (or compatible IP hardphone) to initiate an outgoing call when using the hotkey feature ("click to dial").
You can configure the URL to call. Example:
https://api.your-great-pbx.com/v1/<your API key/click2dial/Direct?a_destination=<your phone number>&b_destination=#tel#
phonebridge CLIENT will replace '#tel' by the telephone number selected to be dialed by user.
TAPI
phonebridge CLIENT can connect to any local 1st party TAPI line which is installed on local operating system.
All basic call events are supported.
Proprietary
phonebridge CLIENT supports some proprietary call protocols like "AVM FritzBox" to receive limited call event types ("IncomingCall")
SIP
If no other protocols are available to connect to PBX server, central phonebridge voice server registers as a SIP device on your PBX server with your SIP credentials provided. This SIP device should be configured for parallel ringing. phonebridge CLIENT is informed about an incoming call (no other call event types technically possible) via webhook.
Licensing
The phonebridge CLIENT is licensed per user. Technically the license is bound to a random hardware ID generated by phonebridge CLIENT.
The license is called "phonebridge CLIENT ID" (a random text string with letters from A-Z and numbers from 0-9). The CLIENT ID can be generated by phonebridge Dashboard (navigate to CLIENT -> New CLIENT) or by API (see https://support.phonebridge.io/hc/de/articles/360011624819-phonebridge-API -> scroll to "CLIENT API").
The CLIENT ID can be configured for phonebridge CLIENT via user.config or via UI (see first tab).
License activation
phonebridge CLIENT reports hardware ID and CLIENT ID to phonebridge license server on application start which returns license check result. phonebridge license server stores combination of CLIENT ID and hardware ID on first check.
If hardware ID changed for given CLIENT ID, the CLIENT ID must be removed and recreated manually via phonebridge dashboard or API.
Branding
As a PBX vendor you can request a phonebridge CLIENT .msi file which matches your company's corporate design. Custom design parameters can be:
* Application name
* Vendor name
* Application logo
* Tray icon
* EULA
* Call protocols available
phonebridge CONTACTS
Documentation for PBX vendors still in progress. Topics to come:
Features
* Sync contacts to PBX phonebook (hourly) via PBX phone book API
* Provide contacts via phonebridge LDAP server
= resolve caller name with PBX / softphone / hardphone
= click to dial via connected PBX phone
API
* Full API (create/delete) see https://support.phonebridge.io/hc/de/articles/360011624819-phonebridge-API -> scroll to "Full API"
Frontend (optional)
* Branding by URL parameter (?brand=pb)
- colors
- logo
- UI restrictions
* Language by URL parameter (?lang=en)