Skip to content

Latest commit

 

History

History

csharp

README.md

page_type description products languages extensions urlFragment
sample
This sample allows broadcasting messages to all organization members via Teams activity feed notifications using Graph APIs and Teams SSO.
office-teams
office
office-365
csharp
contentType createdDate
samples
01/28/2022 12:00:00 AM
officedev-microsoft-teams-samples-graph-activity-feed-broadcast-csharp

Broadcast message to organization using activity feed notification (Graph APIs)

This sample showcases how to broadcast messages across an organization using Microsoft Teams activity feed notifications powered by Graph APIs. Key features include Teams SSO for authentication, sending bulk notifications to users, and seamless integration within Teams tabs, allowing for real-time updates and effective communication.

Included Features

  • Teams SSO (tabs)
  • Activity Feed Notifications
  • Graph API

Interaction with app

Broadcast from user

Prerequisites

Run the app (Using Teams Toolkit for Visual Studio)

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

  1. Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
  2. Install Teams Toolkit for Visual Studio Teams Toolkit extension
  3. In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
  4. In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
  5. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
  6. Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
  7. 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

  • 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

  • Register your Teams Auth SSO with Azure AD

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

  2. 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.

  3. 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.

  4. Under Manage, select Expose an API.

  5. Click on the Set link to generate the Application ID URI in the form of api://{AppID}. Insert your fully qualified domain name (with a forward slash "/" appended to the end) between the double forward slashes and the GUID. The entire ID should have the form of: api://fully-qualified-domain-name/{AppID} and exclude http/https from the domain name.

    • ex: api://%ngrokDomain%.ngrok-free.app/00000000-0000-0000-0000-000000000000.

  6. Select the Add a scope button. In the panel that opens, enter access_as_user as the Scope name.

  7. Set Who can consent? to Admins and users

  8. Fill in the fields for configuring the admin and user consent prompts with values that are appropriate for the access_as_user scope:

    • Admin consent title: Teams can access the user’s profile.
    • Admin consent description: Allows Teams to call the app’s web APIs as the current user.
    • User consent display name: Teams can access the user profile and make requests on the user's behalf.
    • User consent description: Enable Teams to call this app’s APIs with the same rights as the user.

  9. Ensure that State is set to Enabled

  10. Select Add scope

    • The domain part of the Scope name displayed just below the text field should automatically match the Application ID URI set in the previous step, with /access_as_user appended to the end:
      • `api://[ngrokDomain].ngrok-free.app/00000000-0000-0000-0000-000000000000/access_as_user.

  11. In the Authorized client applications section, identify the applications that you want to authorize for your app’s web application. Each of the following IDs needs to be entered:

    • 1fec8e78-bce4-4aaf-ab1b-5451cc387264 (Teams mobile/desktop application)
    • 5e3ce6c0-2b1f-4285-8d4b-75ee78787346 (Teams web application)

  12. Navigate to API Permissions section under Manage, and make sure to add the follow permissions:

  • Select Add a permission
  •  Select Microsoft Graph -> Delegated permissions.
    • User.Read (enabled by default)
    • Directory.Read.All
    • Directory.ReadWrite.All
    • TeamsAppInstallation.ReadForUser
    • TeamsAppInstallation.ReadWriteForUser
    • TeamsActivity.Send

Note Your need to add TeamsActivity.Send, TeamsAppInstallation.ReadForUser.All and Directory.Read.All as Application level permissions too.

  • Click on Add permissions. Please make sure to grant the admin consent for the required permissions.

  1. Navigate to Authentication If an app hasn't been granted IT admin consent, users will have to provide consent the first time they use an app. (This will only work for the delegated permissions and Admin consent is required for any Application level permissions) Set a redirect URI:

    • Select Add a platform.
    • Select Single Page Application.
    • Enter the redirect URI for the app in the following format: https://{Base_Url_Domain}/Auth/End.
    • Select Add URI and enter https://{Base_Url_Domain}/Auth/Start. Preview Image

  2. 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 appsettings.json.

  3. Clone the repository

git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
  1. Open the code in Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to folder where repository is cloned then samples/graph-activity-feed-broadcast/csharp/ActivityFeedBroadcast.sln
  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
  1. Setup and run the bot from Visual Studio: Modify the appsettings.json and fill in the following details:
  • MicrosoftAppId - Generated from Step 3 (Application (client) ID) is the application app id
  • TenantId - Generated from Step 3 (Directory (tenant) ID) is the tenant id
  • MicrosoftAppPassword - Generated from Step 14, also referred to as Client secret
  • {{Base_URL_Domain}} 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.
  • Press F5 to run the project
  1. Modify the manifest.json in the /appPackage folder and replace the following details:
  • {{Microsoft-App-Id}} with Application id generated from Step 3
  • {{Base_URL_Domain}} 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.

  1. Zip the contents of appPackage folder into a manifest.zip, and use the manifest.zip to deploy in app store or add to Teams using step 19.

  2. Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

  • Go to Microsoft Teams and then go to side panel, select Apps
  • Choose Upload a custom App
  • Go to your project directory, the ./appPackage 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

  • Broadcast message for all the members. Broadcast from user

  • Activity feed notification. Notification

  • Broadcast details available for members. Broadcast details

Further reading