Microsoft Teams

Integrate with Microsoft Teams so your users can chat to your inGenious AI chatbot using Microsoft Teams. Make sure you have:

  • Your inGenious AI chatbot.
  • Access to Microsoft Azure, with a resource group created for Bot Services.
  • Access to Microsoft Teams, with permission to upload a custom app.

To integrate your chatbot with Microsoft Teams:

  1. Configure a Bot Service in your Microsoft Azure account.
  2. Add a Microsoft Teams channel to the Bot Service.
  3. Add the Bot Service App ID and Client Secret into the inGenious AI platform
  4. Create the app package to upload your chatbot app to Microsoft Teams.
  5. Activate the chatbot in Microsoft Teams.

Let’s look at each of those steps in detail.

Before you start…

This process involves some back-and-forth between your inGenious AI chatbot settings and your Microsoft Azure account. It’s easier if you get yourself set up first:

  1. Open your Microsoft Azure account.
  2. In another tab, open inGenious AI.
  3. Add a Microsoft Teams channel to your chatbot:
    1. Open the team and  chatbot you want to integrate and click Manage.
    2. Click Channels.
    3. Click + Channel.
    4. Click Microsoft Teams.
  4. Open Notepad or another text editor.
  5. Copy the Messaging Endpoint URL from inGenious AI to Notepad.

Step 1: Configure a Bot Service in your Microsoft Azure account

To configure a Bot Service in your Microsoft Azure account:

  1. Create a new Bot Service in your Microsoft Azure account.
  2. Click Bot Channels Registration.
  3. Type a name for your chatbot in the Bot handle.
    The name should only use letters, numbers, underscores and hyphens. Do not use spaces.
  4. Select Free trial as your subscription.
  5. Select the Resource Group and Location you want to use.
  6. Select the F0 pricing tier.
    This is the free pricing tier.
  7. Paste the Messaging Endpoint from Notepad.
  8. Turn off Application Insights.
  9. Make sure Auto create App ID and password is selected.
  10. Click Create.
    Microsoft Azure creates your new chatbot.

For more information, see the Microsoft Azure Bot Services documentation.

Step 2: Add a Microsoft Teams channel to the Bot Service

To add a Microsoft Teams channel to the Bot Service:

  1. In Microsoft Azure, click the new chatbot to open it.
  2. Click Channel.
  3. Under Add a Featured Channel, click Configure Microsoft Team Channel.
  4. Select that you Agree to the Terms of Service.
  5. Click Save.

For more information, see the Microsoft Azure Bot Channels documentation.

Step 3: Add the App ID and Client Secret to inGenious AI

To add the App ID and Client Secret to inGenious AI:

  1. In Microsoft Azure, click Bot Management for your chatbot.
  2. Under Settings, copy the Microsoft App ID to Notepad.
  3. Click Manage next to Microsoft App ID.
  4. Click + New client secret.
  5. Leave the Description blank.
  6. Select Never for the expiry.
  7. Click Add.
  8. Copy the Client Secret to Notepad.
  9. In the inGenious AI platform, paste the Microsoft App ID into the App ID field.
  10. Paste the Client Secret into the App Password field.
  11. Scroll down and click Save.

This may take a minute

It may take up to 60 seconds for inGenious AI to authenticate your Microsoft App ID and Client Secret.

Step 4: Create the app package

Developer recommended

This step requires creating a JSON file. You may need to ask your developer or IT staff to complete this.

To create the app package for Microsoft Teams:

  1. Create a json file with the name manifest.json in a text editor.
  2. Copy the code below into the manifest.json file.
    {
      "$schema":"https://developer.microsoft.com/en-us/json-schemas/teams/v1.5/MicrosoftTeams.schema.json",
      "manifestVersion": "1.5",
      "version": "1.0.1",
      "id": "<>",
      "packageName": "ai.ingenious.bot.<>",
      "devicePermissions" : [ ],
      "developer": {
        "name": "<>",
        "websiteUrl": "<>",
        "privacyUrl": "<>",
        "termsOfUseUrl": "<>"
      },
      "localizationInfo": {
        "defaultLanguageTag": "en-us",
        "additionalLanguages": []
      },
      "name": {
         "short": "<>"
      },
      "description": {
        "short": "<>",
        "full": "<>"
      },
      "icons": {
        "outline": "outline.png",
        "color": "color.png"
      },
      "accentColor": "<>",
      "configurableTabs": [],
      "staticTabs": [],
      "bots": [
        {
          "botId": "<>",
          "needsChannelSelector": false,
          "isNotificationOnly": false,
          "scopes": [ "personal" ],
          "supportsFiles": false,
          "commandLists": [
            {
              "scopes": [ "personal" ],
              "commands": [
                {
                  "title": "<>",
                  "description": "<>"
                }
              ]
            }
          ]
        }
      ],
      "permissions": [],
      "validDomains": [ "ingenious.ai" ]
    }
  3. Replace the value of the id field and botId field with your Microsoft App ID.
  4. Replace <<INGENIOUS_BOT_ID>> with the Chatbot ID of the chatbot you are integrating.

    Where do I get the inGenious AI Team ID and Chatbot ID?

    You can copy your Team ID and Chatbot ID from the General Settings page.

  5. Replace the <<COMPANY_>> fields with your company information.
  6. Replace <<BOT_NAME>> with a name for your chatbot.
    This name will be displayed to users in Microsoft Teams. It must be 30 characters or less.
  7. Replace <<BOT_SHORT_DESCRIPTION>> and <<BOT_LONG_DESCRIPTION>> with a description of the experience your chatbot provides:
    • The short description must be 80 characters or less, and must not include any other app name.
    • The long description must be 400 character or less, and must not contain the short description.
      See the Microsoft Teams Manifest documentation for more information.
  8. Replace <<BOT_ACCENT_COLOUR>> with the rgb hex value of the colour to be used with your chatbot app, and as a background for your icons.
  9. If you want to add pinned default tabs, add them to the staticTabs array.
    See the Microsoft Teams Static Tabs documentation..
  10. Replace <<SAMPLE_SUPPORTED_BOT_UTTERANCE>> with an example command users could send to the chatbot.
  11. Replace <<UTTERANCE_DESCRIPTION>> with an example or description of the command.
    See the Microsoft Teams Bot Command Lists documentation.
    For an example of command lists, see the Microsoft Teams Manifest example.
  12. Save and close the manifest.json file.
  13. Create the icon your chatbot will use in Microsoft Teams as color.png and outline.png.
    See the Microsoft Teams App Packages documentation for more information.
  14. Create a zip file containing the manifest.jsoncolor.png and outline.png files.

For more information on configuring the manifest.json file, see the Microsoft Teams Manifest Schema documentation.

Step 5: Activate the chatbot in Microsoft Teams

To activate your chatbot in Microsoft Teams:

  1. Log into Microsoft Teams.
  2. Click Apps.
  3. Click Upload a custom app.
  4. Upload the zip file you created.
  5. In the search bar at the top of the page, type the name of the chatbot.
    This is the name you used as <<BOT_NAME>> in the manifest.json file.
  6. Press enter.
    Your chatbot is now integrated with Microsoft Teams.

For more information, see the Microsoft Teams Custom App documentation.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.