Skip to content

Latest commit

 

History

History

nodejs

Readme.md

page_type description products languages extensions urlFragment
sample
This Teams bot enables users to request task approval from managers within group chats. Managers can quickly approve or reject requests, while other members view request details only.
office-teams
office
office-365
nodejs
contentType createdDate
samples
6-12-2021 17:00:25
officedev-microsoft-teams-samples-bot-request-approval-nodejs

Bot request approval

This sample demonstrates a Teams bot that facilitates task approval requests within group chats. Users can submit requests via Adaptive Cards, which managers can then approve or reject directly in the chat. Other group members can view request details, while only requesters and managers have access to actionable options. The sample supports Azure and includes comprehensive setup guidance, leveraging .NET Core and the Teams Toolkit for Visual Studio.

Included Features

  • Bots
  • Adaptive Cards

Interaction with app

Preview Image

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 package (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).

Bot request approval: Manifest

Send task request using Universal Adaptive Cards in group chat

This sample shows a feature where:

  1. Requester : Can request for any task approval from manager by initiating a request in group chat using bot command request and only requester can edit the request card.
  2. Manager : Can see the request raised by user in the same group chat with an option of approve or reject.
  3. Others: Other members in the group chat can see the request details only.

Prerequisites

Run the app (Using Teams Toolkit for Visual Studio Code)

The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Teams Toolkit extension
  3. Select File > Open Folder in VS Code and choose this samples directory from the repo
  4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
  5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
  6. In the browser that launches, select the Add button to install the app to Teams.

If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.

Setup

  1. Register a new application in the Microsoft Entra ID – App Registrations portal.

  2. Setup for Bot

    • Register a Microsoft Entra ID aap registration in Azure portal.
    • Also, register a bot with Azure Bot Service, following the instructions here.
    • Ensure that you've enabled the Teams Channel
    • While registering the bot, use https://<your_tunnel_domain>/api/messages as the messaging endpoint.

    NOTE: When you create your app registration, you will create an App ID and App password - make sure you keep these for later.

  3. Setup NGROK

  • 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
  1. Setup for code

  • Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
    • Open the .env configuration file in your project folder (or in Visual Studio Code) and update the ClientId and ClientSecret, BaseURL with your app's base url. (Note the ClientId is the AppId created in step 1 (Setup for Bot), the ClientSecret is referred to as the "client secret" in step 1 (Setup for Bot) and you can always create a new client secret anytime.)

  • In the folder where repository is cloned navigate to samples/bot-task-approval/nodejs

  • Install node modules

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.

```bash
npm install
```

  • Run your app

    npm start
  1. Setup Manifest for Teams

  • 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 app registration earlier) everywhere you see the place holder string {{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 and replace {{domain-name}} with base Url of your 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 the Apps view click "Upload a custom app")

    • Go to Microsoft Teams. From the lower left corner, select Apps
    • From the lower left corner, choose Upload a custom App
    • Go to your project directory, the ./appManifest folder, select the zip folder, and choose Open.
    • Select Add in the pop-up dialog box. Your app is uploaded to Teams.

Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

Running the sample.

Initial Card

Add TO Chat

  • Initiated request using bot command request in group chat.

    Mention Bot

  • Card will refresh for requester to fill details.

    Task Management

  • After submitting the request, requester can edit or cancel the request.

    Note: Users who created the card will only be able to see the buttons to edit or cancel the request.

    Edit/Cancel Card

Manager:

  • After requester submit the request, manager can approve/reject the request.

    Note: Manager of the task request will only be able to see the buttons to approve or reject the request.

    Approve/Reject Card

  • If manager approves or rejects the request, card will be refreshed for all the members in group chat.

    Status Card

Further reading