Suite | Team, Growth, Professional, Enterprise oder Enterprise Plus |
In diesem Beitrag erfahren Sie, wie Sie diesen Schritt in einen AI Agent für Messaging einbinden und konfigurieren.
Allgemeine Informationen zum Schritt API-Aufruf durchführen und den entsprechenden Konfigurationsregeln finden Sie im Beitrag Überblick über die Schrittarten für AI Agents: API-Aufruf durchführen.
Dieser Beitrag enthält die folgenden Abschnitte:
Hinzufügen des Schritts „API-Aufruf durchführen“ zu einem AI Agent
Um den Schritt API-Aufruf durchführen zu einem AI Agent hinzuzufügen, sind mehrere Aufgaben erforderlich.
So fügen Sie den Schritt „API-Aufruf durchführen“ hinzu
- Klicken Sie in der Seitenleiste des Admin Centers auf
KI und dann auf AI Agents > AI Agents.
- Klicken Sie auf AI Agents für Messaging verwalten.
- Klicken Sie auf den Namen des AI Agent, den Sie bearbeiten möchten.
- Klicken Sie auf die Registerkarte Antworten und erstellen Sie eine neue Antwort bzw. öffnen Sie eine vorhandene Antwort.
- Klicken Sie im Bot-Builder an der Stelle, an der Sie den Schritt einfügen möchten, auf das Symbol Schritt hinzufügen: entweder am Ende einer Verzweigung oder zwischen zwei vorhandenen Schritten.
- Klicken Sie im Konfigurationsfenster auf API-Aufruf durchführen.
- Geben Sie aussagekräftige Informationen zu diesem Schritt ein.
- Name: Ein Name, an dem Ihr Team den Aufruf leicht erkennt.
- Beschreibung (optional): Eine kurze Beschreibung der durch den Anruf ausgelösten Aktion.
Diese Informationen sind für Kunden nicht sichtbar.
- Fahren Sie wie unter Hinzufügen von API-Details beschrieben fort.
Hinzufügen von API-Details
Konfigurieren Sie im Abschnitt „API-Details“ den gewünschten HTTP-Aufruf, indem Sie die HTTP-Anfragemethode und den Standort der externen Ressource angeben sowie bei Bedarf weitere Header hinzufügen. Die folgenden Schritte sind eine Fortsetzung des im vorherigen Abschnitt beschriebenen Verfahrens.
So fügen Sie die API-Details hinzu
- Klicken Sie im Konfigurationsfenster auf API-Details.
- Wählen Sie eine Anfragemethode:
- GET ruft eine externe Ressource vom API-Service ab. Dies ist die am häufigsten verwendete Methode.
- POST sendet Daten, um eine Ressource in einem externen System zu erstellen. Wenn die Ressource bereits vorhanden ist, wird sie durch die gesendeten Daten geändert.
- PUT sendet Daten, um eine Ressource zu aktualisieren.
- PATCH sendet Daten, um eine Ressource an einem externen Standort zu aktualisieren. Mit dieser Methode werden Teile der Ressource verändert.
- DELETE entfernt die Ressource am externen Standort.
- Geben Sie eine Endpunkt-URL ein.
Die Endpunkt-URL ist der Standort der externen Ressource, zu der eine Verbindung hergestellt werden soll. Die Endpunkt-URL unterstützt das
https://
-Protokoll. Sie können Variablen in den Pfad oder in die Query-Zeichenfolge einer URL einfügen. Weitere Informationen finden Sie unter Übergeben von Variablen in einem API-Aufruf. - Wählen Sie optional eine Verbindung zur Authentifizierung des API-Aufrufs.
Hinweis: Sie müssen eine Verbindung erstellen, bevor Sie sie im Schritt API-Aufruf durchführen verwenden können.
- Geben Sie bei Bedarf den Schlüssel und den Wert für einen optionalen Header ein. Wichtig: Verwenden Sie für Authentifizierungstypen keine HTTP-Header, sondern stattdessen API-Verbindungen.
Wenn der Schritt API-Aufruf durchführen authentifizierungsbezogene Header wie
authorization
oderx-api-key
enthält, schlägt er automatisch fehl. Wenn ein Schritt API-Aufruf durchführen fehlschlägt, folgt die Konversation den Schritten der Verzweigung API-Aufruf fehlgeschlagen. - Klicken Sie auf API-Aufruf durchführen, um den API-Aufruf zu testen.
Wenn zur URL oder zum Header des Schritts Variablen hinzugefügt werden, können Sie optionale Testdaten für Ihren externen Service eingeben, um zu prüfen, ob der API-Aufruf wie erwartet funktioniert. Beachten Sie, dass hierbei eine HTTP-Anfrage an die konfigurierte Endpunkt-URL gesendet wird.
Übergeben von Variablen in einem API-Aufruf
Wenn Sie eine Endpunkt-URL für einen API-Aufruf eingeben, können Sie Variablen in den Pfad oder die Query-String einer URs einfügen. Damit können Sie Daten aus der Konversation an das externe System weitergeben.
So kann ein AI Agent für Messaging einen Kunden beispielsweise mit dem Schritt Details anfordern auffordern, eine Bestellnummer einzugeben. Der AI Agent kann dann über den Schritt API-Aufruf durchführen den Versandstatus für die Bestellung aus Ihrem Online-Shop abrufen.
Sie können keine Variablen in der Domäne oder Subdomäne einer Endpunkt-URL verwenden. Die folgende Tabelle enthält Beispiele für gültige und ungültige Werte für die Endpunkt-URL.
Gültige Endpunkt-URL | Ungültige Endpunkt-URL |
---|---|
https://myshopify.com/admin/api/orders/order_number.json Eine Bestellung anhand der Bestellnummer aus Shopify abrufen. ![]() |
Variablen können nicht zur Domäne/Subdomäne hinzugefügt werden |
Einen Ort per Schlüsselwortsuche aus der Google Places API abrufen. |
Variablen können nicht zum Query-Stringschlüssel hinzugefügt werden. |
Wenn eine Variable ungültig oder leer ist, überspringt der AI Agent die Variable während einer Konversation.
Speichern von Variablen aus der API-Antwort
Nachdem Sie die Details konfiguriert und den API-Aufruf getestet haben, können Sie die Werte aus der JSON-Antwort des API-Aufrufs als Variablen speichern. Im Schritt API-Aufruf durchführen können Sie bis zu 12 Variablen speichern. Es werden nur die ersten 280 Zeichen eines Variablenwerts gespeichert.
So erstellen Sie eine Variable anhand der Antwortdaten
- Klicken Sie im Konfigurationsfenster auf API-Aufruf durchführen.
- Erweitern Sie das Akkordeon und identifizieren Sie die Daten aus dem externen System, die Sie in eine Variable umwandeln möchten.
Tipp: Die vom externen System zurückgegebene Rohdatenantwort können Sie in der Registerkarte „Antworttext“ einsehen.
- Klicken Sie auf Speichern.
- Legen Sie einen Namen für die neue Variable fest.
Variablennamen dürfen nur Kleinbuchstaben, Ziffern und Unterstriche enthalten.
Übergeben von Array-Variablen in einem API-Aufruf
{
"info": {
"count": 50,
"pages": 2,
"next": "https://mycompany.com/api/orders?page=2",
"prev": null
},
"results": [
{
"id": 1052,
"name": "Alexander Cummings",
“address”: “123 MyStreet”,
"Item": "belt",
"price": "15.00",
"image": "https://mycompany.com/api/orders/avatar/1.jpeg",
…
id
, name
, address
, item
, price
und image
angezeigt. Diese Daten werden in der Regel an ein Karussell übergeben, in dem allerdings maximal 10 Elemente angezeigt werden können.
lastname
und firstname
als separate Array-Variablen gespeichert werden.
"name":
{
"lastname": "Cummings”,
"firstname": “Alexander"
},
Sie können das Array oder die Array-Werte nicht in der Karussellkonfiguration im Admin Center bearbeiten. Wenn Sie Daten ändern möchten, müssen Sie das Array im Admin Center löschen und ein neues Array erstellen.
{{customer.order}}
im folgenden Szenario leer ist. In diesem Fall wird Karte 1 mit dem Teiltitel „Order number“ dargestellt. Der Titel von Karte 2 ist leer, weshalb Karte 2 nicht angezeigt wird.
Card 1
Title: Order number {{customer.order}}
Description: Here's your order {{product.description}}
Card 2
Title: {{customer.order}}
Description: Here's your order {{product.description}}
Beispiel
{
"info": {
"count": 5,
"pages": 1
},
"results": [
{
"createdAt": "July 10, 2023",
"name": "Connie Stokes",
"Shippingaddress": "123 Street, City, State",
"order": {
"Status": "Ordered",
"Image": "https://images.pexels.com/photos/1484808/pexels-photo-1484808.jpeg"
},
"Quantity": 1,
"Price": 45,
"Item": "Shirt",
"id": "1"
},
…
In diesem Beispiel wird API-Aufruf durchführen verwendet, um die Array-Variable zu erstellen, und dann ein dynamisches Karussell, um die Ergebnisse einem Endbenutzer anzuzeigen.
So erstellen Sie das Array
- Klicken Sie im Konfigurationsfenster auf API-Aufruf durchführen.
- Geben Sie als Namen orders ein.
- Klicken Sie im Konfigurationsfenster auf API-Details.
- Klicken Sie auf das Dropdownmenü Anfragemethode und dann auf GET.
- Geben Sie die Endpunkt-URL ein.
- Wählen Sie unter Authentifizierung Ihre Authentifizierungsmethode aus.
Weitere Informationen finden Sie unter Erstellen von Verbindungen zur Integration mit externen Services.
- Klicken Sie auf API-Aufruf durchführen.
- Klicken Sie neben den Ergebnissen auf Speichern.
- Klicken Sie im Pulldownmenü Wert auf Order und dann auf Image.
Verwenden Sie den Standardvariablennamen („image“).
- Klicken Sie auf Element hinzufügen und wiederholen Sie den obigen Schritt, um Elemente für Order Status und Element zu erstellen.
Sie können bis zu 12 Elemente (oder Schlüssel-Wert-Paare) hinzufügen.
- Klicken Sie auf Speichern.
- Klicken Sie im Bot-Builder unter API-Aufruf erfolgreich auf Schritt hinzufügen und dann auf Karussell hinzufügen.
- Klicken Sie im Konfigurationsfenster auf In dynamische Nachricht umwandeln.
- Klicken Sie im Dropdownmenü Array auf results. Das ist das Array, das Sie oben erstellt haben.
- Klicken Sie für den Titel auf das Pluszeichen und wählen Sie results.item.
Sie können für den Titel und die Beschreibung bis zu 128 Zeichen eingeben.
- Klicken Sie unter Button link auf das Pluszeichen und wählen Sie results.image.
- Klicken Sie unter Button text auf das Pluszeichen und wählen Sie results.status.
- Klicken Sie unter Image link auf das Pluszeichen und wählen Sie results.image.
- Klicken Sie auf Fertig.
Hier ist ein Beispiel für ein dynamischen Karussell.
Überblick über die Schrittverzweigungen
Der Schritt API-Aufruf durchführen ist ein Verzweigungsschritt. Die weiteren Antworten des AI Agent hängen davon ab, ob die API-Anfrage erfolgreich ausgeführt wurde.
- Die API gibt den Antwortcode 400 oder 500 zurück.
- Eine der gespeicherten Variablen fehlt oder hat den Wert
null
.
In allen anderen Fällen durchläuft der AI Agent die Verzweigung „Erfolg“.
69 Kommentare
Wes
Has something changed regarding saving array variables? Following along with the example in this article, the option to click "save" beside "results" isn't there. If you expand results you can save individual lines in that array, but there's no option to save the entire array.
0
Raphaël Péguet - Officers.fr
Hello
I saw while trying that when the flow builder API calls succeeds but finds an answer where ALL the saved variables are not present the flow builder takes the API failed path..
It's very unlogical :s
My use case is to use answer bot api into the flow builder. So i've saved as variables the url and the title of the 3 first articles. and every time the API calls finds 3 articles it works, but when it finds 1 or two articles the flow builder takes the "fail path"
0
Riat Abduramani
Hello,
I have a question: Have you considered incorporating variables into the ticket contexts? Currently, I don't see any provision for variables in the JSON payload `/api/v2/tickets/xxxxx.json`. Alternatively, it would be beneficial to use variables to populate custom fields.
Thank you.
0
Riat Abduramani
Hi,
I hope this message finds you well. I would like to address an issue regarding the current functionality of the Live Chat and Messaging tools. Previously, in Live Chat, we had the ability to set variables such as tags and custom fields before initiating a chat. This allowed us to enrich the ticket with relevant contextual data, such as order references, customer information, and the nature of the request through custom plugin apps.
However, with the introduction of the Messaging tool, we have noticed a limitation. The variables are now set from the Answer Bot and API call, and we are unable to set certain important information, such as the order reference, in the custom field. This means that we can only rely on the information provided by the customer, which can sometimes result in incorrect input.
To overcome this challenge, it would be extremely helpful for us to have the ability to set tags, variables, and custom fields once the ticket has been created, thereby obtaining the necessary context. It would be great if we could implement a similar functionality as shown below in the chat:
I hope this clarifies my requirement. Thank you for your attention to this matter.
Best regards,
0
John
Hi Dane,
The company sent me this link to everything, so I'm assuming I can do all of it? Would you mind seeing if it's possible?
https://www.shipstation.com/docs/api/orders/get-order/
0
Dane
You can check the option in Using the Make API call step in Flow Builder. Please take note that customization is not part of Zendesk's scope.
The step above is only possible if Shipstation has API endpoints where you can make the calls.
0
John
Greetings, I have Shipstation App linked to Support. I would like to use the bot Flowbuilder to allow people to check the status of their order (shipped, accepted, tracking #, ec.)
Is this where I do it and how would I program it? Thanks for any help!
0
Shiyu Zhu
Song Chen Our current timeline is 10 seconds and there is no ability to customize this right now.
Could you please elaborate what is the use case you are trying to achieve with ChatGPT? Thanks
0
Shiyu Zhu
Hey Carlton Kirk,
Alongside with exposing external_id, we are also exposing end-users email and name, does those attributes help you at all in identifying the user?
0
Song Chen
I am currently working on including an external API(ChatGPT) into our bot. I am trying to do a POST request, but having "Request Taking Too Long" troubles .
Can I setting the time out boundary in Zendesk call API?
0
Anmelden, um einen Kommentar zu hinterlassen.