Genesys Pure Engage and Mindful Integration Guide (With Datastore)

The Mindful Callback integration with the Genesys Pure Engage platform utilizes reliable SIP-based communication without the need for custom development. The example integration presented in this guide allows the Genesys platform to send inbound calls to the Mindful Callback application for a callback offer, while maintaining user data and context for each call.

In this guide, we present configuration requirements for the following processes and components:

• Configuring DIDs for the contact center and high-priority holding queue
• Call routing by a single Genesys Queueing Strategy
• Establishing an offer threshold in Genesys Pure Engage based on the wait time
• Providing a callback offer in the Mindful Callback application.
• Retaining user data between Callback and Genesys

Overview 

This integration guide covers the following topics:

• Components and architecture
• Step 1: Configure your Mindful Datastore account
• Step 2: Configure your Mindful Callback account
• Step 3: Configure your SBC
• Step 4: Configure your Genesys environment
• Call flow diagram
• Optional: Offer Second Chance Callback

Components and architecture

Expand the following content to review the definitions of acronyms and terms used throughout this guide. You can also view a high-level overview of the components and architecture of the integration before getting started.

Step 1: Configure your Mindful account

Before your ACD can send inbound calls to Mindful, there are a few items that must be configured on the Mindful side:

• At least one Call Target to register and dial callbacks
• One Scheduler Widget for each Call Target used in the integration
• A Data Set Template in Mindful Datastore (if you intend to use Datastore to store custom user data and context)

Call Target configuration

There are a few settings in Callback that must be adjusted to integrate with your ACD.

Registration

Quick access: Callback > Call Targets > Your Call Target > General tab > Registration

• Offer ASAP Callback: Select this checkbox to offer callbacks to be returned as soon as possible.
• Offer Scheduled Callback: Select one or both of these checkboxes (Voice and/or Widget/API) if you wish to offer callback scheduling for specific dates and times.

Contact Center

Quick access: Voice > Call Targets > Your Call Target > General tab > Contact Center

1. Callback Telephony Type: Select SIP.
2. Callback Number: This will be configured in a later step.

Callback Strategy

Quick access: Voice > Call Targets > Your Call Target > General tab > Callback Strategy

Most of the Callback Strategy settings are not relevant to the integration, and they can be set however you would like. However, there is one notable exception when using the Customer First Callback Strategy.

When using Customer First, enable Wait for live Agent. This will prompt agents to press a digit to accept a callback, which provides an Agent Answer event to Mindful. The Agent Answer events assist in calculating an accurate Estimated Callback Time (ECBT).

Phone Numbers

Quick access: Configuration > Phone Numbers

On the Phone Numbers page, provision as many SIP numbers as needed and assign a number to each Call Target in your Organization. This is the number to use when configuring the SIP endpoint to which to send inbound calls for callback treatment.

Scheduler Widget configuration

Each Call Target used in the integration will require a Scheduler Widget. These Widgets will provide API endpoints that will allow your ACD to check the status of a Call Target before forwarding an inbound call to Mindful. Important points for the Widgets used in this integration are listed below:

• Template: Select any Scheduler Template. Templates will not be used since this Widget will only be accessed via API, but Mindful Callback requires a Template to be assigned.
• Call Target: Select the appropriate Call Target. The ACD will check the status of this Call Target (via the Widget) to ensure it is ready to register callbacks before transferring inbound calls to Mindful.

For complete instructions on creating Widgets, see Getting Started with Scheduler Widgets.

Datastore configuration

Mindful Datastore allows you to store user data to maintain call context at critical points in an interaction. If you intend to use Datastore, you will need to perform the next few steps within the Datastore user interface.

A Data Set Template contains a collection of Data Keys that allows the Mindful Datastore to store customer data during the callback request process. This collection includes:

• The set's name and description
• How long you want to retain collected data submitted with this Data Set
• What information you want the set to collect (through configuration of Data Keys)
• The API token that is used to associate data submitted via POST requests and return information via GET requests

