Doc. Number | Article Title | Effective Date | Version |
FHC-XX | Five9 Set Up Guide | December 05, 2024 |
Basic |
This guide is intended to assist with setting up a basic configuration to enable Forth’s Five9 integration. For detailed instructions on how to incorporate account-specific requirements, please refer to the Five9 University courses available at https://community.five9.com/s/
This guide is organized into the following sections:
- Five9 Settings
- Adding Contacts Fields
- Set Up Connectors
- Add Dispositions
- Create HTTP Post
- Create Campaign
- Set Up Chrome Extensions
- Index: Five9 University - Campaign Set Up
Five9 Settings
-
General Settings
-
Obtain login credentials (Username and Password) and the Organization ID from Five9
-
Navigate to the Admin Tab > Settings > Five9 in the CRM
-
Enter the Organization ID as provided by Five9 (see the first red highlighted area below).
-
Enter the API Username and API Password provided by Five9 into the corresponding fields (see the second red highlighted area in the image above).
-
For the Contact ID Field, enter “CONTACTID”
-
Retrieve the Domain Name from the top of the folder structure in Five9 (see screenshot). The same credentials populated in the API Username and API Password fields above are used to log in to the VCC Admin tool. The domain name can be copied using CTL+C after selecting it in the tool.
-
The “Outgoing Campaign Name” field can be left blank.
-
General Settings should look similar to the image shown below.
-
Click on “Save Settings” (NOTE: the “Active/Running” checkbox must be selected to save changes).
-
User Mapping
-
The users to be set up in the Five9 VCC Admin tool must be displayed in the User Mapping section.
-
The user’s work email address should be populated in the “Five9 Agent User Name” field.
-
Right-click on the Users folder and select “Add User” from the context menu.
-
Enter the following information into the “General” tab of the “New User Properties” window.
-
First Name - User’s first name
-
Last Name - User’s last name
-
Email address - User’s work email address from the User Mapping > Five9 Agent User Name field in the CRM. This field matches user data between the Five9 application and Forth CRM.
-
Password - click the three-dots button next to the Password field and enter the password. It must match the password in the User Mapping > Five9 Agent Password field.
-
The “General” tab should appear similar to the image shown below.
-
-
Go to the “Roles” tab and add role(s) by clicking on the “Add” button and selecting the appropriate role from the list shown.
-
Click ‘Save’ to finish setting up the user profile.
Adding Contacts Fields
-
Log in to the VCC Admin tool using credentials provided by Five9.
-
Go to the Contacts > Fields folder.
-
Right-click the Fields folder and select “Add Contact Field” to add new fields.
-
Add the following field in all caps in the New Contact Field, replacing the current name: CAMPAIGN. Click Save.
-
Repeat for the below fields:
-
CONTACTID
-
CONTACTSTAGE
-
CONTACTSTATUS
-
DATASOURCE
-
-
Repeat for the below fields (in all lower case):
-
city
-
company
-
email
-
first_name
-
last_name
-
number1
-
number2
-
number3
-
state
-
street
-
zip
-
-
The Contacts Fields should look like the image below:
Set Up Connectors
Set up the three following connectors:
-
DPP Outbound Pop
-
DPP Inbound Look Up
-
DPP Disposition
DPP Outbound Pop
This connector automatically opens the Contact file in a new browser tab when the Contact is dialed from a running Campaign and connected to an available Agent.
-
Begin by right-clicking on the Connectors folder and selecting “Add Connector.”
-
Leave the “Classic Connector” default selection and click “Create Connector” to proceed.
Once created, a connector can be edited by double-clicking the connector name in the list of existing connectors in the right pane or by right-clicking the connector and selecting “View Properties of <name>” from the context menu.
-
Enter the URL: https://<client domain>.forthcrm.com/index.php. For example: https://login.forthcrm.com/index.php
Note: The URL may differ depending on if the account has a custom domain. If a custom domain is not set up, use https://login.forthcrm.com.
-
Enter the Method as “GET” (See the first arrow below).
Tip: Click “Apply” to save progress at any time.
-
Add three parameters as illustrated below
-
Click the “Add Constant” button (see the second arrow shown in the image above).
-
Constant name: module
-
Value: contacts
-
Click “OK” to save
-
-
-
-
-
Constant name: page
-
Value: view2
-
Click “OK” to save
-
-
-
Now click the “Add Field" button, and then select the field “CONTACTID” created earlier.
-
Click “OK” to save.
-
Double-click the “CONTACTID” parameter name in the Parameter Name column, delete “CONTACTID” and replace with “cid”.
-
Click ‘Enter’ to save.
Tip: The connector window can be resized by click-and-dragging on the outer edge of the window.
-
Execution Mode: In Browser
-
Select “Open in new browser window [...]”
-
-
CTI Web Services - Current browser window
-
The DPP Outbound Pop connector should appear as shown below, except for the URL.
-
Finally, go to the “Triggers” tab and select “On Call Accepted” from the dropdown menu.
-
Click the “Save” button at the bottom of the page to complete the connector setup.
DPP Inbound Look Up
This connector enables the automatic opening of the Contact’s file in a new browser tab when the Contact calls in using Five9's configured Inbound number, and the call is transferred to an available Agent.
-
Follow Steps 1 - 4 in DPP Outbound Pop for setting up this connector
-
Set the connector title to DPP Inbound Look Up
-
Add three parameters as illustrated below
-
Click “Add Constant”.
-
Constant name: module
-
Value: contacts
-
Click “OK” to save
-
-
Click “Add Constant”.
-
Constant name: page
-
Value: lookup
-
Click “OK” to save
-
-
Click “Add Field,” then select the field “CONTACTID.”
-
Click “OK” to save
-
Double-click the “CONTACTID” parameter name in the Parameter Name column, delete “CONTACTID” and replace it with “cid”
-
-
Click “Add Field”, then select the field “ANI”.
-
Click “OK” to save
-
Double-click the “CONTACTID” parameter name in the Parameter Name column, delete “CONTACTID” and replace it with “phone”
-
-
-
Execution Mode: In Browser, and then select “Open in new browser window [...]”
-
CTI Web Services - Current browser window
-
The DPP Inbound Look Up connector should appear as seen below, except for the URL.
DPP Disposition
This connector enables the receipt of data back into the CRM upon call completion, e.g., Agent username, call notes, call disposition, etc.
-
Create a new connector, “DPP Disposition”.
-
Enter the URL: https://<account domain>.forthcrm.com/post/five9.php. For example https://login.forthcrm.com/post/five9.php
Note: The URL may differ depending on if the account has a custom domain. If a custom domain is not set, use https://login.debtpaypro.com
-
Enter the Method: POST
-
Click “Add Field” and highlight all of the fields. They can all be highlighted simultaneously by clicking on the top field and dragging down.
-
Do not check the “Execute Browser” for this connector
-
Go into the Admin tab in the CRM > Settings > Five9
-
If one doesn’t already exist, click on “Create One” (see highlighted area in the image below).
-
In the DPP Disposition connector, click on “Add Constant.”
-
- Constant Name: TOKEN
- Constant value: Copy and paste the token from the Five9 settings. Click "OK" to save.
- Set Execution Mode to Silently > Form submission
- The connector should appear as below, except for the URL:
-
Click the “Triggers” tab, and set the On Call Event to: “On Call Dispositioned.”
-
Select all dispositions by clicking on their adjacent checkbox, one by one. Then click "Save" to complete the connector setup.
Add Dispositions
-
Go into the Five9 settings in the ForthCRM for your account.
-
Review the dispositions currently set up in the “Disposition Mapping” section.
-
Return to the Virtual Contact Center, and click the “+” button next to the Dispositions folder to see associated subfolders.
-
Right-click on the Custom Dispositions folder and select “Add Disposition” from the context menu.
-
Enter the disposition name and click “OK.”
-
Repeat for the remaining dispositions in the Five9 “Disposition Mapping” settings.
Create HTTP Post
This enables the sending of contact information from Forth CRM to a Five9 List. Contact records populated in a List will be dialed during a running Campaign (see the “Create Campaign” section below).
-
In Forth CRM, go to the Contacts tab > Webhooks
-
Webhook Title: Five9
-
Execution Mode: Background job
-
WebHook URL: https://api.five9.com/web2campaign/AddToList
-
Port: 0
-
Method: POST
-
Username and Password: Use the credentials provided by Five9
-
Auth Type: Basic
-
-
Set up the fields as below except for “F9domain” and “F9list,” the instructions for which are provided below the illustration shown here.
-
“F9Domain” - Use the same domain name as populated in Step 1 in the Five9 General Settings section's “Domain Name” field.
-
“F9list” - This is the name of the List object in the Five9 VCC Admin tool to which the Contact records will be sent. For example, “New Leads.”
-
Check existing lists within the Lists folder or right-click the Lists folder and select “Add List” from the context menu to create a new one.
-
-
Set the “F9list” value to match the needed list title within the Lists folder.
NOTE: Multiple Webhook Posts may need to be set up to distribute Contacts files to different Lists. If so, use the ‘Save as New’ button towards the bottom of the Webhook Post page and change the “F9list” value to match the List name in the Five9 VCC Admin tool.
Create Campaign
-
Outbound Campaign
-
Right-click on the Campaigns folder and select “Add Campaign” from the context menu.
-
Enter the name for the campaign and click “OK”.
-
Select “Outbound” and click on “Create Campaign”.
-
Double-click the campaign to bring up campaign properties.
-
Click on the tab “Dialing Options”.
-
Click on the “Action on Max Queue Time Expiration” dropdown menu and select “Play Prompt.”
-
Click on the “Prompt” dropdown menu and select any prompt, for example “EIGHT”.
-
Click on the “Connectors” tab,
-
Click on “Add”
-
Select the “DPP Disposition” and “DPP Outbound Pop” connectors, then click “OK”
-
Go to the “Dispositions” tab (see red arrow below).
-
The "Add" button will not become active. Click “Add” in the “Disposition(s)” section near the bottom of the page.
-
Highlight the list of dispositions and click “OK”.
-
Go to the “Lists” tab and click on “Add”.
-
Select the List and click “OK” to add. Multiple may be selected and added to a Campaign. The Lists tab should look like the image shown below.
-
Click “Save” to finish setting up the Campaign (see the red highlighted area in the image above).
Set Up Chrome Extensions
The Five9 integration requires installing three Google Chrome extensions: two for the Softphone Agent Workstation and a separate one for the Click-to-Call dialing widget.
-
Agent Softphone Station
-
Upon accessing the “Agent” station from the Five9 landing page, it will automatically prompt you to install the required extension and file:
-
Follow the steps to install in the respective setup wizards.
-
Upon completion of the setup, the extensions shown below should be installed and active. This can be confirmed by going to Google’s “Manage Extensions.”
-
Five9 Click-to-Call
-
The “Five9 Dialer” account setting must be enabled in the PRO account:
-
Download and install the “Five9 Plus Adapter for Agent Desktop Toolkit” browser extension. (URL: https://chromewebstore.google.com/detail/five9-plus-adapter-for-ag/mhlnodcncaldmcjkkllohonbgigbjpkb)
-
Go to “Manage Extensions” in Google Chrome. Click the three dots next to "Five9 Plus Adapter for Agent Desktop Toolkit".
-
Click on “Details” in “Five9 Plus Adapter for Agent Desktop Toolkit”.
-
Click on “Extension Options”.
-
Populate the “IdP Login URL” field as: https://app.five9.com/clients/integrations/adt.li.main.html
-
Click on the “Floating Mode” checkbox if it’s not already enabled, and then click the "Save" button to complete the setup.
Index: Five9 University - Campaign Set Up
For an in-depth guide on setting up Campaigns in the VCC Admin tool, go to https://www.five9.com/ , and log in to the Cloud Contact Center.
-
Click on “Support and Training”.
-
Click on “Five9 University” in the header located at the top of the page.
-
On the “Administrators” icon, click on “View Courses.”
-
Click on the “Outbound Administrator” or the “Inbound Administrator” course folder, depending on the campaign type required.
Article Version History:
Version | Effective Date | Description |
Basic | 12/05/2024 | Initial Release |