Introduction #

Mastering Contact Sync: A Unified Approach for Enhanced 3CX Contact Management

The 3CX Contact Sync application facilitates seamless contact synchronization between the 3CX Console Management system and external sources like CSV files or Google Contacts. This application serves as a comprehensive resource for configuring, syncing, and scheduling contacts, benefiting users seeking streamlined contact management across various platforms within their 3CX system.

With functionalities enabling CSV file uploads, contact sync with 3CX, and synchronization between Google Contacts and 3CX, along with scheduling options, the application ensures efficient contact management by minimizing duplicates and maintaining updated information. Its mission revolves around providing an automated, user-friendly solution for contact synchronization, enhancing data consistency and accessibility within the 3CX environment.

This guide offers detailed step-by-step instructions for setting up contact synchronization, configuring sync settings, scheduling sync operations, and managing contacts effectively.

Why Choose 3CX Contacts Sync? #

	Effortless Contact Integration	This application simplifies the process of importing contacts from various sources like CSV files or Google Contacts into 3CX, ensuring smooth integration and access to diverse contact databases.
	Minimize Duplicates	By comparing specific fields during synchronization, the app identifies and removes duplicate contacts, maintaining a clean and organized contact list within the 3CX system.
	Enhanced Data Consistency	It ensures that contact information remains updated and consistent across different platforms integrated with 3CX, facilitating easy access to accurate details whenever required.
	Scheduling Options	Offering the flexibility to schedule sync operations, users can automate contact updates at regular intervals, ensuring that contacts are always up-to-date without manual intervention.
	User-Friendly Automation	With an intuitive interface and automated processes, the application simplifies contact management tasks, reducing manual effort while enhancing accuracy and efficiency in maintaining contact records.

Prerequisites #

Ensure your computer meets the minimum requirements outlined below before installing 3CX Contacts Sync

Step By Step Installation Procedure #

The following section guides you through a detailed walk-through of the installation process.

Installation overview #

	DOWNLOAD SOFTWARE	You can order 3CX Contacts Sync online at https://www.voiptools.com. The order confirmation email includes your license key and a link to download the software
	INSTALL PREREQUISITES	You must the prerequisites listed earlier prior to installing the 3CX Contacts Sync. Click here to know the list of required prerequisites.
	INSTALL 3CX CONTACTS SYNC	This User Guide contains step-by-step instructions to successfully install 3CX Contacts Sync. Begin by extracting the installer from the downloaded zip file (Step 1 above), then run the setup program named 3CXContactsSyncInstaller.exe
	CONFIGURE THE RELAY	You must configure the Relay settings to communicate with 3CX. Click here to learn more about VoIPTools Relay.
	REGISTER YOUR SOFTWARE	To activate 3CX Contacts Sync, register your license key, available in your order confirmation email and order history on our website

Step 1: Download 3CX Contacts Sync #

1. Find the software download link in the Order Confirmation Email, or you can find it in your order history on our website and download the 3CX Contacts Sync application.
2. In the Microsoft Defender SmartScreen, click the More Info option.

3. Click the Run Anyway option to start the installation.

Install The Prerequisites #

Double-click on the Software Installer downloaded in Step 1. The installation wizard automatically identifies the prerequisites and assists you with each installation required to 3CX Contacts Sync.

1. Click the downloaded installer executable to launch the Prerequisites Setup Wizard and click Next.

2. In the Prerequisites window, install all the required prerequisites identified by the installer, or select/ unselect the applications based on your requirements and click Next to continue.

The installer will download and install the selected applications. This may take several minutes to complete.

Step 4: Install 3CX Contacts Sync #

1. Click Next on the 3CX Contacts Sync Setup Wizard screen.

2. The Folder field on the Select Installation Folder window shows the installation path for 3CX Contacts Sync. The location path cannot be altered. Click Next to proceed.

Step 5: Configure The Relay #

You must configure the Relay settings to communicate with 3CX. Follow the procedure to configure the Relay settings,

1. On the 3CX Relay Services window in the Relay Host field, enter the FQDN of your 3CX server.
2. Paste the JWT public key in the Public Key field copied from the VoIPTools Relay Services application. Click here to know more.
3. Click the Test Relay Settings to test the relay connection.

NOTE:

• Relay Port must be 8801 only.
• Do not add “https://” to the Relay host data
• Once you have successfully tested the connection to the Relay, the “Next” button will be enabled

4. The Next button will be enabled when the test connection is successful. Click OK in the Success message box to continue with the installation.

NOTE:

If the Relay test fails, you cannot continue the installation until you establish communication with the Relay.

Step 6: Installing 3CX Contacts Sync #

1. Click Install in the Ready to Install window.

The application installation may take several minutes to complete.

2. Click Finish when the installation is complete.

Step 7: Register your Software #