The Mindful Solution Delivery team can assist with setting up a Data Set Template, as well as a unique authentication token. To create one on your own, use the steps below.

Quick access: Datastore > Data Set Templates

1. On the Data Set Templates page, click Add Data Set Template. This takes you to the New Data Set Template page.

2. Name: Enter a name that will be recognizable to others in your organization.
3. Description: Enter a description for the benefit of other Administrators.
4. Data Retention Period (Hours): Manually enter or use the +/- buttons to customize your Data Retention Period. You can retain data for 1 hour, or for up to 48 hours.
5. API Token: The system automatically generates your API Token.

IMPORTANT

If your API Token is already plugged into your routing logic, regenerating the token here will break that link. To re-establish the link, update your host with the new API Token. Contact Mindful Support for assistance.

6. Template Data Keys: You can select from existing Data Keys in your system or add new keys. The selected keys will filter out any submitted data that does not correspond to one of the configured keys, and will only retain submitted data that matches the configured keys.

Add a Data Key

Click Add Template Data Key. This opens the New Template Data Key modal window.

1. Click in the Manually Enter Data Keys field. 
   1. If your Mindful Datastore instance contains existing Data Keys, select one from the dropdown list that appears.
   2. If not, type the name of a new Data Key here.
2. When finished, click Add.

Your key now appears in the Template Data Keys list.

EXAMPLE

In our example integration, we set up the following Data Keys for callbacks:

• FirstName
• LastName
• AccNum
• CallId

You can configure Data Keys in the same way for any user data that you need to maintain in your environment.

Step 3: Configure your SBC

Mindful Callback integrations can function with different Session Border Controller (SBC) products regardless of the ACD platform used in your environment. Click any of the links below for instructions on integrating your chosen SBC.

• Avaya Session Border Controller Enterprise (SBCE)
• Cisco Unified Border Element (CUBE)
• Audiocodes Mediant

NOTE

We plan to add integration guides for more SBC products over time. Check back here for updates or let us know if you would like us to cover a specific SBC!

Step 4: Configure your Genesys environment

Several items will need to be configured or edited in your Genesys environment to complete the integration. The following steps and examples cover four additional tasks:

• Create Trunk DNs
• Configure a Routing Point
• Set SIP Server Application Options
• Configure Genesys routing

Create Trunk DNs

You will need to configure two Trunk DNs for this integration. Both DNs allow calls to pass through the SBC, with one DN allowing traffic to your telephony service provider and the other allowing traffic to the Mindful Callback application.

Quick access: Genesys Administrator > Switches > Your SIP Switch > DNs > Trunks

Open both of the following tabs for information on the two required Trunk DNs.

Configure a Routing Point

Configure a single Routing Point for the entry DN that callers use to enter the Genesys environment. This Routing Point DN will be used by the Mindful Callback application to send callbacks to your Call Center.

Set SIP Server application options

TServer/userdata-map-trans-prefix 

The SIP Server Application Option TServer/userdata-map-trans-prefix is null by default. We recommend setting the value to X-Genesys-. This is required if you use GVP as an IVR, but is still a best practice in other cases. The value of this option must match the prefixes configured for the Metadata items in the Mindful Callback user interface in a prior step.

Configure Genesys routing

For routing in our example integration, we configured an inbound strategy, two return call strategies, and a single subroutine that can be invoked from all of them. The inbound strategy posts custom call data to a Mindful Datastore account before routing the call to Mindful Callback for treatment. The return call strategy handles both callbacks and callers who chose to return to the holding queue from the Callback IVR.

Inbound strategy

Use the following steps to configure the inbound strategy and the HTTP POST portion of the Callback subroutine.

1. Set the Mindful Callback transfer number. This should be the Call Target Phone Number provisioned in the Mindful Callback user interface.
2. Send the call to the Mindful Datastore subroutine along with any custom data you wish to store for the call.
   • Set the RequestType parameter to post in the Call subroutine properties window.
