Avaya Aura and Mindful integration guide

Integrate the Avaya Aura platform with Mindful services.

Your Avaya telephony environment can be integrated with your Mindful organization to deliver calls via SIP while maintaining UUI and User-to-User data.

This guide presents configuration requirements for the following integration components:

  • Mindful for callback registration and processing

  • Callback offers through Mindful, including the option to hold

  • Avaya Communication Manager (CM), including queuing VDNs and vectors for the appropriate skills

  • Avaya Session Manager (SM)

  • Avaya Session Border Controller Enterprise (SBCE)

Important:

Before you begin - The following is a list of information that should be noted before beginning the steps in this guide.

  • The Callback Number configured for the Call Target

  • Avaya CM Vector for the skill being added to integration

  • Avaya SM IP address

  • Avaya CM IP address

  • Mindful instance IP address

  • Avaya CM priority queuing VDN

  • Call Target phone number

  • Your contact center's public IP address (for SIP addressing)

Note:
  • The minimum supported version of Avaya SBCE is 8.1.2 PATCH 2.

  • It is important to ensure that SIP headers and the SIP URI are intact when they leave the switch in your Avaya environment.

  • If you are interested in using Avaya UUI routing to utilize a single queuing VDN that sends calls to a shared pool of agents, see the add-on guide Avaya UUI routing.

  • For further validation against additional integrations options, contact a Mindful representative.

  • The configuration in this guide is an example and may be used as a template for integrating with Mindful. Any sample code in this guide should not be considered ready for production.

Overview

This integration guide covers the following topics:

  • Components and architecture

  • Configure your Mindful account

  • Configure your SBC

  • Configure Avaya to route inbound calls

  • Configure Avaya to receive callbacks

  • (Optional) Offer second chance callback

Definitions and acronyms

TermDefinition
CMAvaya Communication Manager
DIDDirect Inward Dialing phone number
SBCSession Border Controller
SIP trunkVirtual phone line that enables users/applications to make and receive calls
SIP URISIP addressing scheme that communicates who to call via SIP
UUIUser-to-User data passed in SIP headers
VDNVector Directory Number
System ManagerA single, unified web interface that used to administer, configure, and manage both Communication Manager and Session Manager, as well as other components in the Avaya Aura suite.

Architecture and call flow

Expand the following content to 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.

Components and architecture

architecture diagram

Call flow

Mindful 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.

call flow diagram
Note: This diagram illustrates a customer-first call flow. Mindful also supports an agent-first call flow, where the agent leg is initiated first. The configuration and IVR scripts remain the same regardless of the method used.

Configure your Mindful account

At least one Call Target should be configured on the Mindful platform before addressing your Avaya environment.

For complete instructions on building a Call Target, see How to set up a call target. Once you have a Call Target set up, use the guidelines below to integrate it with your Avaya environment.

Registration

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 Choose Hold — Select this to offer callers the option to wait on hold rather than accepting the offer of a callback.

  • 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.

Important:
  • The Choose Hold Number must be in the format <prefix><queuing VDN>@<your public IP address>

  • The Callback Number must be in the format <prefix><priority queuing VDN>@<your public IP address>

  • The public IP address in the Callback Number should lead to a firewall with a rule configured to forward requests from the Mindful SIP IP addresses to SM. The firewall should be SIP-aware (using ALG, for example) so that an RTP stream can be established using a dynamic range of ports.

Contact Center

Call Targets > Your Call Target > General tab > Contact Center

In the Contact Center section, configure the Callback Number with the SIP address of the VDN that leads to a holding queue staffed by agents. This holding queue should have a higher priority than regular inbound calls.

Note: For government users - SIP is the only Telephony Type supported in the Government instance.

Call Target metadata

In order to obtain Avaya UUI data and attach it to callbacks, you must configure a Metadata Item for any Call Target used in the integration. For complete instructions on working with Metadata Items, see How to work with user data and metadata.

Call Targets > Your Call Target > Metadata tab

Configure a single Metadata Item with the following parameters:

metadata configuration
  • Name — User-to-User

  • Type — SIP Header

  • Max Length — 10

  • Persist forever — enabled

Note:

Mindful will retain UUI data as long as the Persist forever checkbox is selected. With the checkbox selected, UUI data may display as hex-encoded strings in Mindful reports. If you would like to remove historical metadata, first deselect the Persist forever box then click Remove historical metadata.

