page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample demonstrates how to retrieve and display meeting context and participant details in Microsoft Teams using the bot's Meeting API. |
|
|
|
officedev-microsoft-teams-samples-meetings-context-app-nodejs |
This sample application illustrates how to display the meeting context object in a Microsoft Teams meeting tab, utilizing the bot's Meeting API to fetch participant and meeting details. Users can interact with the bot to obtain comprehensive information about participants and meeting specifics, such as start times, end times, and joining URLs, thereby enriching the collaborative experience within Teams.
- Bots
- Meeting Chat
- Meeting Details
- RSC Permissions
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).
Teams Meeting Context Sample: Manifest
- NodeJS
- dev tunnel or ngrok latest version or equivalent tunnelling solution
- Teams Toolkit for VS Code or TeamsFx CLI
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.
- Ensure you have downloaded and installed Visual Studio Code
- Install the Teams 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.
Note these instructions are for running the sample on your local machine.
-
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
-
Setup for Bot
Register your application with Azure AD
-
Register a new application in the Microsoft Entra ID – App Registrations portal.
-
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 the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description (Name of the secret) for the secret and select “Never” for Expires. Click "Add". Once the client secret is created, copy its value, it need to be placed in the .env file.
-
In Azure portal, create a Azure Bot resource.
-
Ensure that you've enabled the Teams Channel
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
A) If you are using Visual Studio Code
- Launch Visual Studio code
- File -> Open Folder
- Navigate to
samples/meeting-context-app
folder - Select
nodejs
folder
B) Install node modules For Server
Inside node js folder, open your local terminal and run the below command to install node modules. You can do the same in Visual Studio code terminal by opening the project in Visual Studio code.
npm install
C) Install node modules For Client
Navigate to folder
client
folder, open your local terminal and run the below command to install node modules. You can do the same in Visual Studio code terminal by opening the project in Visual Studio code.npm install
-
Update the
.env
configuration file.Update configuration with the
MicrosoftAppId
,MicrosoftAppPassword
andMicrosoftAppTenantId
. -
Run your app for server and client
npm start
- Your server will start running on 3000 PORT
- Your client will start running on 3978 PORT.
-
This step is specific to Teams.
- Edit the
manifest.json
contained in theappManifest
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 themanifest.json
) - Edit the
manifest.json
forvalidDomains
with base Url domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.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 amanifest.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/team/groupChat scope (Supported scopes)
- Edit the
-
Add the app in meeting/group channel.
-
The details of the meeting context object will be shown on tab based.
-
You can expand/reduce the JSON for the context object and can also copy a particular object slice.
-
You can send one of these two commands: Meeting Context or Participant Context
-
It will send you the output of
TeamsInfo.getMeetingInfo
andTeamsInfo.getMeetingParticipant
-
Particpant Details : User can see the details of current participant by the name id and other feilds respectively.
-
Meeting Details : In this user can track the detials of meeting start time, end time, joining url and other details respectively.
Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.