Luware Knowledge

Nimbus Portal Nimbus Admin Nimbus Release Notes Luware Cloud Status
Home Nimbus Use Cases Administration Use Cases

Use Case - Setting Up Interact

Learn how to set up your Interact web presence step by step.

On this page, we're going through an example setup for your own Interact web presence, covering the following steps:

PRECONDITIONS

✅Before you start

  • This Use Case is a follow-up to Use Case - Setting Up Instant Messaging. Refer to it for general and licensing preconditions on your tenant.
  • For this Use Case to work, the Instant Messaging modality must be enabled on your tenant. If this hasn't been done already, please get in contact with your Luware Customer Success specialist to discuss terms and License Management details.

✅User Permissions

  • Tenant Admin rights are required to create and update tenant, user, and service settings.
  • Delegated Tenant Admin permissions are required to grant Nimbus App Permissions once via grant link. 
    🔎This link can be found under Modalities Tenant > Modalities Tab > Instant Messaging > “Grant Permissions”.

✅Additional users

  • You need a dedicated O365-user (teams license assigned) on behalf of which Teams meetings will be created. This user needs to have a proper Access Policy assigned.
  • You also require Web developer privileges on your homepage to embed Interact widget codes wherever you want to allow customers to interact with your Nimbus services or users.

✅ Data access

  • By default all Instant Messaging data is routed through Nimbus ACS (Azure Communication Service) instance
  • OPTIONALLY you can bring your own dedicated ACS instance. → The setup steps for this are explained below.
 

🔎GOOD TO KNOW: Before you start

Supported Modalities

Audio/Video Instant Messaging Luware Interact can be licensed and configured to handle multiple incoming modalities: 

Modality
Nimbus Distribution
 Customer touchpoint scenario

Either handed directly by a user

OR 
distributed according to the service's Audio/Video Workflow.

 Customers use an Interact widget on your website where they can configure their headset, webcam, and screen sharing options.
Either handed directly by a user
OR 
distributed according to the service's Instant Messaging Workflow.		 Customers use an Interact widget on your website where they can provide a name, an email address, and an initial message, and start chatting.

Individual User / Service configuration

💡You can configure either modality independently per service and user. If not marked further, steps are generally applicable regardless of modality.

🔎Depending on your scenario, refer to Nimbus Features (respectively for users / services) and do not hesitate to contact your Customer Success partner to define the best approach to your setup and License Management.

☝Note: Unless stated otherwise, all setup steps below cover both service / user touchpoint scenarios. Any specific instructions are divided into “for users / services” tabs respectively.

 

INC Icon Legend Accordion

Show Icon Legend

💡 = A hint to signal learnings, improvements or useful information in context. 🔍 = Info points out essential notes or related page in context.
☝ = Notifies you about fallacies and tricky parts that help avoid problems. 🤔 = Asks and answers common questions and troubleshooting points.
❌ = Warns you of actions with irreversible / data-destructive consequence. ✅ = Intructs you to perform a certain (prerequired) action to complete a related step.
 
 

Enable Interact on your Tenant

  1. Navigate to Nimbus Admin > Tenant Administration.
  2. In the Extensions tab, go to section Interact.
  3. Enable Interact for your Tenant.
  4. Specify the following Interact settings:
    1. ACS Connection string (from the ACS instance which was created)
    2. O365 User ID (newly created Azure EntraID User with a proper Teams License) → ✅ See Preconditions.
    3. Widget Key (autogenerated)
    4. Session Recovery Timeout in Seconds
    5. Authorization. → 🔍Follow Use Case - Enabling Additional Authorization for Interact when you want to implement token-based authentication.
  5. Save the changes.

Optional: Bring your own ACS instance

