Call Connection (Anrufverbindung) im ActionBot

Download as PDF

Kurzübersicht

Die Option Call Connections in ActionBot bietet die Möglichkeit, während einer Konversation eine vordefinierte externe API aufzurufen.

Beim Aufruf einer API ist der Bot in der Lage, Parameter an die API zu senden und Parameter in der Antwort zu erhalten.

Warum sollte dieser Connector verwendet werden?

Die Verwendung einer externen API ermöglicht ActionBot die Integration mit mehreren Systemen und bietet eine Vielzahl von Optionen beim Erstellen eines Gesprächs.

Die API kann verwendet werden, um Informationen an eine externe API zu senden (z. B. Öffnen eines IT-Tickets), Informationen von einer externen API zu empfangen (z. B. Abrufen einer Ticketnummer) oder beides.

Verwenden der Anrufverbindung

Video-Tutorial

Schauen Sie sich dieses kurze Tutorial zur Verwendung von ActionBot für das Öffnen eines Tickets an.

Schritt 1: Eine Verbindung erstellen

In diesem Abschnitt wird beschrieben, wie Sie eine neue Verbindung zum ActionBot-Editor-Konto hinzufügen. Die Verwendung der Verbindung während eines Gesprächs wird im nächsten Schritt ausgeführt.

1. Klicken Sie im Abschnitt Connections auf „ADD NEW CONNECTION“ (NEUE VERBINDUNG HINZUFÜGEN).
2. Wählen Sie „Add new Destination“ (Neues Ziel hinzufügen) aus.

3. Definieren Sie alle benötigten Parameter im Dialogfenster und klicken Sie auf „Create“ (Dies ist ein Konfigurationsschritt und diese Parameter sollten vom API-Besitzer bereitgestellt werden).

1. 1. Zielname –
      • Geben Sie einen benutzerfreundlichen Namen an, mit dem die Verbindung später im Prozess identifiziert werden kann.
      • Sie können jeden beliebigen Namen auswählen.
   2. Anforderungstyp –
      • Kann GET/POST/DELETE/PUT sein.
      • Sollte vom API-Eigentümer bereitgestellt werden.
   3. Ziel-URL –
      • Muss eine legale API-URL sein.
      • Sollte vom API-Eigentümer bereitgestellt werden.
      • Ziel-URL kann dynamische Abfrageparameter enthalten.
      • Um einen dynamischen Abfrageparameter innerhalb einer Ziel-URL zu erstellen, schließen Sie den String-Wert mit geschweiften Klammern ein.
      • Zum Beispiel: https://test.api/{production}/
      • Die Ziel-URL kann auch BBcode-Variablen enthalten, mit denen Benutzer die dynamischen URL-Parameter den Antworten von Endbenutzern zuordnen oder Bbcode-unterstützte Umgebungsvariablen wie wm-data, Cookies und jquery verwenden können.
   4. Authentifizierungstyp – Derzeit unterstützen wir nur drei Arten der Authentifizierung.
      1. Keine Authentifizierung – Erfordert keine Informationen.
      2. Bearertoken – Erfordern ein Authentifizierungs-Token.
      3. Basisauthentifizierung – Erfordert Benutzer + Passwort.
         • Beachten Sie, dass das Passwort für die grundlegende Authentifizierung kein Doppelpunktsymbol enthalten darf:
   5. Headers (optional) – Einige APIs erfordern oder erlauben Header.
   6. Es wird empfohlen, die API-Verbindung zu testen, um sicherzustellen, dass alle Details korrekt sind.

4. Die neue Verbindung sollte zur Liste der Verbindungen hinzugefügt werden.

Schritt 2: Die Aktion „Call connection“ während eines Gesprächs hinzufügen

In diesem Abschnitt wird beschrieben, wie Sie eine Verbindung, die im vorherigen Schritt definiert wurde, während eines Gesprächs verwenden.

1. Hinzufügen einer neuen Aktion.
2. Wählen Sie den Aktionstyp „Call Connection“ aus und wählen Sie das Ziel der Anrufverbindung. Das Ziel der Anrufverbindung ist der Name der Verbindung, die im vorherigen Schritt definiert wurde.

