Page tree
Skip to end of metadata
Go to start of metadata

Before you select SuiteCRM as your CRM on the PBX, you should install the module on SuiteCRM following this guide

  • Navigate the the CRM module from within your PBX under the settings section

  • CRM Type - From the drop down pick the Sugar/Suite CRM option

  • PBX URL - Provide the URL for your PBX.  This is a IP Address or FQDN of your PBX that the CRM will need to communicate with.

  • CRM Configured - Please select the type of CRM you are configuring(Sugar/Suite).
  • CRM Version - This is require only for SugarCRM as there is a difference in module zip file generated for SugarCRM version above 8.0 and prior 8.0.

  • CRM URL - Provide the URL for your CRM Server.  This is a IP Address or FQDN of your CRM that the PBX will need to communicate with.

  • CRM Username and Password Fields - You will need to create a admin user with full permissions in your CRM and provide the username and password here.


  • Recording Storage - Here you can pick from 2 modes on how you want to handle linking Call Recordings from the PBX
    • CRM - In CRM mode anytime a call recordings is made on the PBX after the call is completed a copy of the recording will be sent to the CRM and stored on the CRM and from within the CRM when viewing call records you can listen to the call recording.  If the call recordings is deleted from the PBX a copy will still exist on your CRM.  Requires enough storage on your CRM to handle the call recording volume that you will be sending it.
    • PBX - In PBX mode a copy of a call recordings will not be sent to the CRM but you will still be able to listen to any call recordings from within the call records on your CRM.  The downside is if the call recordings is deleted from the PBX you will no longer be able to listen to the recording.


  • If you choose CRM mode above you will need to provide more information as outlined below.
    • SSH Username& Public Key- You will need to create a SSH user on your CRM server and setup the Public key below on the server (instructions).
    • Remote Storage Path - Path where the SSH user has access to store the Call recordings.
    • Copy Voicemail - If set to yes a copy of every voicemail when left on the PBX will also be sent to the CRM and linked to the call records with the ability to listen to the voicemails in the CRM.  If set to No voicemails will not be sent to the CRM.


  • Regular Expression Number MatchRegular expression used to match and cleanup numbers coming from the PBX before being sent to the CRM for relationship matching. This helps to match numbers that come into the PBX such as '19991234567' and turns them into '9991234567' since the number in your CRM may be stored as 10 digit versus 11 digit.  

  • Regular Expression Digit MatchRegular expression used PER digit for Accounts/Numbers/Leads lookups. %digit% is replaced with each digit of the inbound number. This expression is repeated for every digit of the number. This expression helps to match numbers that are in the CRM for relationship matching in various formats such as '+1 (444) 123-4567 '


  • SugarCRM/SuiteCRM Module Download - Link to download the module that has to be installed on your CRM to communicate with your PBX.  Please download it here for SugarCRM prior to v8.0 or download it here for SugarCRM v8.0 or above. And follow your CRM manufacture instructions on how to install the module on your CRM

  • Submit your changes when done.

Now, you must match your users from the PBX to SugarCRM/SuiteCRM users.

Go to Admin > User Management > Edit the user you want to match, go to CRM tab and match your PBX user with your SugarCRM/SuiteCRM user.

Additionally, if you use Zulu, you can choose to use "On Call Popup" option under your Inbound route or your queues.

Go to Connectivity > Inbound Routes > Select your route > Zulu Tab

Or Applications > Queues > Edit your Queue > Zulu Tab

  • No labels