💡Note: Out of box, Nimbus will provide you with an Azure Communication Services endpoint. However, you can make use of your own dedicated ACS (Azure Communication Services) instance from Azure.

 
  1. Navigate to Nimbus Admin > Tenant Administration
  2. In the Modalities tab, go to section Interact.
  3. Locate the "Instant Messaging" section. 
  4. Enable "Use your own ACS Instance" and provide the ACS connection string and resource ID.

    Learn how to get this ACS connection string

    INC ACS Instance Setup

    INC ACS Instance Setup

    The following steps describe how an ACS instance can be setup. Which is required for Nimbus Assistant and/or Interact.

    INC Interact Azure Billing

    AZURE BILLING

    The usage of Interact will cause additional monthly ACS (Azure Communication Services) costs depending on modality (IM/AV) used. These cost are determined by Microsoft. Also see: https://learn.microsoft.com/en-us/azure/communication-services/concepts/pricing

    • Before enabling additional modality features for your services, get in touch with your Luware Customer Success specialist to discuss terms, usage scenarios, and necessary setup procedures.
    • Please note that Nimbus and Interact support does not cover pricing discussions or make recommendations based on the Microsoft Azure infrastructure.
     

    Create new Azure Communication Service

    To create a new Azure Communication Service perform the steps:

    1. Head to Azure Portal and login with tenant admin rights.
    2. Search for "Azure Communication Service" component and click "Create".   
       
      ☝ Make sure not to use any underline/underscores within the name.
    3. Switch to the Keys tab and copy the connection string  

     

     

     
     
  5.  Additionally, you need to setup an ACS Event subscription.

    Learn how to set up an ACS Event Subscription

    INC Setting Up an ACS Event Subscription

    1.  Go to your created ACS instance and select Events.
    2.  Create an event subscription with the Event Grid Schema.
    3.  Choose a suitable System Topic Name (no impact).
    4.  Select the following filters:
      1.  Chat Message Received
      2.  Chat Message Edited
      3.  Chat Message Deleted
      4.  Participant Added To Chat Thread
      5.  Participant Removed From Chat Thread
    5.  The endpoint type needs to be Web Hook.
      1.  The URL needs to contain as base URL your Cluster and as suffix /api/acs-driver/v1/events
    6.  Go to the Overview tab, select the JSON View, and copy the immutableResourceId into the Nimbus Admin.
     
     

Provisioning via Microsoft PowerShell - After the tenant configuration is completed, your need to run the Nimbus provisioning script in order to get the changes applied.

 

Instant Messaging user account setup

💡Note: Nimbus / Interact uses guest accounts to track the status of your other Nimbus user's availability in MS Teams. Luware will provide these 

 
  1. Go to Modalities Tenant Settings.
  2. In the Modalities tab, go to section Interact. Ensure Interact is enabled.
  3. Depending on the option “Use your own accounts” follow the steps below:

Either Case A (Use the Luware accounts) or Case B (Bring your own Instant Messaging account). 

✅ In either case, you need to “Grant Permissions” to the Nimbus App to send Instant Messages.

Case A: Luware guest accounts on your tenant

 

Case B: Bring your own Instant Messaging account

 
 

This solution uses 2 guest accounts provided by Luware. You will be performing these tasks in tandem with Customer Success.

 
  1. Invite the external guest account users for IM on your tenant. 

    Learn how to invite external accounts to your tenant

    INC Invite Azure Guest Accounts

    1.  As Tenant Admin, log into your Azure Portal.
    2. Go to Users > New Users and select “Invite external User”.
       
    3. Invite both guest users 1&2 on your tenant. Add each of the previously copied email addresses (e.g. svr_nimbus_guest@onmicrosoft.com) and click Invite.
      ⮑ A standard Azure invite mail will be sent out to Luware.

      ☝ Note that MFA (Multi Factor Authentication) needs to be disabled for these users. Otherwise, this feature will not work as the guest users cannot sign in to your tenant.
    4. Let your Customer Success Specialist know that the guest users have been invited.
    5. Please wait while steps are done in the background:
      1. Luware cloud operations team must accept the guest invitations. Please allow for some time for this to happen.
      2. Once successful, the "Account is not added as guest" message should disappear on your side in the Nimbus admin UI.
      3. If this is not the case, please get in contact with the Luware support.
     
     
  2. As Tenant Admin: Inform your Customer Success partner about the pending user user invite.
    💡 This invitation needs to be accepted by us before usage is possible on your side.
  3. After receiving the confirmation from Customer Success and having permissions granted on your behalf, you can use the Test UPN field to send messages to any user on your tenant (e.g. a future chat message recipient acting as service user).
 

