Erstellen eines Benachrichtigungsbots mit JavaScript
Der Benachrichtigungsbot sendet proaktiv Nachrichten im Teams-Kanal oder Gruppenchat oder persönlichen Chat. Sie können den Benachrichtigungsbot mit einer HTTP-Anforderung auslösen, z. B. Karten oder SMS.
In diesem Tutorial erfahren Sie Folgendes:
- Erstellen eines neuen Benachrichtigungsbots mit Microsoft 365 Agents Toolkit (früher als Teams Toolkit bezeichnet).
- Informationen zur Verzeichnisstruktur Ihrer App.
- So senden Sie mehrere Benachrichtigungen.
Diese Schritt-für-Schritt-Anleitung hilft Ihnen beim Erstellen eines Benachrichtigungsbots mit dem Agents Toolkit. Die folgende Ausgabe wird angezeigt:
Voraussetzungen
Hier finden Sie eine Liste der Tools, die Sie zum Erstellen und Bereitstellen Ihrer Apps benötigen.
| Installieren | Für die Verwendung von | |
|---|---|---|
| Visual Studio Code | JavaScript- oder TypeScript-Buildumgebungen. Verwenden Sie die neueste Version. | |
| Microsoft 365 Agents Toolkit | Microsoft Visual Studio Code-Erweiterung, die ein Projektgerüst für Ihre App erstellt. Verwenden Sie die neueste Version. | |
| Node.js | Back-End-JavaScript-Laufzeitumgebung. Weitere Informationen finden Sie unter Node.js Versionskompatibilitätstabelle für den Projekttyp. | |
| Microsoft Teams | Microsoft Teams für die Zusammenarbeit mit allen, mit denen Sie arbeiten, über Apps für Chats, Besprechungen und Anrufe an einem Ort. | |
| Microsoft Edge (empfohlen) oder Google Chrome | Ein Browser mit Entwicklertools. | |
| Microsoft 365 | Zugriff auf das Teams-Konto mit den entsprechenden Berechtigungen zum Installieren einer App. |
Hinweis
Das Handbuch wird auf der neuesten Version des Agents Toolkit und nodejs Version 18 und 20 getestet. Die Schritte in diesem Leitfaden funktionieren möglicherweise mit anderen Versionen, wurden aber noch nicht getestet.
Vorbereiten der Entwicklungsumgebung
Nachdem Sie die erforderlichen Tools installiert haben, richten Sie die Entwicklungsumgebung ein.
Installieren des Microsoft 365 Agents Toolkits
Microsoft 365 Agents Toolkit (früher teams Toolkit genannt) vereinfacht den Entwicklungsprozess mit Tools zum Bereitstellen und Bereitstellen von Cloudressourcen für Ihre App und Veröffentlichung im Teams Store.
Sie können das Agents Toolkit mit Visual Studio Code oder einer Befehlszeilenschnittstelle namens Microsoft 365 Agents Toolkit CLI (früher teamsFx CLI) verwenden.
Öffnen Sie Visual Studio Code, und wählen Sie Erweiterungen (STRG+UMSCHALT+X oder Erweiterungen anzeigen>)aus.
Geben Sie im Suchfeld Microsoft 365 Agents Toolkit ein.
Wählen Sie Installieren aus.
Das Symbol Microsoft 365 Agents Toolkit
wird in der Visual Studio Code-Aktivitätsleiste angezeigt.
Sie können das Agents Toolkit auch über den Visual Studio Code Marketplace installieren.
Einrichten Ihres Teams-Entwicklungsmandanten
Ein Mandant ist ein Raum oder Ein Container für Ihre organization in Teams, in dem Sie chatten, Dateien freigeben und Besprechungen ausführen. Dieser Bereich ist auch der Ort, an dem Sie Ihre App hochladen und testen. Lassen Sie uns überprüfen, ob Sie bereit sind, mit dem Mandanten zu entwickeln.
Option "Auf App-Upload überprüfen"
Nachdem Sie Ihre benutzerdefinierte App erstellt haben, müssen Sie Ihre App mit der Option Benutzerdefinierte App hochladen in Teams hochladen. Melden Sie sich bei Ihrem Microsoft 365-Konto an, um zu überprüfen, ob diese Option aktiviert ist.
Mit den folgenden Schritten können Sie überprüfen, ob Sie Apps in Teams hochladen können:
Wählen Sie im Teams-Client das Symbol Apps aus.
Wählen Sie Verwalten Ihrer Apps aus.
Wählen Sie App hochladen aus.
Suchen Sie nach der Option Hochladen einer benutzerdefinierten App. Wenn die Option angezeigt wird, können Sie benutzerdefinierte Apps hochladen.
Hinweis
Wenn Sie die Option zum Hochladen einer benutzerdefinierten App nicht finden, wenden Sie sich an Ihren Teams-Administrator.
Erstellen eines kostenlosen Teams-Entwicklermandanten (optional)
Wenn Sie nicht über ein Teams-Entwicklerkonto verfügen, treten Sie dem Microsoft 365-Entwicklerprogramm bei.
Gehen Sie zu Microsoft 365-Entwicklerprogramm.
Wählen Sie Jetzt beitreten aus, und folgen Sie den Anweisungen auf dem Bildschirm.
Wählen Sie auf der Willkommensseite E5-Abonnement einrichten aus.
Einrichten Ihres Administratorkontos. Nachdem Sie fertig sind, wird der folgende Bildschirm angezeigt:
Melden Sie sich bei Teams mit dem Administratorkonto an, das Sie gerade eingerichtet haben. Vergewissern Sie sich, dass Sie über die Option Benutzerdefinierte App hochladen in Teams verfügen.
Erstellen eines Benachrichtigungsbots
So erstellen Sie einen Benachrichtigungsbot mit Visual Studio Code
Öffnen Sie Visual Studio Code.
Wählen Sie das Symbol Microsoft 365 Agents Toolkit
in der Visual Studio Code-Aktivitätsleiste aus.Wählen Sie Neue App erstellenaus.
Wählen Sie Bot aus, um ein neues Botprojekt zu erstellen.
Stellen Sie sicher, dass Chatbenachrichtigung als App-Feature ausgewählt ist, das Sie in Ihrer App erstellen möchten.
Wählen Sie HTTP Trigger Express Server als Trigger aus.
Wählen Sie JavaScript als Programmiersprache aus.
Wählen Sie Standardordner aus, um ihren Projektstammordner am Standardspeicherort zu speichern.
Sie können den Standardspeicherort auch mithilfe der folgenden Schritte ändern:
Wählen Sie Durchsuchen aus.
Wählen Sie den Speicherort für den Projektarbeitsbereich aus.
Wählen Sie ordner auswählen aus.
Geben Sie einen geeigneten Namen für Ihre App ein.
Drücken Sie die EINGABETASTE.
Nachdem Ihre App erstellt wurde, zeigt das Agents Toolkit die folgende Meldung an:
Die Benachrichtigungsbot-App wird in wenigen Sekunden erstellt.
Wählen Sie in der Visual Studio Code-Aktivitätsleiste das Symbol Ausführen und Debuggen
aus.Wählen Sie in der Dropdownliste Debuggen in Teams (Edge) oder Debuggen in Teams (Chrome) aus.
Wählen Sie die Schaltfläche Debuggen starten aus.
Klicken Sie auf Hinzufügen.
Wählen Sie Öffnen aus, um die App im persönlichen Bereich zu öffnen.
Alternativ können Sie entweder den erforderlichen Bereich suchen und auswählen oder einen Kanal, Chat oder eine Besprechung aus der Liste auswählen und durch das Dialogfeld navigieren, um Los auszuwählen.
Ihre Benachrichtigungsbot-App wird in den Teams-Client hochgeladen.
Ereignisse werden in Echtzeit von einer externen Quelle ausgelöst, z. B. durch eine Drittanbieter-API, die den Benachrichtigungsbot dazu veranlassen, dem Benutzer eine Benachrichtigung zu senden. Zum Emulieren eines Ereignistriggers können Sie ein Ereignis manuell mithilfe von PowerShell oder Terminal senden.
Um ein Ereignis zum Auslösen einer Benachrichtigung aufzurufen, verwenden Sie eine der folgenden Methoden:
Wenn Sie Windows verwenden, führen Sie die folgenden Schritte aus:
Öffnen Sie Windows PowerShell.
Führen Sie den Befehl
Invoke-Webrequest -Method POST -URI http://localhost:3978/api/notificationaus.
Wenn Sie Windows nicht verwenden, führen Sie die folgenden Schritte aus:
- Wechseln Sie in Visual Studio Code zu Terminal>Neues Terminal , um ein weiteres Terminal zu öffnen.
- Führen Sie den Befehl
curl -X POST http://localhost:3978/api/notificationaus.
Sie erhalten die folgende Ausgabe in Teams:
Hinweis
Wenn Sie Ihre App auf Outlook und Microsoft 365 erweitern möchten, können Sie ihre App mit Outlook und Microsoft 365 in der Dropdownliste AUSFÜHREN UND DEBUGGEN in Visual Studio Code debuggen.
Einführung in den Quellcode
Das Agents-Toolkit stellt Komponenten zum Erstellen einer App bereit. Nach dem Erstellen des Projekts können Sie die Projektordner und -dateien im Explorer Bereich von Visual Studio Code anzeigen.
Der neue Projektordner enthält folgenden Inhalt:
| Ordner-/Dateiname | Inhalt |
|---|---|
.vscode |
VSCode-Dateien zum Debuggen. |
appPackage |
Vorlagen für das App-Manifest (zuvor als Teams-App-Manifest bezeichnet). |
env |
Name/Wert-Paare werden in Umgebungsdateien gespeichert und von m365agents.yml verwendet, um die Bereitstellungs- und Bereitstellungsregeln anzupassen. |
infra |
Vorlagen für die Bereitstellung von Azure-Ressourcen. |
src\ |
Der Quellcode für die Teams-Benachrichtigungsanwendung. |
src\index.js |
Anwendungseinstiegspunkt und restify Handler für Benachrichtigungen. |
src\teamsbot.js |
Ein leerer Teams-Aktivitätshandler für die Botanpassung. |
src\adaptiveCards\notification-default.json |
Eine generierte adaptive Karte, die an Teams gesendet wird. |
m365agents.yml |
Die Hauptprojektdatei beschreibt Ihre Anwendungskonfiguration und definiert den Satz von Aktionen, die in den einzelnen Lebenszyklusphasen ausgeführt werden sollen. |
m365agents.local.yml |
Dies wird mit Aktionen überschrieben m365agents.yml , die die lokale Ausführung und das Debuggen ermöglichen. |
Senden einer Benachrichtigung an den Teams-Kanal
So senden Sie Benachrichtigungen an den Teams-Kanal
Wählen Sie in Visual Studio Code unter EXPLORER die Option MYNOTIFICATIONBOT> src> index.jsaus.
Die folgende Seite wird angezeigt:
Verwenden Sie den folgenden Code nach
for (const target of installations) {in Visual Studio Code:if (target.type === "Channel") { const members = await target.members(); await target.sendMessage("This is a message to channel: " + members.length + " members."); for (const member of members) { await member.sendMessage("This is a message to Member: " + member.account.email); } }
So passen Sie den Speicher an (optional):
Wählen Sie in Visual Studio Code unter EXPLORER die Option MYNOTIFICATIONBOT> src> internal> initialize.jsaus.
Die folgende Seite wird angezeigt:
Aktualisieren Sie den folgenden Code in initialize.js Datei, um den Speicher anzupassen.
const myStorage = new MyStorage(...); // initialize ConversationBot with notification enabled and customized storage const bot = new ConversationBot({ // The bot id and password to create BotFrameworkAdapter. // See https://aka.ms/about-bot-adapter to learn more about adapters. adapterConfig: { appId: process.env.BOT_ID, appPassword: process.env.BOT_PASSWORD, }, // Enable notification notification: { enabled: true, storage: myStorage, }, });Verwenden Sie Ihren eigenen Speicherort anstelle von MyStorage.
Hinweis
Es ist erforderlich, Ihren eigenen Speicher für die Produktionsumgebung zu verwenden. Wenn kein Speicher bereitgestellt wird, wird der standardmäßige lokale Dateispeicher berücksichtigt.
Wählen Sie auf der Randleiste von Visual Studio Code das Symbol Ausführen und Debuggen
aus.Wählen Sie in der Dropdownliste Debuggen in Teams (Edge) oder Debuggen in Teams (Chrome) aus.
Wählen Sie die Schaltfläche Debuggen starten aus.
In Teams wird ein Dialogfeld zum Hochladen der App angezeigt.
Klicken Sie auf Hinzufügen.
Wählen Sie Öffnen aus, um die App im persönlichen Bereich zu öffnen.
Alternativ können Sie entweder den erforderlichen Bereich suchen und auswählen oder einen Kanal aus der Liste auswählen und durch das Dialogfeld navigieren, um Los auszuwählen.
Der folgende Bildschirm wird angezeigt:
Öffnen Sie Windows PowerShell.
Führen Sie den Befehl
Invoke-Webrequest -Method POST -URI http://localhost:3978/api/notificationaus.
Sie erhalten die Benachrichtigung im Teams-Kanal:
Sie erhalten die Benachrichtigung im persönlichen Chat:
Bereitstellen Ihrer ersten Teams-App
Sie haben gelernt, wie Sie eine Teams-App mit Benachrichtigungsbot-Funktion erstellen und ausführen. Der letzte Schritt besteht darin, Ihre App in Azure bereitzustellen.
Wir stellen die erste App mit Benachrichtigungsbotfunktion in Azure mithilfe des Agents Toolkits bereit.
Anmelden bei Ihrem Azure-Konto
Verwenden Sie Ihr Konto, um auf die Microsoft Azure-Portal zuzugreifen und neue Cloudressourcen zur Unterstützung Ihrer App bereitzustellen.
Öffnen Sie Visual Studio Code.
Öffnen Sie den Projektordner, in dem Sie die Benachrichtigungsbot-App erstellt haben.
Wählen Sie auf der Randleiste das Symbol Microsoft 365 Agents Toolkit
aus.Wählen Sie Mit Ihren Anmeldeinformationen bei Azure anmelden aus.
Tipp
Wenn Sie die AZURE-KONTOerweiterung installiert haben und dasselbe Konto verwenden, können Sie diesen Schritt überspringen.
Ihr Standardwebbrowser wird geöffnet, damit Sie sich beim Konto anmelden können.
Schließen Sie den Browser, wenn Sie dazu aufgefordert werden, und kehren Sie zu Visual Studio Code zurück.
Im Abschnitt KONTEN der Randleiste werden die beiden Konten separat angezeigt. Außerdem wird die Anzahl der verwendbaren Azure-Abonnements aufgelistet, die Ihnen zur Verfügung stehen. Stellen Sie sicher, dass Mindestens ein verwendbares Azure-Abonnement verfügbar ist. Wenn nicht, melden Sie sich ab, und verwenden Sie ein anderes Konto.
Herzlichen Glückwunsch, Sie haben eine Teams-App erstellt! Als Nächstes erfahren Sie, wie Sie mithilfe des Agents-Toolkits eine der Apps in Azure bereitstellen.
Bereitstellen Ihrer App in Azure
Unter BEREITSTELLUNG können Sie erforderliche Cloudressourcen bereitstellen, und der Code Ihrer App wird in die erstellten Cloudressourcen kopiert.
Wählen Sie auf der Randleiste von Visual Studio Code das Symbol Microsoft 365 Agents Toolkit
aus.Wählen Sie unter LEBENSZYKLUSdie Option Bereitstellen aus.
Wählen Sie eine vorhandene Ressourcengruppe aus, oder erstellen Sie eine neue Ressourcengruppe. Weitere Informationen finden Sie unter Erstellen einer Ressourcengruppe.
Wählen Sie ein beliebiges vorhandenes Abonnement aus.
Wählen Sie eine vorhandene Ressourcengruppe aus, oder erstellen Sie eine neue Ressourcengruppe.
Hinweis
Es wird ein Dialogfeld angezeigt, in dem darauf hingewiesen wird, dass beim Ausführen von Ressourcen in Azure Möglicherweise Kosten anfallen.
Wählen Sie Bereitstellen aus.
Beim Bereitstellungsprozess werden Ressourcen in der Azure-Cloud erstellt. Sie können den Fortschritt überwachen, indem Sie die Dialogfelder in der unteren rechten Ecke beobachten.
Die Option zum Anzeigen der bereitgestellten Ressourcen wird angezeigt. Für dieses Tutorial müssen Sie keine Ressourcen anzeigen.
Wählen Sie nach Abschluss der Bereitstellung unter LIFECYCLEdie Option Bereitstellen aus.
Wählen Sie Bereitstellen.
Die Bereitstellung dauert einige Zeit. Sie können den Fortschritt in den Dialogfeldern in der unteren rechten Ecke überwachen.
Abschließen der Herausforderung
Haben Sie sich so etwas einfallen lassen?
Herzlichen Glückwunsch!
Sie haben das Tutorial zum Erstellen eines Benachrichtigungsbots abgeschlossen. Sie können Ihren Benachrichtigungsbot erweitern, um die Befehlsantwort- und Workflowfeatures hinzuzufügen.
Liegt ein Problem mit diesem Abschnitt vor? Wenn ja, senden Sie uns Feedback, damit wir den Abschnitt verbessern können.