Skip to content

Latest commit

 

History

History
123 lines (89 loc) · 7.45 KB

README.md

File metadata and controls

123 lines (89 loc) · 7.45 KB
Raw
page_type description products languages extensions urlFragment
sample
This sample app demonstrate is how to upload files to Teams from a bot.
office-teams
office
office-365
Java
contentType createdDate
samples
12/12/2019 13:38:25 PM
officedev-microsoft-teams-samples-bot-file-upload-java

Teams File Upload Bot

Bot Framework v4 file upload bot sample for Teams.

This bot has been created using Bot Framework, it shows how to upload files to Teams from a bot and how to receive a file sent to a bot as an attachment.

This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.

Included Features

  • Bots
  • Adaptive Cards

Interaction with bot

Bot-file-upload

Try it yourself - experience the App in your Microsoft Teams client

Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app manifest (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).

Teams File Upload Bot: Manifest

Prerequisites

  • Intall Java 1.8+ Java
  • Install Maven
  • Setup for Java and Maven Setup
  • An account on Azure if you want to deploy to Azure.
  • Microsoft Teams is installed and you have an account
  • dev tunnel or ngrok latest version or equivalent tunnelling solution

Setup

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

  1. Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

    Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

    devtunnel host -p 3978 --allow-anonymous

  2. Setup for Bot

    In Azure portal, create a Azure Bot resource.

    • For bot handle, make up a name.
    • Select "Use existing app registration" (Create the app registration in Microsoft Entra ID beforehand.)
    • Choose "Accounts in any organizational directory (Any Azure AD directory - Multitenant)" in Authentication section in your App Registration to run this sample smoothly.
    • If you don't have an Azure account create an Azure free account here

    In the new Azure Bot resource in the Portal,

    • Ensure that you've enabled the Teams Channel
    • In Settings/Configuration/Messaging endpoint, enter the current https URL you were given by running the tunneling application. Append with the path /api/messages

  3. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

  4. Update the resources/application.properties file configuration in your project, for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.)

  5. From the root of this project folder: (samples/bot-file-upload/java)

    • Open a terminal and build the sample using mvn package command
    • Install the packages in the local cache by using mvn install command in a terminal
    • Run it by using java -jar .\target\bot-teams-file-upload-sample.jar command in a terminal

  6. This step is specific to Teams.

    • Edit the manifest.json contained in the AppManifest folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string <<YOUR-MICROSOFT-APP-ID>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
    • Edit the manifest.json for validDomains with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.
    • Zip up the contents of the AppManifest folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
    • Upload the manifest.zip to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
    • Add the app to personal scope (Supported app scope)

Running the sample

Note this manifest.json specified that the bot will be installed in "personal" scope which is why you immediately entered a one on one chat conversation with the bot. Please refer to Teams documentation for more details.

  1. Sending a message to the bot will cause it to respond with a card that will prompt you to upload a file. The file that's being uploaded is the teams-logo.png in the Files directory in this sample. The Accept and Decline events illustrated in this sample are specific to Teams. You can message the bot again to receive another prompt. WelcomeCard

  2. You can send a file to the bot as an attachment in the message compose section in Teams. This will be delivered to the bot as a Message Activity and the code in this sample fetches and saves the file. ReadyToDownload

  3. You can also send an inline image in the message compose section. This will be present in the attachments of the Activity and requires the Bot's access token to fetch the image. FileUploadInMessageSection

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading