Hinzufügen eines Botmenüs in Microsoft Teams

Wichtig

Dieser Artikel basiert auf dem Bot Framework SDK v3. Wenn Sie nach der aktuellen Dokumentationsversion 4.6 oder höher des SDK suchen, lesen Sie den Abschnitt Konversationsbots .

Um die Ermittlung zu erleichtern und Die Benutzer über die Funktionalität Ihres Bots zu informieren, können Sie jetzt Menüs hinzufügen, die immer dann angezeigt werden, wenn der Benutzer mit Ihrem Bot interagiert. Das Menü zeigt den Befehlstext an und stellt auch Hilfetext bereit, z. B. ein Verwendungsbeispiel oder eine Beschreibung des Zwecks des Befehls.

Wenn ein Benutzer ein Menüelement auswählt, wird die Befehlszeichenfolge in das Textfeld eingefügt, um die Vervollständigung der Botnachricht durch den Benutzer zu unterstützen.

Unterstützung des Botmenüs in der mobilen Teams-App

Hinweis

Botmenüs werden auf mobilen Geräten nicht angezeigt.

App-Manifest

Um ein Botmenü zu erstellen, fügen Sie Ihrem App-Manifest im Botabschnitt ein neues commandLists -Objekt hinzu. Sie können einzelne Menüs mit separaten Befehlen für jeden Bereich deklarieren, den Ihr Bot unterstützt (personal, groupChatoder team). Jedes Menü unterstützt bis zu 10 Befehle.

Manifestauszug – einzelnes Menü für beide Bereiche

{
  ⋮
  "bots":[
    {
      "botId":"[Microsoft App ID for your bot]",
      "scopes": [
        "personal",
        "team"
      ],
      "commandLists":[
        {
          "scopes":[
            "team",
            "personal"
          ],
          "commands":[
            {
              "title":"Help",
              "description":"Displays this help message"
            },
            {
              "title":"Search Flights",
              "description":"Search flights from Seattle to Phoenix May 2-5 departing after 3pm"
            },
            {
              "title":"Search Hotels",
              "description":"Search hotels in Portland tonight"
            },
            {
              "title":"Best Time to Fly",
              "description":"Best time to fly to London for a 5 day trip this summer"
            }
          ]
        }
      ]
    }
  ],
  ...
}

Manifestauszug – separates Menü pro Bereich

{
  ...
  "bots":[
    {
      "botId":"[Microsoft app ID for your bot]",
      "scopes": [
        "groupChat",
        "team"
      ],
      "commandLists":[
        {
          "scopes":[
            "team"
          ],
          "commands":[
            {
            "title":"help",
            "description":"Displays this help message for channels"
            }
          ]
        },
        {
          "scopes":[
            "groupChat"
          ],
          "commands":[
            {
            "title":"help",
            "description":"Displays this help message for group chat"
            }
          ]
        }
      ]
    }
  ],
  ...
}

Bewährte Methoden

• Halten Sie es einfach: Das Bot-Menü soll die wichtigsten Funktionen Ihres Bots darstellen.
• Kurz halten: Menüoptionen sollten keine extrem langen und komplexen Anweisungen in natürlicher Sprache sein, es sollten einfache Befehle sein.
• Immer verfügbar: Botmenüaktionen/-befehle sollten immer aufgerufen werden können, unabhängig vom Zustand der Konversation oder des Dialogs, in dem sich der Bot befindet.