✅ For this solution, you need to have at least one dedicated service account ready, fulfilling the following requirements:

  • A valid Teams license, with no MFA enabled and no password policy.
  • Ideally a second account with the same settings should be used as fallback.
 
  1. Navigate to Nimbus Admin > Tenant Administration.
  2. Go to the Modalities tab.
  3. Locate the "Instant Messaging" section.
  4. Enable the “Use your own account” toggle.
  5. Fill in the UPN and the password.
  6. Save your changes.
  7. When accounts are configured and the permissions granted, you can use the Test UPN field to send messages to any user on your tenant (e.g. a future chat message recipient acting as service user).
Tenant Administration: Use of own accounts for Instant Messaging

 

 

Configuring a Domain Template

Domain templates define where Interact widgets are allowed to be used on the web, so that no external websites can "redirect" traffic to your services. Templates can be applied to either users or services independently. To define templates, perform the following steps:

  1. Navigate to Nimbus Admin > Configuration > Interact Domain Templates (CORS).
  2. Click Create new.
  3. Enter a name and select the relevant Organization Unit.
  4. Specify Domain name(s) on which you want to allow Interact usage (whitelist).
  5. Click Create.

Restricting Access (CORS)

The previously created domain template needs to be applied to either users or services.

☝Please Note: CORS templates with the same or a higher Organization Units level as your user/service may be available for selection. Ensure you do not select the wrong template (e.g. provided by a higher OU level administrators) or your embedded widgets may not work.

For users

  1. Navigate to Nimbus Admin > users and select the user.
  2. Enable Interact license for the user and click Save. 
    ⮑ The Interact tab appears.
  3. Go to the Interact tab and activate Interact.
  4. In section Restriction, enable Restrict Access. 
     💡You can skip this and the next step if you don't want to apply domain templates to the user.
  5. Select the previously created CORS-Domain-Template in the Domain Template dropdown list.
  6. Click Save.
 
 

For services

✅Your Service has either an Enterprise or a Contact Center license applied.

  1. Navigate to Nimbus Admin > Services.
  2. Select the service you want to enable Interact for.
  3. In General Service Settings, assign an Interact license for the service.
  4. Click Save & Apply. 
    ⮑ The Interact tab appears.
  5. Go to the Interact tab and activate Interact.
  6. In section Restriction, enable Restrict Access. 
     💡You can skip this and the next step if you don't want to apply domain templates to the service.
  7. Select the previously created CORS-Domain-Template in the Domain Template dropdown list.
  8. Click Save & Apply.
 
 

Creating Service and Direct System Messages

💡This step is optional and only necessary if you want to add Service System Messages to your service or Direct System Messages for users.

System Messages are message templates for messages displayed to the customer and user before, during, and after the session, e.g. a welcome message for the customer, or an informative message for the user on the Adaptive Card.

For users

  1. Go to Nimbus Admin > Configuration.
  2. Select Instant Messaging > Direct System Messages.
  3. Click Create New.
  4. Fill out the tabs as follows:

INC Direct System Messages

General

  1. Give your Direct System Message a name and select the Organization Unit.
  2. Optionally, add a description.
  3. In the User dropdown, select how you want to display the user's name for customer. You can can either display the user's current display name or define a custom name.
 
 

Messages to User

In the tab Messages to User, you can define messages that are displayed to the user when an instant message is coming in, handled, or terminated, using Direct Conversation Parameters:

 
 

Messages to Customer

In the tab Messages to Customer, you can define messages that are displayed to the customer when getting connected to the user or ended by the user:

 
 
 
 

For services

  1. Go to Nimbus Admin > Configuration.
  2. Select Instant Messaging > Service System Messages.
  3. Click Create New.
  4. Fill out the tabs as follows:

INC Service System Messages

General

  1. Give your Service System Message a name and select the Organization Unit.
  2. Optionally, add a description.
  3. In the User dropdown, select how you want to display the task handling agent's name that is in the chat with the customer.
  4. In the Service dropdown, select which service name you want to display for the customer.

    In the example below, our service is called Documentation Team:
 
 

Messages to User

In the tab Messages to User, you can define messages that are displayed to the agent when an instant message is coming in, handled, or terminated, using both custom parameters and System Fields and Parameters:

 
 