To ensure the authorization of your license key, it is necessary to complete the registration process. By registering with VoIPTools, you gain access to a range of benefits:

Follow the procedure to register your software,

1. Double-click the 3CX Contacts Sync desktop icon to open the web application.
2. On the Login page, do the following tasks,
   1. In the Extension field, enter your 3CX extension number.
   2. In the PIN field, enter your 3CX voicemail PIN.
   3. Click the Login button to log in to your account.

3. Enter all the necessary information on the License Registration page and click the Register button.

4. Click OK on the Registration Success popup.

NOTE:

The web application can be accessed only by the extensions with Manager rights.

Web Portal #

The 3CX Contact Sync lets you configure the sync settings and sync contacts to 3CX

• From a CSV file in your local device.
• From your Google Contacts.

Sync Your Contacts to 3CX From CSV File #

This section gives you insights to make changes to the sync settings and sync your contacts to 3CX from a CSV file.

Contact Sync Settings: CSV File #

Follow these steps to configure sync settings for uploading CSV files from your local device.

1. On the 3CX Sync Contacts web application in the left side panel, click the Settings menu.
2. Select the CSV File radio box in the Choose Field to Save Contacts From section.

3. Select the desired field to compare from the Choose Filed to Compare list.
   • For example, if you select the “Mobile” field, 3CX Contact Sync will compare the mobile numbers of your current 3CX contacts with the newly uploaded ones and eliminate any duplicates.

NOTE:

You must select a field from the Choose Field to Compare list that is available in the CSV file or else it will create a new contact in 3CX Server.

4. Select the Run Now radio box to sync the contacts immediately or you can select the Select Time Period radio box to schedule the operation.

5. Click the Reload option to restart the service.

6. In the Reload Confirmation message, click on the Reload link and wait for 30 Seconds.

NOTE:

Wait for 30 Seconds after you click the Reload button before proceeding to the following steps.

7. On the 3CX Contact Sync web portal in the left side panel, click the Contacts menu.

8. Click the Upload CSV File option to browse and upload the CSV file from your local device.

NOTE:

The CSV file must be delimited by commas and must have the following headings,

• FirstName
• LastName
• Company
• Mobile
• Mobile2
• Email
• Home
• Home2

• Business
• Business2
• BusinessFax
• Other
• HomeFax
• Tag
• Pager

9. Once you upload the CSV file with the required headers, click OK on the Success Popup message.

Schedule Your Contact Sync: CSV File #

You can schedule contact synchronization in two ways: by defining a specific delay in minutes or by specifying a particular time for syncing your contacts.

Defining delay Minutes to sync contacts #

1. On the Settings screen, in the Contact Sync Settings section, select the Select Time Period radio box.
2. Select the Frequency radio box to set the delay.
3. Set the delay (in minutes) in the Select Minutes field.

Schedule a time to sync contacts #

1. On the Settings screen in the Contact Sync Settings section, select the Select Time Period radio box.
2. Select the Schedule Timer radio box to set the delay.
3. In the Schedule Timer field, click the Clock icon to set the time to sync.

NOTE:

Allow for a brief delay after the scheduled time for contacts to sync with 3CX. It may take up to 30 seconds for the application to fully synchronize your contacts. For example, if scheduled for 6:30 PM, anticipate a brief delay in the synchronization process rather than an immediate update at the scheduled time.

Sync Your Contacts to 3CX From Google Contacts #

Follow these steps to set up sync settings for synchronizing your Google Contacts with 3CX.

1. On the 3CX Sync Contacts web application in the left side panel, click the Settings menu.
2. In the Choose Field to Save Contacts From section select the Google Contacts radio box.

3. In the Google Settings section, enter the necessary credentials.

4. Click the Generate Token button to generate a token. You will be redirected to the Google Sign-In page.
   • Click here to learn more about the generated token.

5. Choose an account on the Google Sign-In page to continue the 3CX Contacts Sync.

6. In the Warning Message screen, click the Advanced option.

7. In the Advanced options, click the Go To 3CX Contacts Sync (Unsafe) option to proceed.

8. Click the Continue option, to give 3CX Contact Sync access to your Google account.

9. Once you give your Google account access, a token gets generated successfully. Click OK on the Token Generated popup.

10. On the Settings menu, in the Choose Field to Compare Section dropdown, select the desired field to compare.
    • For example, if you select the “Mobile” field, 3CX Contact Sync will compare the mobile numbers of your current 3CX contacts with the newly uploaded ones and eliminate any duplicates.

NOTE:

You must regenerate the token if you change your email address password. Click here to know the procedure.

NOTE:

• You must select a field from the Choose Field to Compare list that is available in the Google Contacts or else it will create a new contact in 3CX Server.

• Deleting contacts in Google Contacts will not impact your 3CX server contacts.

