Rezept für Messaging: Abrufen externer Daten für einen Messaging-Bot

Der Flow-Builder-Schritt API-Aufruf durchführen ermöglicht es einem Messaging-Bot, über eine REST-API-Anfrage Daten von einem externen System wie Shopify oder Salesforce abzurufen.

In diesem Rezept erstellen Sie eine Bot-Antwort, die Wetterdaten für einen vom Endbenutzer angegebenen Ort abruft. Diese Antwort bezieht die Daten von der OpenWeather API. Sie können den in diesem Rezept erstellten Antwort-Konversationsfluss als Grundlage für Ihre eigenen API-gestützten Antworten nutzen.

Es umfasst die folgenden Aufgaben:

• Aufgabe 1: Einrichtung überprüfen
• Aufgabe 2: API-Verbindung erstellen
• Aufgabe 3: Angepasstes Ticketfeld erstellen
• Aufgabe 4: Antwort mit dem Flow Builder erstellen
• Aufgabe 5: Änderungen testen

Hinweis: Dieser Beitrag ist nur für Schulungszwecke gedacht. Zendesk bietet keinen Support für die in diesem Beitrag beschriebenen Beispiele. Außerdem bietet Zendesk keinen Support für die OpenWeather API und andere Technologien von Drittanbietern.

Aufgabe 1: Einrichtung wird überprüft

Für dieses Rezept benötigen Sie Folgendes:

• Ein Zendesk-Konto mit einem veröffentlichten Messaging-Bot. Wenn Sie möchten, können Sie den Bot in einer Sandbox testen, bevor Sie ihn in der Produktionsumgebung einsetzen.

  Informationen zum Einrichten eines Messaging-Bots in einem Web- und Mobile-Messaging-Kanal finden Sie im Beitrag Aktivieren und Erstellen eines Messaging-Bots für Web- und Mobilkanäle. Wie Sie einen Messaging-Bot in einem Social-Media-Kanal einrichten, erfahren Sie unter Erstellen eines Social-Media-Messaging-Bots mit dem Flow Builder. Informationen zum Verwenden von Messaging in einer Sandbox-Umgebung finden Sie unter Testen von Zendesk Messaging in der Sandbox.

• Einen API-Schlüssel für ein OpenWeather-Konto. Die in diesem Rezept verwendete API wird im Rahmen eines kostenlosen OpenWeather-Plans bereitgestellt.

  Informationen zur Anmeldung für ein kostenloses OpenWeather-Konto finden Sie unter openweathermap.org auf der Seite „Create New Account“. Nach der Anmeldung können Sie den API-Schlüssel auf Ihrer OpenWeather-Kontoseite abrufen.

  Beim Aktivieren des OpenWeather-API-Schlüssels müssen Sie die E-Mail-Adresse Ihres Kontos bestätigen. Nach der Bestätigung kann es bis zu zwei Stunden dauern, bis der API-Schlüssel aktiviert ist. Weitere Informationen finden Sie in der FAQ auf openweathermap.org.

Aufgabe 2: API-Verbindung erstellen

Erstellen Sie zunächst eine API-Verbindung, um Ihren OpenWeather-API-Schlüssel zu speichern. Über diese Verbindung kann Ihr Messaging-Bot Aufrufe der OpenWeather API authentifizieren.

So erstellen Sie die Verbindung

1. Klicken Sie in der Seitenleiste des Admin Centers auf Apps und Integrationen und dann auf Verbindungen > Verbindungen.
2. Klicken Sie auf Verbindung erstellen.
3. Klicken Sie auf den Authentifizierungstyp API-Schlüssel.
4. Geben Sie unter Verbindungsname die Zeichenfolge openweather_api_key ein.
5. Geben Sie unter Name der Kopfzeile die Zeichenfolge x-api-key ein.
6. Geben Sie unter Wert Ihren OpenWeather-API-Schlüssel ein.
7. Geben Sie unter Zulässige Domäne die Zeichenfolge api.openweathermap.org ein.
8. Klicken Sie auf Speichern, um die Verbindung zu erstellen.

Aufgabe 3: Angepasstes Ticketfeld erstellen

Erstellen Sie anschließend ein angepasstes Ticketfeld, in dem der Endbenutzer den gewünschten Ort angeben kann.

So erstellen Sie das angepasste Ticketfeld