• Bei der Verwendung von „Call Connections“ (Anrufverbindungen) mit dynamischen Abfrageparametern, BBcode-Variablen oder beidem können Benutzer die Antworten von Endbenutzern als dynamische Abfrageparameter den Ziel-URLs zuordnen.
  1. Dynamische Abfrageparameter und BBcode-Variablen werden unter der Eingabe „Select Call Connection Destination“ (Anrufverbindungsziel auswählen) angezeigt, wenn das Ziel einen dynamischen Abfrageparameter oder eine BBcode-Variable enthält.
  2. Aufgelistete dynamische Abfrageparameter oder BBcode-Variablen können den Konversationselementen über das Dropdown-Menü zugeordnet werden.
  3. 

3. Definieren Sie „Data the WalkMe Connection Call sends (optional) (Daten, die der WalkMe-Verbindungsaufruf sendet (optional)

Es ist möglich, einige In-Conversation-Parameter an den API-Aufruf zu senden. In jeder Zeile definiert die linke Seite, welche Gesprächsdaten gesendet werden sollen, und die rechte Seite definiert den Namen des Parameters, den die API zu empfangen erwartet.

Im folgenden Beispiel erwartet die API einen Parameter namens „base“, und wir definieren, dass der Wert von „base“ die Antwort des Benutzers auf eine vorherige Frage enthält (in diesem Fall „Welche Währung?“).

Mit einem Klick auf „raw“ können Sie die Parameter im XML- oder JSON-Format frei bearbeiten.

4. Definieren Sie Response Data Mapping (optional)

Einige APIs geben eine Antwort zurück. Wenn die Antwort im XML- oder JSON-Format vorliegt, ist es möglich, diese Antwort zu verwenden und sie in neuen Variablen zu speichern, die später im Gespräch verwendet werden können.

Mapping der Antwort in eine neue Variable –

Der Benutzer kann beliebig viele Variablen hinzufügen. Für jede Variable muss Folgendes definiert werden:

• Name – Wählen Sie einen Namen für die neue Variable.
  • Fügen Sie Variablennamen keine Sonderzeichen hinzu, z. B. Bindestrich, Gedankenstrich, Doppelpunkt, ; , (), !*, - {} @
• Typ – Definieren Sie den Typ der neuen Variablen. Derzeit unterstützen wir nur primitive Typen String/Number/Boolean/Array.
• Pfad – Definieren Sie den Pfad in der JSON/XML-Antwort, der zu den gewünschten Informationen führt. Um den Benutzer bei der Definition des Pfades zu unterstützen, wurde ein „path constructor“ (Pfadkonstruktor)-Werkzeug hinzugefügt. Wenn Sie darauf klicken, pingt der Editor die Ziel-API an, um eine Beispielantwort zu erhalten. Auf diese Weise kann der Benutzer durch die Beispielantwort navigieren, um den Pfad einfach zu definieren. Wenn die API die Übermittlung eines Parameters erfordert, fordert der Pfadkonstruktor zur Angabe von Beispielparametern auf............................
• Standardwert – Dieser Wert wird in der Variablen gespeichert, falls der definierte Pfad in der Antwort nicht zu gültigen Daten führt.
• Fehlerwert – Dieser Wert wird in der Variablen gespeichert, falls der API-Aufruf fehlschlägt.

Schritt 3: Verwenden der Antwortdaten-Variablen während des Gesprächs

Falls eine neue Variable aus den Antwortdaten erstellt wurde, kann diese später im Gespräch durch Verwendung von „@“ in den folgenden Fällen verwendet werden:

1. In einer Nachricht – Anzeige der Variable für den Benutzer als Teil eines Nachrichtentextes
2. In einer Frage – Anzeige der Variable für den Benutzer als Teil des Fragetextes
3. In einer Auswahlfrage – Anzeige der Variable für den Benutzer als Teil des Vorschlags Bei einer Variablen vom Typ Array wird jedes Feld im Array als separater Vorschlag angezeigt. Wenn das Array Objekte enthält (anstelle eines einzelnen Attributs für jedes Element), können Sie festlegen, welches Attribut dem Benutzer angezeigt und welches Attribut gespeichert werden soll.
4. In einer Bedingung – Der Condition Builder kann die Variable als Basis für eine Bedingung verwenden.
5. In einem WM-Inhalt (z. B. SWT) – Beim Abspielen eines WalkMe-Inhalts (über eine Aktion) können die Variablen für Daten verwendet werden, die der Inhalt benötigt.

Tipp – Dienstag-Videos