Messages to Customer

In the tab Messages to Customer, you can define messages that are displayed to the customer when getting connected to an agent or ended by the agent:

 
 
 
 

Interact to Service/user Settings

☝This step is required if you want to distribute instant messages to either users and/or services. You can freely combine both options.

 

For users

Configure your user for IM

  1. Go to Admin > Users
  2. Select the user.
  3. In the “General” Tab, ensure “Interact” is enabled. 
    ⮑ This will show the “Interact” tab for the user.
  4. In the Interact Tab:
    1. Ensure that “Interact” is enabled.
    2. Set “Instant Messaging" is enabled.
    3. OPTIONAL, In the “Direct System Messages” dropdown, select a direct system message created previously in the chapter above. 
      💡⮑ This message configuration is shown to all users and customers during to a chat session when engaging directly with each other.
    4. OPTIONAL: Apply CORS Templates 

Teams App Setup Policy

✅Teams Administrator: Within Microsoft Teams Admin Center, you need to enable Upload custom apps for Nimbus. Otherwise, sending messages via the Nimbus bot might not work. You can create a separate Nimbus App Setup Policy for this or configure your global policy accordingly. For this example, we created a separate App Setup Policy for Nimbus.

🤔 Why is this necessary? As no service can distribute the IM task in this scenario, Nimbus instead uses a chatbot to post Adaptive Cards directly to users, effectively allowing them to accept/decline/terminate incoming Instant Messaging sessions. However, this chatbot requires consent on each user's behalf.

  1. In Microsoft Teams admin center, go to Teams apps > Setup policies and select the Nimbus App Setup Policy.
  2. Enable Upload custom apps.
  3. Optionally, enable User pinning. 
  4. Save the configuration.

Assign the App Setup Policy to your IM users

✅Teams Administrator: Now, the Nimbus App Setup Policy needs to be assigned to all Nimbus IM users.

  1. In Microsoft Teams admin center, go to Users > Manage Users and select the user you want to assign the policy to.
  2. Click Edit. 
     
    ⮑ A popup will appear on the right-and side.
  3. In the Select App setup policy dropdown, select the Nimbus App Setup Policy. 
  4. Click Apply.

Instruct your users for direct Instant Messaging

 Service Owner / Admin - Please Note

✅When using Interact widgets for a direct-to-user communication, note that … 

  • … Adaptive Cards are now a requirement. Every newly added user (or Contact Center Agent) that handles instant messages must grant this permission to the Nimbus bot once, as MS Teams will otherwise block the communication. For these reasons …
  • … you need Instruct users to register with the IM chat bot1. This is done via Nimbus Portal > User Preferences or a consent link. Detail instructions are below.

1💡Good to know: Chat interactions received and distributed via service (e.g. shown in My Sessions, Attendant Console, or Assistant UI) do not require the IM Signaling Bot registration, as Nimbus handles the distribution with admin-delegated permissions.

 
  1. As an administrator: 
    1. Within the User Administration > Interact tab, check if the user has registered with the bot. On any new user this will most likely be the case. 
    2. You can send the registration link to the user directly or ask your user to perform the steps below.
  2. As the (future) Nimbus user:
    1. Either open the link sent by the administrator or head to User Preferences (Portal) and register with the bot yourself as described below:
    2. Click the link next to the “Not Registered” warning icon.
      ⮑ This will open MS Teams with the Bot as target and a predefined message. 
    3. In order to get registered, you need to send a message to the bot.
      ⮑ After registration, the bot is ready to invite via Adaptive Cards whenever a customer chat request is coming in via Interact.
      ⮑ You can now let the Admin know you are ready to receive Instant Message tasks.
       
 
 

For services

Configure Your Instant Messaging Workflow

  1. Navigate to Nimbus Admin > Configuration.
  2. Select Workflows > Workflows.
  3. Click Create New.
  4. As Workflow Type, select Instant Messaging.
  5. Name your workflow and pick an Organization Unit that is equal or higher to your IM-handling service. 
  6. Design your workflow in the editor.💡Refer to Workflow Activities for a full list.
    1. Start with "Accept Conversation" and a "Message" activity to welcome your customer.
    2. Follow up with a "Queue Task" activity to assign the IM task to the queue of your service.
    3. Once the queue limit is reached, don't forget to use "Cancel Task", and "Disconnect" the user as you would in a call. 
      💡A friendly "Sorry" message goes a long way for your customers.