Provision a phone number for the Call Target

Each Call Target used in the integration must have a unique phone number assigned to it in Mindful. For the examples in this guide, the phone number +12512500865 was used.

provisioning phone numbers

Configure your SBC

Mindful integrations can function with different Session Border Controllers (SBC) regardless of the ACD platform used in your environment.

See our SBC integration guides for instructions on integrating your chosen SBC.

Configure Avaya to route inbound calls

Configuration is needed in both CM and SM. For inbound calls, we will begin with CM and then proceed to SM.

Tip:
  • When quoting the estimated wait time prior to offering a callback, it is a best practice to set an upper limit for the amount of time that can be quoted. For example, if the wait time exceeds 10 minutes, you might choose to say "...more than than 10 minutes from now" rather than quoting an exact time.

  • We recommend setting a minimum offer threshold based on the current estimated wait time to ensure that callback offers are not made when wait times are very low. You may also wish to check agent availability prior to sending calls to Mindful.

Configure CM to forward inbound calls

To configure CM, you will need to update the vector script of the queuing VDN and add an entry to the ARS Digit Analysis table to assign a route to Session Manager.

In the vector script on the queuing VDN, add a route-to step to send the call to the Call Center Phone Number configured in Mindful.

Example

Using the SAT command change vector xx, we have configured a route-to step as Step 04 in the example vector below:

example vector
Important:

The number designated in the route-to step should match a route to Session Manager.

In the preceding example, we allow the Call Target phone number (12015841234) via an entry in the ARS Analysis table. In the screenshot below, Dialed String 1201 determines that numbers matching the 1201 prefix with a length of 11-digits will use Route Pattern 1. In our configuration, Route Pattern 1 uses an existing SIP trunk to SM.

The change ars analysis 1201 SAT command was used to perform this configuration.

A.R.S. analysis table

With these items complete, CM is ready to handle inbound calls with a route to SM. Next, we will configure SM to send calls into Mindful.

Configure SM to handle inbound calls

To complete the inbound configuration, you will need to perform the following updates in SM:

  • Prefix the plus (+) symbol to customer phone numbers for compliance with Mindful requirements.

  • Create a new SIP Entity for the SBC.

  • Create new Routing Policies.

  • Create new Dial Patterns.

Important:

If Mindful uses Twilio trunks to receive inbound calls (the default configuration), then the ANI of the call sent from the ACD to Mindful must be in e164 format. The ANI must be prefaced with +1. If a custom range of DNs is used instead, e164 format is not required.

Create an Adaptation to prefix the plus (+) symbol

When sending SIP calls to Mindful, the SIP URI must be in the format sip:+<phone number>@sip-callback.getmindful.com. Using our example phone number of 12015841234, the format would be sip:+12015841234@sip-callback.getmindful.com.

Note:

The default SIP domain for Mindful is sip-callback.getmindful.com, but your organization may use one of the following regional domains, instead:

  • sip-callback-oregon.getmindful.com
  • sip-callback-frankfurt.getmindful.com
  • sip-callback-sydney.getmindful.com
  • sip-callback-saopaulo.getmindful.com

Contact the Mindful Solution Delivery team to determine the correct domain for your organization.

The plus (+) symbol is required, and any SIP calls to Mindful without the plus symbol will fail. To insert the symbol in front of the number, you will need to create an Adaptation in SM.

Use the image and guidelines below to create the Adaptation. If you are already using an Adaptation, you can add a new row rather than creating a new Adaptation.

adaptation details

System Manager > Elements > Routing > Adaptations > New

  • Adaptation Name — Enter a descriptive name of your choice.

  • Module Name — Select "DigitConversationAdapter".

  • Module Parameter Type — Select "Name-Value-Parameter", then add one parameter with the following values:

    • Name — fromto

    • Value — true

  • Digit Conversion for Outgoing Calls from SM — Add one entry with the following values:

    • Matching Pattern — Enter the number or pattern being dialed.

      This is the number used to call Mindful (for example, 12015844063).

    • Min/max — Enter a minimum and maximum value. The example uses 11 digits in both the Min and Max fields.

    • Delete Digits — Enter "0".

    • Insert Digits — Enter the plus (+) symbol.

    • Address to modify — Select "destination".