3. If the subroutine fails for any reason, or the system is unable to send the call to Mindful Callback, exit the subroutine and queue the call for an agent at normal priority.

Mindful Datastore subroutine - POST

A single subroutine will be used to POST or GET information to and from Data Set records in your Mindful Datastore account. When a call enters the subroutine with the RequestType parameter set to post, the POST portion of the subroutine will be used. 

Use the following image and steps as a guide when creating the HTTP POST section of the subroutine.

1. Begin by setting a few default variables. In our example integration, we set two variables:
   • OriginalUUID: This can be retrieved for return calls to pair them with inbound calls in Genesys reporting, such as ICON.
   • vht_ANI: The ANI is required by the Datastore application, as it is used as the lookup key for stored records.

2. Use the Cat function in an Assign properties block to combine all of the custom data into a single string. The example image below shows the Cat function creating a string with customer_contact_number as the key while concatenating all other data together as the value:

3. Perform an HTTP POST to Mindful Datastore with a Web service properties block, using the following image and notes as a guide:
   • Web Service URL: Set to the URL of the Mindful Datastore API
   • Method name: POST
   • Headers: Add two headers:
     • authorization: Set the value to the API Token assigned to the Data Set Template in the Datastore application. In the Datastore UI, the API Token can be found on the Data Set Templates screen.
     • Content-Type: application/json

4. If the HTTP POST succeeds, route the call to Mindful Callback via the number passed into the subroutine.
   • Make sure this number contains the appropriate prefix (8088 in our example) to send the call out of the appropriate trunk.

5. If the HTTP POST fails, attach default user data for screen-pop or other purposes, then exit the subroutine. 

Return call strategies

The following table provides an overview of the Choose Hold and Callback Return strategies. The Choose Hold strategy will be used for calls returned from Mindful Callback after customers choose to return to hold from the Callback IVR, while the Callback Return strategy will be used for callbacks sent to the high-priority holding queue.

Choose Hold strategy	Callback Return strategy

Mindful Datastore subroutine - GET

A single subroutine will be used to POST or GET information to and from Data Set records in your Mindful Datastore account. When a call enters the subroutine with the RequestType parameter set to get, the GET portion of the subroutine will be used. 

The GET portion of the subroutine will accomplish several tasks:

1. Perform a lookup in the Datastore records based on the customer's ANI.
2. Retrieve data stored in the appropriate Datastore record.
3. Parse the results from the JSON string received in the response from Datastore into individual variables.
4. Attach necessary data to the return call for agent screen-pop or lookups in the queueing strategy.

Use the following image and steps as a guide when creating the HTTP GET section of the subroutine.

1. Begin with a Call subroutine properties block that sets the RequestType parameter to get.

2. Concatenate the customer's callback number to use as the ANI in the Datastore GET URL.

3. Perform an HTTP GET to Mindful Datastore with a Web service properties block, using the following images and notes as a guide:
   • Web Service URL: Set to the URL of the Mindful Datastore API, containing the customer ANI from the previous step.
   • Method name: GET
   • Headers: Add two headers:
     • authorization: Set the value to the API Token assigned to the Data Set Template in the Datastore application. In the Datastore UI, the API Token can be found on the Data Set Templates screen.
     • Content-Type: application/json
   • Result tab > Assign output value to variable: Select the variable that should contain the returned data values. In our example, this variable is named vht_DataValues.

4. Use a Multi Assign properties block to parse the returned values into individual variables. In our example integration, we use the KVListGetStringValue function to parse the JSON values.

5. Attach KVPs to the call via a Multi Attach properties block for use in agent screen-pop.

6. Set the call priority to the value of the callback priority passed in.
7. Exit the subroutine back into the Callback Queueing strategy to be queued for the appropriate agents.

Call Flow Diagram

Callback Call Targets use a complete phone number for the inbound call transfer. Each Call Target represents a queue/skill/group, such as Sales or Billing.

Optional: Offer Second Chance Callback

Expand the content below to learn how to make additional callback offers in your holding queue after a customer has declined the initial offer.