Configure your service for IM

💡Now, it's time to apply your new workflow.

  1. Navigate to Nimbus Admin > Service Settings.
  2. Select your service. Ensure that it has a Contact Center license assigned.
  3. Go to the tab Modalities (Modalities Service Settings).
  4. Enable Instant Messaging. 
    ⮑ A new section “Instant Messaging” appears. If you don't see it, scroll down to the end of the page.
  5. In the “Instant Messaging Workflow” dropdown, select your newly created Instant Messaging workflow from the previous step. 
  6. OPTIONAL: In the “Service System Messages” dropdown, select a service system message created previously in the chapter above. 
    💡⮑ This message configuration is shown to all users / customers during to a chat session when engaging with the service.
  7. Head over to the tab Interact (Interact Service Settings) and enable Interact by switching on the toggle.
  8. Enable "Instant Messaging" and other modalities you want to allow in the service.
  9. Finally, copy the service snippet (in the section “Integration”) and paste it into your website once you are ready to go live. 
Clicking Preview opens the Interact integration preview for your service.

Prepare your users service-distributed Instant Messaging

💡Finally, you need to ensure that users are part of the service and can handle incoming instant message tasks.

  1. Go to Admin > User Administration.
  2. In General User Settings, enable Instant Messaging for each user you want to allow to handle IM tasks. 
  3. Navigate to Nimbus Admin > Service Settings.
  4. Select your service and go to the tab Users.
  5. Ensure that at least one user with an assigned “Instant Messaging” modality license is added to the service in order to receive the IM tasks.
    💡The IM modality is enabled on the user's General Settings tab.
     
 
 

Testing your Integration snippets

✅Tenant Admin / Website Admin: 

The final step for setting up Interact is to copy and test snippets for your services and users to your customer-facing homepage. The procedure for both services and users If you do not have the expertise, ask your web administrator to embed the widget snippets for you.

 
  1. In the Interact tab (either in Interact User Settings for users or Interact User Settings for services), go section Integration 
  2. Click Preview.
    ⮑ A mockup website with the Interact functionality opens. This is how it will look like for the customer.
  3. If you are satisfied with the preview, copy the HTML code snippet and insert it into your website. 
    💡Keep in mind: 
    1. Users and services have individual IDs and widget keys. Make sure not to mix these details when pasting them on your website.
    2. When you applied Interact Domain Templates (CORS) earlier in this Use Case, remember that the restrictions can be applied to both users or services.
  4. ⮑ All users (behind a service or standalone) should now be able to chat with outside customers. Test the chat interaction via your website. 
    🔍 Refer to Call Handling and Instant Message Handling to see how the interaction looks like on the Nimbus Portal UI.

Troubleshooting

🤔 Preview or embed code not working? Check if:

✅Prerequisites check: 

✅Configuration check:

  • Interact is enabled on Tenant Level within the Tenant Administration.
  • Interact is enabled for the service or user respectively.
  • All relevant configuration items and service / user settings have been saved at least once so they are effective,.

✅Access and permission check:

 

Known Limitations

INC Known Interact Limitations

KNOWN INTERACT LIMITATIONS

  • Interact has certain JavaScript calling limitations in regards to operating systems and browsers. Refer to the official MSFT documentation.
  • Audio/Video Calls initiated from Interact have the following workflow limitations:
Workflow Activity Limitations
Transfer

Can only target services. Not supported targets are:

  • external
  • user
  • parameter
Queue "Pickup" distribution type is not supported.
Voice Message Not supported.
Customer Input Sending DTMF over Interact (Client/SDK) is not supported
 
Use Case - Setting Up Instant Messaging

In this Use Case, we're going to tackle the following topics: Cover technical and...

Interact

Enterprise Contact Center This App must be licensed separately per user or servic...

Interact Domain Templates (CORS)

A domain template defines and restricts where the source code of the Interact con...

Use Case - Enabling Additional Authorization for Interact

In this use case, we're going to describe how you can set up an access token to b...

Table of Contents