Note:

In our example configuration, CM already strips the 9 prefix off of numbers, if it is present. If CM is not already configured to do this in your environment, you will need to strip the 9 prefix in the Adaptation by entering 1 in the Delete Digits field. This instructs the adaptation to delete the first digit from the number.

digit conversion

Create a SIP Entity for the SBC

There should already be a SIP Entity configured in System Manager for your SBC. Add the Adaptation created in the previous step to the existing SIP Entity for the SBC, as shown in the following image.

sip entity detailsentity links

If needed, use the following steps to create the SIP Entity.

System Manager > Elements > Routing > SIP Entities > New

  • Name — Enter a descriptive name for the SIP entity.

  • FQDN or IP Address — Enter the address of the SBC.

  • Type — Select "SIP Trunk".

  • Adaptation — Select the Adaptation that you created in the previous section of this guide.

  • Leave all other settings at their default values, or the values needed in your environment.

  • Entity Link — Update the existing Entity Links for all protocols.

    • Select your new SIP Entity in the SIP Entity 2 field.

    • For TCP and UDP, enter "5060" in the Port field next to SIP Entity 2.

    • For TLS, enter "5061" in the Port field next to SIP Entity 2.

    • Select "trusted" in the Connection Policy dropdown menu.

Create Routing Policies

We have already created Routing Policies on the SBC, and we must now create Routing Policies in System Manager to route specific numbers to the SBC or Avaya CM.

When creating the new Routing Policies, select the SIP Entity that you created in the previous section of this guide to use as the SIP Entity as Destination. Do not add a Dial Pattern at this time.

Routing Policy to CM

The first Routing Policy will send callbacks from Mindful into CM.

System Manager > Routing > Routing Policies > New

In our example configuration, the Routing Policy catches two values: one complete inbound DID and a range of numbers representing VDNs, agent stations, or similar endpoints.

  • Select the SIP Entity that you created in the previous section of this guide to use as the SIP Entity as Destination.

  • Add at least one DID in the Dial Patterns section.

  • Leave all other settings at their default values or the values needed in your environment.

routing policy details

Routing Policy to Mindful via the SBC

The second Routing Policy will send calls to Mindful via the SBC. This policy specifically targets the SBC.

System Manager > Routing > Routing Policies > New

In our example configuration, the Routing Policy includes Dial Patterns for any 11-digit number starting with 12, 13, 14, 15, etc. We used this method to catch any possible U.S. phone number, but your preferred method may differ.

routing policy details

Select the Mindful SIP Entity created previously and do not add a Dial Pattern at this stage. We will add a Dial Pattern in the next step.

Create Dial Patterns

Next, we will create Dial Patterns to link VDNs with the Routing Policies created in the previous step.

Dial Pattern for calls to CM

Configure the first Dial Pattern to match the VDN correlating to the intended skill. In our example configuration, we are using the VDN 20062, which is configured as the pattern 20xxx.

dial pattern details

System Manager > Routing > Dial Patterns > New

  • In System Manager, create a new Dial Pattern that matches the VDN for the intended skill. This will be the same number used in the route-to step that you added to the vector script for the queuing VDN in CM.

  • Add the Routing Policy for CM created in the previous section of this guide.

Note:

Avaya Session Manager does not handle audio, so the RTP may either be established between CM and Mindful, or between the SBC and Mindful, depending on your Avaya configuration (including Media Shuffling and Direct-IP-Audio settings).

Dial Pattern for calls to Mindful via the SBC

Configure the next Dial Pattern to match the Call Center Phone Number configured for the Mindful Call Target. In our example configuration, we are using the number 12512500865, which is configured as 12x.

dial pattern details

System Manager > Routing > Dial Patterns > New

  • In System Manager, create a new Dial Pattern that matches the Call Center Phone Number configured for the Mindful Call Target.

  • Add the Routing Policy for the SBC created previously.

The Avaya platform is now configured to send SIP calls to Mindful via the configured Call Center Phone Number!

Configure Avaya to receive callbacks

Similar to inbound calls, you will need to update the configuration in System Manager to handle callbacks received from Mindful.

When a SIP call arrives from Mindful, Session Manager will receive an INVITE to the Call Center Phone Number configured for the Call Target.

Create a Dial Pattern in Session Manager

