| page_type | sample | ||||
|---|---|---|---|---|---|
| description | This sample demonstrates how to fetch shared images and files in Microsoft Teams groupchats and team channels using graph API. | ||||
| products |
|
||||
| languages |
|
||||
| extensions |
|
||||
| urlFragment | officedev-microsoft-teams-samples-graph-file-fetch-nodejs |
This sample demonstrates how to fetch shared images and files in Microsoft Teams groupchats and team channels using graph API. While leveraging features such as bot interaction, Teams SSO, adaptive cards.
Currently, Microsoft Teams support for QR or barcode scanner capability is only available for mobile clients
- Bot
- Teams SSO (bots)
- Graph API
Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app package (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).
Graph File Fetch: Manifest
- Microsoft Teams is installed and you have an account (not a guest account)
- To test locally, NodeJS must be installed on your development machine (version 16.14.2 or higher)
- dev tunnel or ngrok latest version or equivalent tunneling solution
- M365 developer account or access to a Teams account with the appropriate permissions to install an app.
- Microsoft 365 Agents Toolkit for VS Code or TeamsFx CLI
The simplest way to run this sample in Teams is to use Microsoft 365 Agents Toolkit for Visual Studio Code.
- Ensure you have downloaded and installed Visual Studio Code
- Install the Microsoft 365 Agents Toolkit extension
- Select File > Open Folder in VS Code and choose this samples directory from the repo
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
- Select Debug > Start Debugging or F5 to run the app in a Teams web client.
- In the browser that launches, select the Add button to install the app to Teams.
- Register a new application in the Microsoft Entra ID – App Registrations portal.
- Select New Registration and on the register an application page, set following values:
- Set name to your app name.
- Choose the supported account types (any account type will work)
- Leave Redirect URI empty.
- Choose Register.
- On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You'll need those later when updating your Teams application manifest and in the appsettings.json.
- Navigate to API Permissions, and make sure to add the follow permissions:
Select Add a permission
- Select Add a permission
- Select Microsoft Graph -> Delegated permissions.
User.Read(enabled by default)- Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
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.
- Setup for Bot SSO
-
Refer to Bot SSO Setup document
-
Ensure that you've enabled the Teams Channel
-
While registering the Azure bot, use
https://<your_tunnel_domain>/api/messagesas the messaging endpoint.NOTE: When you create your app registration in Azure portal, you will create an App ID and App password - make sure you keep these for later.
- Setup for code
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
In a terminal, navigate to
samples/graph-file-fetch/nodejs -
Install modules
npm install
-
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
-
Update the
.envconfiguration file for the bot to use theMicrosoftAppIdandMicrosoftAppPasswordfrom the Microsoft Entra ID app registration in Azure portal or from the Bot Framework registration. (Note that the MicrosoftAppId is the AppId created in step 1 (Setup for Bot SSO), the MicrosoftAppPassword is referred to as the "client secret" in step 1 (Setup for Bot SSO) and you can always create a new client secret anytime.)- Also, update
connectionNameas the name of your Azure Bot connection created in previous steps. connectionName- The OAuthConnection setting from step 1, from Azure Bot SSO setup.BaseUrlwith application base url. For e.g., your ngrok url https://xxx.ngrok-free.app, your dev tunnels url https://xxx.devtunnels.ms.
- Also, update
-
Run your app
npm start
-
Manually update the manifest.json
- Edit the
manifest.jsoncontained in theappManifest/folder to replace with your MicrosoftAppId (that was created in step1 and is the same value of MicrosoftAppId in.envfile) everywhere you see the place holder string{{MicrosoftAppId}}(depending on the scenario the Microsoft App Id may occur multiple times in themanifest.json) {{domain-name}}with base Url domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.appthen your domain-name will be1234.ngrok-free.appand 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 amanifest.zip - Upload the
manifest.zipto Teams (in the left-bottom Apps view, click "Upload a custom app")
IMPORTANT: The manifest file in this app adds "token.botframework.com" to the list of
validDomains. This must be included in any bot that uses the Bot Framework OAuth flow. - Edit the
Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.
Install App:
Select Scope:
Welcome Message:
Oauth Prompt:
LoggedIn:
Uploading File To Teams GroupChat:
Bot Responds With FIle Link GroupChat:
Uploading File To Teams Channel:
Bot Responds With File Link Teams Channel:
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.