This knowledge base will soon be replaced with
To ensure continued access to our resources, update your bookmarks or links to

CRM Integration Administration Guide ( Deprecated )

Edited: 11/03/2023
Access: Everyone
Supports: Business Voice, Business Voice+

Note: This product has been deprecated and is no longer sold. 

General Overview

CRM Integration is our custom solution to integrate your Sangoma Business Voice & Business Voice+ communications capabilities with your CRM of choice. Salesforce is the only supported CRM at this time, but we will be expanding support for other CRMs in the future.

CRM Integration consists of two different functions:

  1. Screen Pop: An interactive caller ID that sources data from your CRM and allows you to quickly jump to a CRM record from your desktop during a call.
  1. Call Activity Logging: A service that automatically logs call details into your CRM as call activity occurs.

CRM Integration has two kinds of users:

  1. Administrators: These users set up and configure CRM Integration for all end users of the customer.
  1. End Users: These users utilize Screen Pop on their computers during their day-to-day activities.

Connecting your CRM to CRM Integration

Your CRM must be connected to Sangoma’s CRM Integration service in order for CRM Integration to work. To do this:

  1. Goto
  1. Login using your Sangoma portal credentials
  1. In the Select Connection section, click the “Add a New Connection” button.
  1. Missing image link-1
  1. In the portal that launched, click the Choose Provider dropdown and select your CRM of choice.

Missing image link-2

  1. Click the Next button.
  1. In the Policy section, click the Choose Policy dropdown and select your CRM environment of choice. Missing image link-3
  1. Click the Create button.
    1. Some CRMs, such as Salesforce, provide access to multiple environments so that CRM developers can test changes without affecting day-to-day business. If you would like to connect a testing environment, you can do so here.

Missing image link-4

  1. When your CRM asks you to grant access to Sangoma’s CRM Integration service, allow us this access.

You can revisit this section at any time to add a new CRM profile. You can add as many profiles as you’d like, but only one can be active at any given time.

Set Up Call Activity Logging

Call Activity Logging is enabled or disabled via the checkbox in this section:

  1. If the box is checked, call logging will be enabled for the entire organization.
  1. If it is unchecked, call logging will be disabled for the entire organization. Screen Pops will still appear if call logging is disabled.

Configure Screen Pop

You can configure Screen Pop by changing the following options:

  1. Call Matching Search: This allows you to select which CRM object will be searched against to find matches during incoming and outgoing calls.
  1. CRM Object URLs: This is where you’ll put the formulaic URL your CRM uses for opening and creating new objects. Where the CRM inserts a unique ID, please insert the text.
    1. For example, if your URL is normally, please type the URL as
    1. It is required that you fill out this field in order for Screen Pop to function.
  1. Incoming Calls: This is where you’ll configure how Screen Pop behaves for incoming calls.
    1. On Answer / On Ring: If you select On Answer, screen pops will not appear until the end user answers the call. If you select On Ring, screen pops will appear as soon as the end user’s phone starts ringing.
    1. Dismiss after ringing stops if the call is not answered: If this option is enabled, screen pop notifications will automatically close themselves if the end user didn’t answer the call.
      1. In a calling environment where multiple phones ring on an incoming call, this option is useful to prevent non relevant notifications from appearing for end users who didn’t answer a particular call.
  1. Outgoing Calls: This is where you’ll configure how Screen Pop behaves for outgoing calls.
    1. On Dial / On Connect: If you select On Dial, screen pops will appear as soon as an end user completes a dial-out and the phone starts ringing. If you select On Connect, screen pops will not appear until the other party answers the call.
    1. Close in 60 seconds after call if user takes no action: If this option is enabled, screen pop notifications will automatically close themselves 60 seconds after a call is over if the user never clicked an option on that notification.

Missing image link-5

Missing image link-6 CRM Specific Instructions to get CRM Object URLs

We currently support Accounts, Contacts, Leads, and Case objects

  1. To retrieve the New Object URL login to Salesforce
  1. Select the desired item tab that you want to match, Example: Contacts.
  1. Click on the New button
  1. You should see a "New Contact" form on screen
  1. Copy the URL from the address bar starting on https all the way up until the word new
    1. Here is an example of a full URL but only the required part in bold:
    1. Example using the above URL:
  1. You can repeat the same process outlined above for the other call matching types.
  1. Sticking with the approach above, the Update Object URL would be:

Saving Changes

When you make any changes in the admin area, you must save your changes for your selections to become active. If you do not save your changes, then they will not be applied.


57 users have voted.

Technical Support

If you have any technical questions or need to get in touch with Tech Support, please email us at to open a ticket.

Customers With Disabilities

Sangoma values its customers with disabilities. If you are in need of assistance with a Sangoma service or feature, please email

Website Suggestion

Do you have a suggestion about our Knowledge Base website, let us know?