Elements > Routing > Dial Patterns > New

Use the graphic and steps below to configure a Dial Pattern to route calls from the Call Center Phone Number to CM:

dial pattern details
  • Pattern — Select a pattern matching the Call Center Phone Number, as shown in the example.

  • Min/Max — Set this to the exact length of the Call Center Phone Number.

  • SIP Domain — Select "ALL".

  • Originating Locations and Routing Policies — Add the Routing Policy that leads to CM. This Routing Policy should already exist in Session Manager.

In the preceding example, any calls that come into Session Manager from a 9-digit number beginning with 8099 will be sent to CM.

Create a SIP Entity for CM (if needed)

There should already be a SIP Entity configured for CM in your environment. However, you can use the following image and instructions to create one, if needed:

sip entity details

System Manager > Elements > Routing > SIP Entities > New

  • Name — Enter a descriptive name for the SIP entity.

  • FQDN or IP Address — Enter the address of the SBC.

  • Type — Select "CM".

  • Adaptation — Select the Adaptation that you created in the previous section of this guide.

  • Leave all other settings at their default values or the values needed in your environment.

  • Entity Link — Make the following additions to the Entity Link that is already configured for Session Manager:

    • Select your new SIP Entity in the SIP Entity 2 field.

    • Enter 5060 in the Port field next to SIP Entity 2.

    • Select "trusted" in the Connection Policy dropdown menu.

Create the callback call vector

The agent leg of the callbacks from Mindful will be sent in via a SIP request to sip:20062 — the SBC, via URI Groups and a Routing Profile. Session Manager will use a route pattern to send this to CM where 20062 exists as a VDN number using vector 62.

call vector

The queuing vector shown here does nothing more than queue the call to skill at high priority. If any decision making needs to be done on the callback, based on the inbound UUI data (now present on the callback), vector variables can be used to do so.

(Optional) Offer second chance callbacks

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 later 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, 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.

screenshot of a component of the amazon connect integration
  1. Whether offers are made in your ACD or Mindful, 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 for treatment.

Note that you can add logic into the routing script to limit the total number of offers made per call.

Mindful configuration

There are two alternatives for preparing your Mindful organization 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.

If you wish to use a single Call Target for normal inbound calls and second chance calls, you will need:

  • Two phone numbers provisioned for the same Call Target

  • The Offer Choose Hold Call Target setting disabled (offering a hold option in Mindful after a customer has already chosen to leave the holding queue can negatively impact the customer experience)

If you wish to use separate Call Targets for normal inbound calls and second chance calls, you will need:

  • Two Call Targets configured with the same Call Center Phone Number targeting the same group of agents

  • The Offer Choose Hold setting disabled for the second chance Call Target. The setting can still be enabled for the normal inbound Call Target

For either method, you will also need:

  • The ability to capture DTMF input from customers in your holding queue

  • The ability to play audio prompts to customers in your holding queue based on a timer

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.

screenshot of a component of the amazon connect integration
AdvantagesDrawbacks
Call Detail reporting is more convenient.ECBT is not combined between the two Call Targets. Therefore, ECBT on the normal inbound Call Target may be lower than it should be, since the call volume from the second chance Call Target is not included in the calculation.
Real-time monitoring clearly distinguishes the two call types.
You can enable the Offer Choose Hold option on the normal inbound Call Target while disabling it on the second chance Call Target.

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.

screenshot of a component of the amazon connect integration
AdvantagesDrawbacks
Configuration is simpler.When a second chance ASAP callback is registered, it will be placed at the back of the virtual queue (waitlist). This can result in customers who accept second chance offers waiting longer than they would have if they remained in the holding queue.
Offer Choose Hold should not be offered by the Call Target. This can affect your offer strategy for normal inbound calls, which may not be intended.
Reporting on second chance interactions requires additional steps.
Real-time monitoring combines normal inbound callback requests and second chance requests together.

Reporting with separate Call Targets

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.

On the Callback Overview, Executive Summary, and Call Detail pages, 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 page, 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 user interface, and assign both phone numbers to the same Call Target.

    screenshot of a component of the amazon connect integration
  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 page, 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.

When using a single Call Target, the Callback Status, Callback Overview, and Executive Summary pages will combine second chance interactions with initial offers and callers that chose to hold.