Engati - User Guide
Deploying the bot

Microsoft Teams

14min

Microsoft Teams is a popular platform for workplace communication and collaboration. Deploying your Engati bot on Teams allows your coworkers to access it directly within your organization's Teams accounts for assistance.

Key benefits of deploying on Teams include enabling employees to get quick answers, integrating bot features into collaborative workflows, and providing a unified experience within Teams. Users can interact with your bot in Teams channels, chats, and meetings to get questions resolved, automate processes, and more.

To deploy on Teams, you need an organizational Outlook account and access to Microsoft portals. The setup involves linking your account, registering an app, and configuring bot permissions in Azure. Certain Engati features like identity, webviews, file upload, and carousels are not supported within Teams currently due to platform limitations.

Setting Up

Step 1: Navigate to Configure > Deployment > Microsoft Teams

Document image


Step 2: Navigate to the URL https://dev.botframework.com/bots/new and Sign In to the Microsoft Account

Step 3: Fill in the details for Bot profile. For your convenience, we have provided descriptions for each field, indicating the values to enter in each.

Document image

  • Display Name : Enter the name you want give to your bot.
  • Bot Handle : Here, you'll need to input the Key Identifier of the bot. To find the Key Identifier, switch to the Engati portal and go to Configure > Bot Details > Key Identifier.  Note: Ensure that different Key Identifiers are used to create different apps in Microsoft Teams.
Document image

  • Long Description : Give the description about your bot.

Step 4: Enter the Messaging endpoint, which is the Endpoint URL located on the Engati portal under Configure > Deployment > Microsoft Teams.

Document image


Also check the box to "Enable Streaming Endpoint". Once entered, click on "Create Microsoft App ID and password".

Document image


Step 5: You will be redirected to Microsoft Azure portal, click on ‘New registration’ at the top left corner of the page.

Document image


Step 6: Enter the name of the application, Select "Accounts in any organizational directory and personal Microsoft accounts" and then click on "Register", to complete the registration.

Document image


Step 7: Go to ‘Certificates & Secrets’ from the front left navigation bar and click on "+New Client Secret". Select the expiry date as 24 months and click Add.

Document image


Step 8: Copy the generated password from ‘Value’ and paste it into the ‘App Secret’ field on the Engati Bot Platform.

Document image


Step 9: Navigate to the Overview tab in the top left corner, copy the Application (client) ID and paste it into the App ID field on the Engati portal.

Document image


Step 10: Once you have entered App ID and App Secret, save the changes in the Engati Portal.

Document image


Step 11: Switch back to Bot Framework portal and enter the Application ID in App ID under Configuration from Microsoft Azure portal > Overview > Application ID.

Document image


Step 12: Check the "I Agree that...." button and click on "Register".

Step 13: Click on "Configure Microsoft Teams Channel".

Document image


Step 14: Select "Microsoft Teams Commercial (most common)" and click on "Save".

Document image


Step 15: Navigate to the developer portal : https://dev.teams.microsoft.com/apps. Click on ‘+New App’ and assign a name to your app.

Document image


Step 16: Copy the Application (client) ID from the Microsoft Azure portal https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade and paste it into the Application (client) ID field on the Developer Portal https://dev.teams.microsoft.com/apps.

Document image


Step 17: On the developer portal (https://dev.teams.microsoft.com/apps) fill in the basic information such as description fields, Developer information, and App URLs.

Document image


For your convenience, we have provided values to enter in each field.

For Developer Information : Developer or companies name - Engati Website URL - https://www.engati.com/

For App URLs :

Document image


Once you are done filling in the required fields, click on "Save".

Step 18: Navigate to Permissions and enable the permisions mentioned below and click on "Save".

Document image

Document image

Document image


Note - Not more then 16 permissions should be enabled.

Step 19: Navigate to App Feature and enable Bot, Message extension and Personal app.

Document image


For enabling Bot as App Feature, select the bot created bot from the dropdown menu. Enable the following options and then click on "Save".

Document image


For enabling Message extension, select the bot created bot from the dropdown menu. Then click on "Save".

Document image


For enabling Personal app, click on the three dots besides Chat and select "Move down". Then click on "Save".

Document image


Step 20: Navigate to Publish to org and click on "Publish your app".

Document image


Once the created app on Microsoft Teams is approved from the the Admin Portal of that organization. Our Engati portal is deployed on your Micrsoft Team Successfully!

MS Teams capture email and other details:

You can now capture email IDs and other details from MS Teams by deploying our Engati bot. To deploy the bot on MS Teams you can follow the steps given in our Help Doc.

Steps to check the captured Email IDs and other details are as follows:

  1. After Deploying the bot on MS Team, log in to our Engati app porta
  2. Select the bot that has been deployed on the MS Teams.

Document image


3. In the left navigation bar, go to Users > User List.

Document image


4. Select the user whose details you want to view.

Document image


5. In the custom attributes section, you will find all the captured details about the user.

Document image


Note : For the app to show up in the Microsoft Teams Apps section, it may some time. This time can vary from a few hours up to a day. For further help on the app showing up, you can also reach out to the Microsoft support team via your Microsoft Admin Portal https://admin.teams.microsoft.com/

App Not Showing Up in Apps Section: Troubleshooting Steps

If you have created an app but it does not appear in the Apps section of Microsoft Teams even after a few hours. In such cases, you need to grant the necessary permissions to the app from the Microsoft Admin Portal.

Step 1 : Access your Microsoft Admin Portal (i.e. https://admin.teams.microsoft.com/ ) and navigate to the Teams App section. Here, select the "Manage App" option.

Step 2 : Locate the app you have created from the list of apps.

Step 3 : Once you have found your app, click on it and navigate to the "Permissions" tab.

Step 4 : In the Permissions tab, you will find a button labeled "Grant Admin Consent." Click on this button to authorize the required permissions for your app.

Document image


Step 5 : After clicking the "Grant Admin Consent" button, a pop-up window will appear. Click on "Accept" in this window to confirm the permissions.

Document image


Note : For the app to show up in the Microsoft Teams Apps section, it may some time. This time can vary from a few hours up to a day. For further help on the app showing up, you can also reach out to the Microsoft support team via your Microsoft Admin Portal https://admin.teams.microsoft.com/

If you face any issues or queries please reach out to us at [email protected].

Updated 04 Nov 2024
Doc contributor
Doc contributor
Did this page help you?