Table of Contents |
---|
...
Perform the following steps to build a Microsoft Teams bot app via the Microsoft Teams Developer Portal.
- Find and add Developer Portal to your Microsoft Teams.
- Launch and log in your Microsoft Teams client.
- Click the Apps icon at the bottom left of your Microsoft Teams window to open the Apps panel.
Figure: Apps Panel - Use the search bar to search for Developer Portal.
Figure: Developer Portal - Select Developer Portal.
- Click Add.
Figure: Add Developer Portal
You can see the home page of Developer Portal.
- Create a new app.
- Click Apps at the top of the home page of Developer Portal.
Figure: Apps Panel - Click New app.
Figure: Create a new app - A dialog box prompts to specify a short name for your app that is used for configuration in Digital Agent as the bot username. Mention the name for the bot username.
- Click Add.
Figure: App Name - Specify the required values for your app, and click Save.
Figure: New App Panel- In the Descriptions fields, specify a short description for your app.
Figure: App Descriptions - Mention all the mandatory information accordingly.
Figure: Dev information and App URLs
- In the Descriptions fields, specify a short description for your app.
- Click Apps at the top of the home page of Developer Portal.
- Configure your app.
- Switch to Apps panel and select the app that you created.
Figure: Select App - Navigate to Configure > App features.
- Select Bot.
Figure: App features Locate your bot in Identifyyour bot section.
In the bot settings, choose Personal, Team and GroupChat for Scope to enable your bot app for various types of chats.
Save your settings and you can see your bot in the Bots panel.
Note title Note You need to create a bot if you don't have one. You can either create a bot with Microsoft Bot Framework or with Microsoft Azure. For specific steps, see Creating a bot with Microsoft Bot Framework or Creating a bot with Microsoft Azure.
- Switch to Apps panel and select the app that you created.
- Publish your app.
- Navigate to Publish > App package.
Figure: App package - Click Download app package.
Figure: Download App package - Navigate to Apps. Click Manage your apps.
Figure: Manage Apps - Click Upload an app.
Figure: Upload App - Select Upload a custom app to add the app to a team. Upload the app package that you downloaded in sub-step b.
Figure: Upload custom App - Select Add to a team from the drop down menu.
Figure: Add to a team - Type or select a team to set up your bot.
Figure: Set up a bot
- Navigate to Publish > App package.
- Optional: You can also choose to publish your app to your organization's app catalog, so that it is shareable within your organization.
- Navigate to Apps > click Manager your apps.
Figure: Manage your Apps - Select Submit an app to your org to publish your app.
Figure: Submit app
Your app will appear on your Apps homepage after the IT admin of your organization approves.
Figure: App Catalog
Now, people in your tenant can see this app and can use it.
- Navigate to Apps > click Manager your apps.
Creating a bot for Microsoft Teams bot app
Microsoft offers two ways to create a bot. Microsoft Azure or Microsoft Bot Framework are the two options. Select any one of them as per the requirement.
- Creating a bot with Microsoft Bot Framework
You can create a Microsoft Bot Framework bot for your bot app using the Microsoft Developer Portal tool. - Creating a bot with Microsoft Azure
You can use Microsoft Azure portal to create a resource using the Bot Channels Registration service, configure the resource, obtain the bot password, and setup channels in order to create a bot with Microsoft Azure.
Anchor Bot_with_MS Bot_with_MS
Creating a bot with Microsoft Bot Framework
Bot_with_MS | |
Bot_with_MS |
Use the Microsoft Developer Portal tool to create a bot with Microsoft Bot Framework. Then, set it up for your bot app.
...
- Create a new resource.
- Search for Azure bot in the search bar and select it.
Figure: Azure bot - Click Create to create a new resource.
Figure: Create Resource - Bot Channels - 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.
- Search for Azure bot in the search bar and select it.
- Configure the resource.
- 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.
- Set up the bot for your bot app in Microsoft Teams.
...
If the IP address of Digital Agent server is public, you can use the Chatbot messaging-endpoint URL <https://devdigitalagentwb.symphonysummit.com/api/v1/messaging/webhooks/digital-agent/teams> directly. Otherwise, you must configure your own network firewall or use some proxy servers to make sure that your MS Teams can access the web hook of Digital Agent server from Internet.
Note | ||
---|---|---|
| ||
You can find the values for protocol, hostName, port, and basePath messaging-endpoint URL <https://devdigitalagentwb.symphonysummit.com/api/v1/messaging/webhooks/digital-agent/teams>. Where,
|
...
- Click Bot management.
- Choose the bot that you created and start editing your bot app.
Figure: Bot management
Figure: Select bot - Click Configure.
Figure: Configure messaging endpoint - Specify the Bot endpoint address input box under Endpoint address with the Digital Agent web hook URL if it is publicly accessible. Otherwise, you must fill in with your public proxy URL that transmits network payload to Digital Agent web hook URL.
Figure: Bot endpoint address
Configuring messaging endpoint for the Microsoft Azure bot
...
- Launch the Microsoft Azure portal at portal.azure.com.
- Click All resources and select the bot that you created.
- Navigate to Settings > click Configuration.
- Specify the Messaging endpoint with the Digital Agent web hook URL if it is publicly accessible Otherwise, you must fill in with your public proxy URL that transmits network payload to Digital Agent web hook URL.
- Verify that the Enable Streaming Endpoint box is enabled.
- Click Apply.