- 30 Oct 2024
- 6 Minutes to read
- Print
- PDF
MS Teams App Setup New
- Updated on 30 Oct 2024
- 6 Minutes to read
- Print
- PDF
Integrate Digital Agent into Microsoft Teams by creating a bot app and a bot for Microsoft Teams and configuring the messaging endpoint.
Prerequisites
You need to have either the Global Administrator or Teams Administrator roles to integrate Digital Agent with MS Teams. Refer App permission policies for further details.
Set up Azure Bot channel Service - For more information, see here. (Customer needs to register for Azure Bot channel resource. A Microsoft Teams channel is a part of the standard channels and offers unlimited messaging at no cost. For more details, refer Azure Bot Services.)
Set up Microsoft Teams App - For more information, see here. (Customer needs to have required subscriptions for Microsoft Teams App.)
Customer needs to provide Microsoft Graph API Access to look up user in Azure Active Directory to get their profile information. For more information, see here.
The app (Digital Agent) must be published or enabled to have access by the end-user. For more information on how to search and add a required app, refer to Add an App to Microsoft Teams.
The end user email ID must be same for Apex and Microsoft Teams account. The Digital Agent conversation will start only for valid users registered in Apex.
Microsoft Teams integration
You need to register the App, create your bot and create your MS Teams app to integrate Digital Agent with MS Teams.
Following are the steps for integrating Digital Agent with MS Teams:
Create your bot
Create your MS Teams app
To begin with integrating Digital Agent with MS Teams, perform the following steps:
From the left menu, click
to go to Integrations page.
On the Microsoft Teams tile, click Add.
Click Confirm.
A summary of the setup process is displayed on the Get Started page. Click Next to begin app registration.
Creating a bot with Microsoft Azure
The Azure Bot resource service must be used to create a resource, configure the resource, obtain the bot password, and configure channels in order to create a bot with Microsoft Azure.
To create a bot with Microsoft Azure, perform the following steps:
Create a new resource.
Launch the Microsoft Azure portal at portal.azure.com.
Navigate to Azure Services > click Create a resource.
Search for Azure bot in the search bar and select it.
Click Create to create a new resource.
Specify the required values, where:
Bot handler is a unique identifier for your bot. You can set it to be your bot name.
Resource group is a container that holds related resources for an Azure solution. You can create a new one if you don't have one.
Messaging endpoint needs to be configured later. You can leave it blank for now.
Microsoft App ID and password are mandatory fields. Set it as Auto create App ID and password. Otherwise, you can create one manually.
Click Create. It takes a while to complete the creating process. You can see a notice in the Notification at the upper right of the menu bar.
Configure the resource.
Click Go to resource when you see the notification. You can also check the resource from the portal home page. Click All resources to see the one you just created. Select it to start configuration.
Navigate to Settings > Configuration.
Specify the required values for your resource.
Click the checkbox next to Enable Streaming Endpoint to enable it.
Specify the messaging endpoint after installing Digital Agent.
Click Apply.
To get the bot password, click Manage next to Microsoft App ID. Open Certificates & secrets panel.
Navigate to Client secrets > New client secret.
Add a client secret displays.
Specify the description for your resource.
Set the Expires value to 24 months.
Click Add.
The resource details are displayed in the table with Description, Expires, Value, and ID. Your bot's Value is its password. When configuring Digital Agent, save it for later use, as it is displayed only once.
Note:
The Microsoft App ID is the bot ID in the App Studio of Microsoft Teams. You will need it when you configure your Microsoft Teams in later steps.
Configure the channels.
Go back to the resource page. Navigate to Settings > Channels. Now, only Web Chat is listed in the table.
Navigate to Add a featured channel > click Microsoft Teams icon.
Click Save.
Create bot
After registering your application, you need to create your bot to proceed with integration Digital Agent with MS Teams.
To create your bot, perform the following steps:
Login with your admin credentials.
Fill in all the details on the Tell us about your bot page to complete your bot profile.
Copy the generated endpoint from the Create your bot page of Digital Agent Microsoft Teams integration.
Paste the copied endpoint into the Messaging endpoint field under Configuration section.
Select Multi-tenant as the app type.
Copy and paste the app ID.
Click Register.
Navigate to Connect to channels page.
Click Configure Microsoft in the Add a featured channel section.
Navigate to Configure Microsoft Teams page.
Select the relevant options under the Messaging, Calling, and Publish tabs.
Click Save.
Click Next to create your MS Teams app.
Create MS Teams app
After registering your application and creating your bot, you need to create your MS Teams app.
To create your MS Teams app, perform the following steps:
Log in with your admin credentials.
Navigate to Apps tab.
Click New App.
Enter a name and click Add.
Enter app names, app ID, descriptions, developer information, and app URLs on the Basic information page.
Copy and paste app ID into Application (client) ID.
Click Save.
Navigate to Configure section. Select App features and then Bot.
Navigate to Identify your bot page. Select your bot.
Navigate to Select the scope in which people can use this command section. Select Personal, Team, and Group Chat.
Click Save.
In your Digital Microsoft Teams integration, click Finish.
Click Publish.
Publish MS Teams App
Once you create your app is registered and bot and MS Teams app is created, IT Admin will publish your MS Teams app.
Allow and block apps
The Manage apps page is where you allow or block individual apps at the org level. The page displays all the available apps and their current org-level app status. The list of apps includes apps provided by Microsoft, by third-party developers, and by developers within your organization.
To allow or block an app:
Sign into the Teams admin center and access Teams apps > Manage apps.
Select an app from the list of apps. You can search by the name of the app.
Select Allow or Block option.
When you allow (or block) an app on the Manage apps page in Teams admin center, the particular app is allowed (or blocked) for all users in your organization.
View a Request
Sign into the Teams admin center and access Teams Apps > Manage apps.
To view and check the number of requests for each app, sort the requests in the Requests by user column. You can't view the name of the users who requested an app.
To allow an app, select the name of the app and it opens the app details page.
Select Manage requests and complete the steps displayed in the popup dialog. Based on the method used to block an app, one or more of the following steps are required to unblock it:
If the app is blocked using permission policies, allow the app by modifying permission policies.
If the app is blocked for all users, allow the app.
If all apps are blocked for all users, modify org-wide settings.
If an admin allows an app, then Teams doesn't inform the end-user that their request is acted upon. The user can view the app in the Teams Store to check if they can add the app to their Teams client or not. If the app is approved by an admin, users can add it. Alternatively, if and admin doesn't approve the request and dismisses it, then end-users can request it again.
You can now start conversation with Digital Agent through MS Teams.