1. Klicken Sie in der Seitenleiste des Admin Centers auf Objekte und Regeln und dann auf Tickets > Felder.
2. Klicken Sie auf Feld hinzufügen.
3. Wählen Sie den Feldtyp Text aus.

   

4. Geben Sie unter Anzeigename die Zeichenfolge Ort ein.
5. Klicken Sie unter Berechtigungen auf Kunden können bearbeiten.
6. Geben Sie unter Kunden in das Feld Für Kunden sichtbarer Titel die Zeichenfolge Ort ein.
7. Klicken Sie auf Speichern.

Wenn in Ihrem Konto nur ein Ticketformular verwendet wird, erscheint das neue Feld automatisch in Ihrem Ticketformular. Wie Sie das Feld entfernen, erfahren Sie unter Erstellen von Ticketformularen.

Aufgabe 4: Antwort mit dem Flow Builder erstellen

In diesem Abschnitt erfahren Sie, wie Sie die Antwort erstellen, ihre Absicht festlegen und Schritte für die Antwort im Flow Builder hinzufügen. Er umfasst die folgenden Schritte:

• Schritt 1: Antwort erstellen
• Schritt 2: Absicht der Antwort festlegen
• Schritt 3: Schritt für die anfängliche Nachricht hinzufügen
• Schritt 4: Endbenutzer nach einem Ort fragen
• Schritt 5: Wetterdaten für den Ort abrufen
• Schritt 6: Wetterbericht an den Endbenutzer senden
• Schritt 7: Fehlermeldung hinzufügen
• Schritt 8: Aktualisierten Bot veröffentlichen

Schritt 1: Antwort erstellen

Verwenden Sie den Flow Builder, um eine Antwort für Ihren Messaging-Bot zu erstellen.

So erstellen Sie die Antwort

1. Klicken Sie in der Seitenleiste des Admin Centers auf Kanäle und dann auf Bots und Automatisierung > Bots.
2. Setzen Sie den Mauszeiger auf den gewünschten Bot und klicken Sie auf Bearbeiten.
3. Klicken Sie auf Antwort erstellen.

Schritt 2: Absicht der Antwort festlegen

Legen Sie die Absicht der Antwort und die Trainingssätze fest. Hierzu gehören Sätze und Wörter, die in einer Konversation als Auslöser für die Antwort dienen.

So legen Sie die Antwort der Antwort fest

1. Klicken Sie in der Registerkarte „Antworten“ der Bearbeitungsseite des Bots auf Antwort erstellen.
2. Geben Sie unter Absicht die Zeichenfolge Wetter abrufen ein.
3. Geben Sie unter Trainingssätze die Zeichenfolgen Wettervorhersage anzeigen und Aktuelle Temperatur anzeigen ein.
4. Klicken Sie auf Next.

   Die Antwort wird im Flow Builder geöffnet, in dem Sie die Reaktion des Bots bearbeiten können.

Schritt 3: Schritt für die anfängliche Nachricht hinzufügen

Fügen Sie den Schritt Nachricht senden hinzu, um den Benutzer zu bitten, einen Ort einzugeben. Das ist der erste Schritt im Antwort-Konversationsfluss.

So fügen Sie einen Schritt für die anfängliche Nachricht hinzu

1. Klicken Sie im Flow Builder auf Schritt hinzufügen.
2. Klicken Sie unter Schritt auswählen auf Nachricht senden.
3. Geben Sie unter Bot-Nachricht den folgenden Text ein:

   What location would you like to get the weather for?
   
   Include the country code. For example: "Melbourne, AU" or  "San Francisco, US"

Schritt 4: Endbenutzer nach einem Ort fragen

Fügen Sie nach der anfänglichen Nachricht den Schritt Details anfordern hinzu, damit für den Endbenutzer ein einfaches Formular angezeigt wird. Dieses Formular enthält ein Textfeld für den Wert des Ticketfelds Ort.

So fügen Sie den Schritt „Details anfordern“ hinzu

1. Klicken Sie im Flow Builder auf das Symbol Schritt hinzufügen ().
2. Klicken Sie unter Schritt auswählen auf Details anfordern.
3. Geben Sie unter Name die Zeichenfolge Ort abfragen ein.
4. Wählen Sie unter Felder das Ticketfeld Ort aus.

Schritt 5: Wetterdaten für den Ort abrufen