Second Chance Callback is a best-practice methodology that can increase the take-rate of callback offers and lower the abandon rate in your call center's holding queues. With a few updates to your routing logic, you can provide additional callback offers to customers waiting on hold who have already declined an initial offer. 

There are a variety of reasons that customers might appreciate a second chance to accept an offer of a callback. For example, perhaps something has come up that requires their attention and they can no longer wait on hold. Perhaps the quoted wait time was low when they declined the first offer but queue conditions have quickly changed and resulted in a longer hold time. Regardless of the scenario, Second Chance Callback ensures that customers have the callback option available when they need it.

Benefits

Our research shows positive results for call centers offering Second Chance Callback, including:

• Keeping customers in control with additional options while holding.
• Reducing abandoned calls in the holding queue by offering an alternative option.
• Fully controlling Second Chance offers in your ACD with no integration constraints.
• Adding another tool to address unexpected increases in hold time.
• No additional requirements for customers. They are not required to respond to Second Chance prompts, but can instead simply continue to wait on hold if they choose.

ACD configuration

Most configuration for Second Chance Callback is done on your ACD platform, so the technical implementation will vary based on your integration. In all integrations, the following logic must be introduced to interact with customers in the holding queue.

1. Whether offers are made in your ACD or in Mindful Callback, the process begins with the first offer. If the initial offer is accepted, then a callback is registered and no Second Chance offer is needed.
2. If the initial offer is not accepted, callers are routed to a holding queue.
3. A timer begins in the holding queue. When the specified time expires, another callback offer is made. 
4. If the customer declines the Second Chance offer, then the timer is reset, and another offer will be made when it expires again.
5. If the customer accepts the Second Chance offer, the call is sent to Mindful Callback for treatment.

Mindful Callback configuration

There are two alternatives for preparing your Mindful Callback account for Second Chance Callback. Each alternative introduces its own advantages and drawbacks.

• Option 1 (best practice): Use separate Call Targets for normal inbound calls and Second Chance calls.
• Option 2: Use a single Call Target for both normal inbound calls and Second Chance calls.

Option 1 (best practice): Use separate Call Targets

This option uses the first Call Target to service normal inbound callback requests with a second Call Target dedicated to servicing Second Chance callback requests. For an initial offer, send the call to the first Call Target. For a Second Chance offer, send the call to the second Call Target. This option separates the two types of calls for ease of reporting and real-time analysis.

Option 2: Use a single Call Target

The second option uses a single Call Target to service both normal inbound callback requests and Second Chance requests. This method is easier to configure and maintain, but it introduces a few additional drawbacks to consider.

Reporting on Second Chance Callback interactions

As noted in the lists of advantages and drawbacks, reporting on Second Chance interactions varies depending on whether you use one or two Call Targets.

Reporting with separate Call Targets

On the Metrics, Executive Summary, and Call Detail screens, use the Call Target filter to view data only for the Second Chance Call Target. This will exclude any data from initial offers and callers that chose to hold. If you offer Second Chance for multiple lines of business, you can add all of your Second Chance Call Targets into a shared Reporting Category to view all Second Chance interactions.

On the Callback Status screen, review real-time statistics for the Second Chance Call Target or use the Category filter to limit the view to only Second Chance Call Targets.

Reporting with a single Call Target

When using a single Call Target, additional configuration is required and the reporting capabilities are limited.

Preparation:

1. Provision two Phone Numbers in the Mindful Callback user interface, and assign both Phone Numbers to the same Call Target.

2. In your routing scripts, send normal inbound calls for callback treatment to the first Phone Number.
3. Send Second Chance calls for treatment to the second Phone Number.

Reporting:

1. On the Call Detail screen, export the reporting data to CSV. In the exported CSV file, the Call Target Phone Number to which each call was sent will be noted in the Source column.  
2. In the CSV file, filter the Source column for all records matching the Second Chance phone number. The remaining data will include only Second Chance interactions.