Freigeben über

Erstellen von Nachrichten mit der Bot Connector-API

  • Artikel

Ihr Bot sendet Aktivität-Objekte des Typs message, um Benutzern Informationen zukommen zu lassen und auch message-Aktivitäten von Benutzern zu empfangen. Einige Nachrichten können aus Nur-Text bestehen, während andere vielfältigere Inhalte wie gesprochenen Text, vorgeschlagene Aktionen, Medienanlagen, Rich Cards und kanalspezifische Daten enthalten können. In diesem Artikel werden einige der häufig verwendeten Nachrichteneigenschaften beschrieben.

Nachrichtentext und -formatierung

Der Nachrichtentext kann als reiner Text, Markdown oder im xml-Format formatiert werden. Das Standardformat für die textFormat-Eigenschaft ist Markdown, und Text wird unter Verwendung der Markdown-Formatierungsstandards interpretiert. Der Unterstützungsgrad für Textformate variiert je nach Kanal.

Tipp

Informationen dazu, welche Features auf den einzelnen Kanälen unterstützt werden, finden Sie im Referenzartikel zu Kanälen .

Mit der textFormat-Eigenschaft des Aktivität-Objekts kann das Format des Texts angegeben werden. Legen Sie beispielsweise zum Erstellen einer einfachen Nachricht, die nur reinen Text enthält, die Eigenschaft textFormat des Activity-Objekts auf plain, den Inhalt der Eigenschaft text auf den Inhalt der Nachricht und die Eigenschaft locale auf das Gebietsschema des Absenders fest.

Attachments

Mit der attachments-Eigenschaft des Aktivität-Objekts können einfache Medienanlagen (Bild, Audio, Video, Datei) und Rich Cards gesendet werden. Weitere Informationen finden Sie unter Hinzufügen von Medienanlagen zu Nachrichten und Hinzufügen von Rich Cards zu Nachrichten.

Entitäten

Die entities-Eigenschaft des Aktivität-Objekts ist ein Array von schema.org-Objekten mit unbestimmtem Ende, die den Austausch von allgemeinen kontextbezogenen Metadaten zwischen dem Kanal und dem Bot ermöglichen.

Erwähnungsentitäten

Viele Kanäle unterstützen die Option, dass ein Bot oder Benutzer eine Person im Kontext einer Konversation „erwähnt“. Um einen Benutzer in einer Nachricht zu erwähnen, füllen Sie die entities-Eigenschaft der Nachricht mit einem Erwähnung-Objekt.

Standortentitäten

Um standortbezogene Informationen innerhalb einer Nachricht zu übermitteln, füllen Sie die Eigenschaft der Nachricht entities mit Place-Objekten auf.

Kanaldaten

Mit der channelData-Eigenschaft des Aktivität-Objekts kann kanalspezifische Funktionalität implementiert werden. Weitere Informationen finden Sie unter Implementieren von kanalspezifischer Funktionalität.

Text-to-Speech

Mit der speak-Eigenschaft des Aktivität-Objekts kann der Text angegeben werden, der von Ihrem Bot in einem sprachaktivierten Kanal gesprochen werden soll, und mit der inputHint-Eigenschaft des Activity-Objekts kann der Status des Clientmikrofons beeinflusst werden. Weitere Informationen finden Sie unter Hinzufügen von Spracheingabe zu Nachrichten und Hinzufügen von Eingabehinweisen zu Nachrichten.

Vorgeschlagene Aktionen

Mit der suggestedActions-Eigenschaft des Aktivität-Objekts können Schaltflächen bereitgestellt werden, auf die der Benutzer tippen kann, um Eingaben vorzunehmen. Im Gegensatz zu Schaltflächen in Rich Cards (die für den Benutzer auch nach dem Antippen sichtbar und zugänglich bleiben), verschwinden die im Bereich der vorgeschlagenen Aktionen angezeigten Schaltflächen, nachdem der Benutzer eine Auswahl getroffen hat. Weitere Informationen finden Sie unter Hinzufügen von vorgeschlagenen Aktionen zu Nachrichten.

Zusätzliche Ressourcen