Fügen Sie den Schritt API-Aufruf durchführen hinzu, um die Wetterdaten zum jeweiligen Ort vom Endpunkt Current weather data der OpenWeather API abzurufen.

So fügen Sie den Schritt „API-Aufruf durchführen“ hinzu

1. Klicken Sie im Flow Builder auf Schritt hinzufügen.
2. Klicken Sie unter Schritt auswählen auf API-Aufruf durchführen.
3. Geben Sie unter Name die Zeichenfolge Wetter abrufen ein.
4. Geben Sie unter API-Details die Zeichenfolge https://api.openweathermap.org/data/2.5/weather?units=metric&q= als Endpunkt-URL ein.
5. Klicken Sie auf das Symbol Variable hinzufügen (), um dem Wert Endpunkt-URL die Feldvariable Ort anzuhängen.

   Der fertige Wert Endpunkt-URL sollte ungefähr so aussehen:

   

6. Klicken Sie unter Authentifizierung auf die Verbindung openweather_api.
7. Klicken Sie auf API-Aufruf durchführen, um die API-Anfrage zu testen.
8. Geben Sie unter Testdaten als Ort die Zeichenfolge Melbourne, AU ein.
9. Klicken Sie auf API-Aufruf durchführen.
10. Speichern Sie die folgenden Variablen unter ihren Standardnamen:
    • main > temp
    • weather > item 1 > description

Schritt 6: Wetterbericht an den Endbenutzer senden

Verwenden Sie nach Abruf der Wetterdaten den Schritt Nachricht senden, um mit einer Nachricht zu antworten, die die Wetterdaten enthält.

So fügen Sie eine API-Erfolgsmeldung hinzu

1. Klicken Sie im Flow Builder unter der Verzweigung API-Aufruf erfolgreich des Schritts Wetter abrufen auf Schritt hinzufügen.
2. Klicken Sie unter Schritt auswählen auf Nachricht senden.
3. Geben Sie unter Bot-Nachricht den folgenden Text ein:

   It's {{temp}}° C with {{description}} in 

4. Klicken Sie auf das Symbol Variable hinzufügen (), um dem Wert Bot-Nachricht die Feldvariable Ort anzuhängen. Fügen Sie anschließend einen Punkt (.) hinzu.

   Der fertige Wert Bot-Nachricht sollte ungefähr so aussehen:

   

Schritt 7: Fehlermeldung hinzufügen

Es kann vorkommen, dass die Anfrage im Schritt API-Aufruf durchführen fehlschlägt. Dies geschieht zum Beispiel, wenn sie einen Ort enthält, der nicht existiert. Fügen Sie zur Verzweigung API-Aufruf fehlgeschlagen den Schritt Nachricht senden hinzu. Dieser Schritt gibt eine Nachricht zurück, wenn der Aufruf der OpenWeather API fehlschlägt.

So fügen Sie eine API-Fehlermeldung hinzu

1. Klicken Sie im Flow Builder unter der Verzweigung API-Aufruf fehlgeschlagen des Schritts Wetter abrufen auf Schritt hinzufügen.
2. Klicken Sie unter Schritt auswählen auf Nachricht senden.
3. Geben Sie unter „Bot-Nachricht“ den folgenden Text ein:

   I'm sorry. I wasn't able to get weather data for 

4. Klicken Sie auf das Symbol Variable hinzufügen (), um dem Wert Bot-Nachricht die Feldvariable Ort anzuhängen. Fügen Sie anschließend einen Punkt (.) hinzu.

   Der fertige Wert Bot-Nachricht sollte ungefähr so aussehen:

   

Schritt 8: Aktualisierten Bot veröffentlichen

Veröffentlichen Sie den aktualisierten Bot, um die Antwort zu aktivieren.

So veröffentlichen Sie den Bot

1. Klicken Sie oben rechts im Flow Builder auf Fertig.
2. Klicken Sie auf der Seite des Bots auf Bot veröffentlichen.
3. Klicken Sie auf Veröffentlichen.

Aufgabe 5: Änderungen testen

Nachdem Sie Ihre Änderungen veröffentlicht haben, können Sie die neue Antwort testen, indem Sie in einer Konversation mit dem aktualisierten Bot die Frage „Wie ist das Wetter?“ stellen. Weitere Informationen zum Testen von Messaging-Bots finden Sie unter Testen des Messaging-Erlebnisses der Endbenutzer.