Microsoft Teams
XCALLY section | Plugins → Microsoft Teams |
On this page |
Overview
XCALLY Motion allows you to integrate Microsoft Teams as a New Channel through the Open Channel module.
Customers can send and receive direct messages from your Microsoft Teams Official Account.
Agents receive incoming messages in a dedicated Queue and can reply directly from the XCALLY Motion GUI.
Requirements
Valid Azure Subscription
Access to a Microsoft Teams Account with Admin credentials (or MT admin collaboration)
Microsoft Teams Configuration
To setup the XCALLY - Microsoft Teams integration, you must follow the below steps:
create a Bot in Microsoft Azure, add a new client secret and add Microsoft Teams channel
create an Application in Microsoft Teams
install the application in Microsoft Teams
Below you find the full description of each step.
1. Bot creation
Go to
Bot Framework and click on “Create a bot”.
Click on “Create”.
You will be redirected to portal.azure.com.
Scroll down until you see “Load more” in the bottom of the page.
Scroll down and click “Load more” until you see “Azure Bot” from Microsoft.
Click on “Create”
Enter the details:
Bot handle → write a name. No spaces allowed. Recommended to write a name a meaningful name as it can’t be changed later. This is a private name and won’t be seen by customers.
Subscription → choose a valid subscription associated to your Microsoft Account.
Resource group → choose global or a region near your business. Create a new Resource group to access more settings.
Pricing tier → Click on “Change plan” and choose “Free” tier to avoid paying for messages. The Standard price tier only guarantees about messages incoming from Microsoft Teams to XCALLY Motion.
Type of App → Choose Single Tenant when in doubt.
Creation type → Leave selected “Create new Microsoft App ID”
Click on “Review + Create”.
When you follow this procedure on your Azure subscription, two items will be created automatically:
An Azure Bot
An Enterprise App (with the same name as the bot)
Add a New Client Secret
To add a new client secret:
Go in the related Enterprise App and go to the left menu voice “Certificates & Secrets”.
Click on “+ New client secret”.
Click on the blue “Add” button.
Save the “Value”. This will be required later during the Microsoft Teams plugin configuration.
The “Value” string of the client secret will be censored once you leave the page, and it cannot be recovered.
If you lose the Value, you will need to create a new client secret.
Add Teams Channel
To add Microsoft Teams Channel follow the below steps:
Go to the Azure Bot resource in Azure Portal.
Add Microsoft Teams from the Available Channels list.
In Messaging, leave “Microsoft Teams Commercial”.
In Calling, leave blank.
Click on Apply on the bottom bar.
From the Configuration section, set Messaging endpoint to:
https://your.public.domain/api/plugins/webhook?port=3980&path=/api/messagesSave the “Bot Type”, the “Microsoft App ID” and the “Microsoft Tenant ID”. They will be required later during the Microsoft Teams plugin configuration.
Change port and public domain to match the actual domain where it is installed XCALLY Motion V3 and the plugin port (3980 is the default port).
Click on Apply.
2. App creation
As next step, you need to create the App in Microsoft Teams:
Go to the Microsoft Teams desktop app.
Add to Microsoft Teams the app called Developer Portal.
Go to Apps tab.
Click on “New App”, write a name. This will be the public name of the app.
Fill the form.
ID Application must be the same as the App ID of the Enterprise App in the Azure portal.
Click on the menu Capabilities.
Add Bot feature.
The bot ID must be the same as the Azure Bot app ID.
Enable file upload.
Check only “Personal” chat scope.
Go to Publish and choose Package export and download it.
3. User App Installation
As last step, you need to install the App:
Go to https://admin.teams.microsoft.com/ with admin credentials
Go to Microsoft Teams apps
Click on Manage apps
Click on “+ Upload”
In the popup, drag and drop the zip app package made with Developer Portal or click on “Upload” to choose from file system.
When the app is published it can be seen only by users in the same enterprise and it can be found in the app store of Microsoft Teams.
Every user must add the app manually to chat with it or you can make a custom user group policy where the app is already installed and then add users.
Further versions of the app must have a greather version number, example if the current is version 1.0.0, the next must be 1.0.1.
Important Note
After creating and configuring the app, you must wait a few hours before the app is published in Microsoft Teams.
XCALLY Configuration
This section explains how to install and configure the XCALLY Motion Microsoft Teams Plugin interface, allowing your agents to interact with Teams users.
To perform this configuration, you must log in to XCALLY Motion as an Admin.
1. Setup Microsoft Teams Account
Access the Open Channel Accounts section, under Open Channel menu
Create a new Open Channel Account clicking on the Add button
Fill the below fields:
Name: choose a name for your Microsoft Teams Account
Key: enter a specif key (it must different for each channel)
Reply URL:
http://localhost:3980/sendMessage- This URL is going to be used by Open Channel to answer to the interactions.List: Choose the List where the new contacts will be saved in the Contacts Manager. If a contact is already present in the List, the new interaction will be associated and reported in the Customer Journey.
Description: (Optional) Describe to which bot the channel is associate.
Find the Microsoft Teams Account, that you have just created, in the list of Openchannel Accounts
Click on the three dots button next to the Microsoft Teams account and select Edit Open Channel account.
Check the information and complete the Microsoft Teams Account configuration. On the top of the screen, you can see the ID Account (the number that follows the # ).
Save the Open Channel Account ID – This will be required later during the Microsoft Teams plugin configuration.
2. Setup Microsoft Teams Queue
To enable agents to receive notifications from the Microsoft Teams account and manage interactions, you must configure a specific Queue.
Create a new Open Channel Queue for Microsoft Teams.
Add agents or teams to the Microsoft TeamsQueue.
Associate the Queue with the corresponding Account.
Please refer to the Open Channel Queues documentation.
3. Generate API Key
Plugins, such as Microsoft Teams, are connected to XCALLY Motion using an API Key.
To generate the API Key:
Go to the Staff section
Open the Users section
Select the account of interest and press on the three dots button to Edit it.
Click on the API Key Manager Icon:
Generate the API KEY. If the API KEY has been already generated, you just need to copy it.
Copy the API Key. This will be required later during the Telegram plugin configuration.
Upload the Plugin to XCALLY Motion
XCALLY Motion does not support two or more identical plugins, concurrently active. For more information, please contact us via Support Portal.
Follow the below steps to upload the plugin:
Download the Microsoft Teams Plugin zip file: https://repository.xcally.com/repository/plugins/teams-plugin/teams-plugin-v2.0.0.zip
Open the App Zone section → Plugins
Upload the Microsoft Teams Plugin clicking the plus button, choosing the zip file and clicking on Confirm
After the upload, you will find the plugin in the list of the uploaded App Zone Plugins
To Install the plugin, click on the three dots button next to the plugin and click Install plugin
Click on the three dots button next to the plugin and click Edit plugin.
In the Sidebar field, select how and to whom this integration should be displayed in the menu. (default value: Admin Only)
5. Configure the Plugin
To configure the Plugin for Microsoft Teams:
Access the Plugins section and select Microsoft Teams Openchannel.
Fill and check the fields:
Webhook (XCALLY Motion Omnichannel):
http://localhost:9000/api/openchannel/accounts/ID-CHANNEL/notify, where the 'ID-CHANNEL' is the Openchannel Account ID previously saved.API Key (Admin): Insert the API Key previously saved
Port: Plugin port (choose a different port for each plugin)
URL (public) XCALLY Motion: Enter the public XCALLY Motion URL
Proxy token: If necessary, insert the proxy token.
Teams
Microsoft app ID: Insert the Microsoft app ID previously saved
Microsoft app password: Insert the Microsoft app password (Value) previously saved
Microsoft tenant ID: Insert the Microsoft tenant ID previously saved
Microsoft app type: Insert the Microsoft app type (Bot Type) previously saved
Unsupported type of message text: Message that appears to your Customers in case of unsupported message
File too big: Message that appears to your Agents in case the attachment sent by the Customer is too big for Motion to handle
After the changes, remember to Restart the Plugin:
Go to the App Zone section
Find the Microsoft Teams plugin and click on the three dots button next to the plugin
Choose the Restart plugin command.
The Microsoft Teams Integration is ready to be used!
Agent experience
The following screenshot illustrates the communication between:
Microsoft Teams User – Sends messages to the Teams App you created.
Agent – Manages and replies to these messages directly from the XCALLY Omnidesktop Interface
Note that:
Motion supports attachments up to 15 MB.
Text or attachments can be exchanged: they must be sent in different messages.
Debugging and Troubleshooting
All of the log files for Microsoft Teams plugin events are available at /var/log/xcally/ directory under openchannel-teams- naming convention.
Place a reminder every 2 years to change the Secret ID and Secret Value of the Enterprise App in the Azure Portal.
Change the messaging endpoint in the Azure Bot if you moved XCALLY Motion server instance to another domain.