11. Select the Run Now radio box to sync the contacts immediately or you can select the Select Time Period radio box to schedule the operation.

12. Click the Reload option to restart the service.

13. In the Reload Confirmation message, click on the Reload link.

NOTE:

Wait for 30 Seconds after you click the Reload button before proceeding to the following steps.

NOTE:

Ensure that the Redirect URL matches with the browser URL.

14. Follow the below steps to sync your Google Contacts to 3CX immediately, or click the link to learn how to sync Google Contacts at a scheduled time,
    1. On the 3CX Contact Sync web portal in the left side panel, click the Contacts menu.

1. 2. In the Contacts Save/Upload section, click the Create CSV From Google to sync your Google Contacts to 3CX immediately.

NOTE:

• You cannot sync your Google Contacts to 3CX without generating the token.

• The generated token is valid for 180 days.

• You can view information on your generated token in the following file,

C:\Program Files\VoIPTools\3CX Contacts Sync\appsettings.JSON

Schedule Your Contact Sync: Google Contacts #

You can schedule contact synchronization in two ways: by defining a specific delay in minutes or by specifying a particular time for syncing your contacts.

Defining delay Minutes to sync contacts #

1. On the Settings screen, in the Contact Sync Settings section, select the Select Time Period radio box.
2. Select the Frequency radio box to set the delay.
3. Set the delay (in minutes) in the Select Minutes field.

Schedule a time to sync contacts #

1. On the Settings screen in the Contact Sync Settings section, select the Select Time Period radio box.
2. Select the Schedule Timer radio box to set the delay.
3. In the Schedule Timer field, click the Clock icon to set the time to sync.

NOTE:

When contact sync is scheduled from your Google account to 3CX, it’s not required to click the Create CSV File button in the Contacts tab. This step avoids duplicate contacts generated automatically by the application and manually via the ‘Create CSV File’ button. Your contacts will seamlessly sync to 3CX without additional action.

NOTE:

Allow for a brief delay after the scheduled time for contacts to sync with 3CX. It may take up to 30 seconds for the application to fully synchronize your contacts. For example, if scheduled for 6:30 PM, anticipate a brief delay in the synchronization process rather than an immediate update at the scheduled time.

How to Regenerate Token If the Google Credentials are Changed? #

If you change your Gmail credentials, you must regenerate the token for Google Contacts to sync to 3CX. However, the Generate Token button won’t activate unless you clear the previously generated token.

1. Open the AppSettings.JSON file in your local device available in the following path

C:\Program Files\VoIPTools\3CX Contacts Sync

2. Delete the generated token in the Refresh Token field and save the file. Click here to learn how to generate the token.

Need Support? #

You get quick answers to most of your inquiries in our online manual. If you prefer direct contact, we offer various support channels, including phone, email, live chat, and our helpful VoIPTools forums.

24/7 Support Availability #

Rest assured, our dedicated team is here to assist you around the clock, every day of the year. Whether you’re based in the USA or India, we’re ready to provide prompt responses to your technical queries.

Windows Event Log for VoIPTools Applications and Services #

For troubleshooting any application errors, our Windows Event Log contains a comprehensive list of error messages, warnings, and informative notes related to all our VoIPTools applications and services. It’s a valuable resource to help you pinpoint and resolve any issues you may encounter.

Join Our Forum Community #

Are you looking to collaborate with other VoIPTools customers facing similar challenges? Our forum is the perfect platform to exchange ideas, solutions, and best practices. Join the conversation at: https://www.voiptools.com/community/

Real-Time Live Chat Assistance #

Got questions that need immediate answers? Our chat support team is available to assist you in real time. Just click on the Live Chat button located at the lower right corner of our website, and we’ll acknowledge your queries right away.

Efficient Email Support #

To ensure a thorough understanding of your concerns, email us at support@voiptools.com. Describe your issue in detail, and we’ll get back to you within one business day with the support you need.

Reach Us by Phone #

If you prefer to speak with a representative directly, you can reach us at +1 801-642-4655. Our attentive team is available to take your calls from 8:00 AM to 6:00 PM (Central Standard Time).

Free Support #

If you’ve purchased our products through a VoIPTools Partner, rest assured that they provide first-level support at no additional cost. Partners have access to 100% free technical assistance and actively participate in the troubleshooting process.

VoIPTools customers enjoy access to our online manuals and receive support through emails (with responses within one business day) and live chat. However, please note that we do not provide remote server login assistance.

Paid Support #

For a more hands-on experience, consider our “Installation Support” package. Our expert support team can log in to your servers, and install and configure all our tools. This comprehensive service includes setting up SQL Server Express and Internet Information Server if necessary. We’ll work closely with you to tailor our applications to meet your requirements.

We’re committed to providing top-notch support to ensure your VoIPTools experience is smooth and hassle-free. Contact us today, and let us assist you in making the most of our powerful tools!