API-Tool erstellen und testen¶

Mit einem API-Tool kann der Agent zum Beispiel einen Auftragsstatus abrufen oder einen Rückrufwunsch in deinem CRM anlegen. Für die Einrichtung brauchst du die Dokumentation und Zugangsdaten des verbundenen Dienstes.

Ein vollständiges Beispiel mit Eingabeschema, Toolbeschreibung und Gesprächsablauf findest du unter Serviceanfrage aufnehmen.

1. Anfrage definieren¶

Füge unter Aktionen → Tools eine HTTP-API-Anfrage hinzu. Vergib Namen und Ausführungsbeschreibung und lege Methode, URL, Timeout sowie erforderliche Header fest.

Beispieleinstellung	Wert
Name	`create_callback_request`
Methode	`POST`
URL	`https://api.example.com/callbacks`
Inhaltstyp	`application/json`
Hintergrundausführung	Aus, wenn der Anrufer bestätigten Erfolg benötigt

Ersetze die Beispiel-URL durch den Endpunkt deines Dienstes. Übernimm Methode und Felder aus dessen API-Dokumentation und wähle die passenden Zugangsdaten. Falls verfügbar, kannst du mit einer Integrationsvorlage beginnen.

2. Eingaben beschreiben¶

Definiere im Schema-Editor Pfad-, Query- und Body-Eingaben. Für einen Rückruf-Body:

Feld	Typ	Pflicht	Beschreibung
`name`	String	Ja	Bestätigter Anrufername
`reason`	String	Ja	Grund für den Rückruf
`phone_number`	String	Ja	Bestätigte Rückrufnummer

Lege nur die Pflichtfelder fest, die dein Dienst benötigt. Achte auf die Datentypen. Der Wahrheitswert false und der Text "false" sind unterschiedliche Eingaben.

{
  "name": "Beispielperson",
  "reason": "Frage zur Leistung",
  "phone_number": "CONFIRMED_E164_NUMBER"
}

Ersetze den Rufnummernplatzhalter vor dem Senden durch deine Testnummer. Prompt und Tool-Beschreibung sollen die Bestätigung vor dem Erstellen der Anfrage verlangen.

3. Antwort steuern¶

Wähle Originalantwort, Zugeordnete Antwort oder JEXL-Skript, um die Daten für den Agenten festzulegen. Antwort-Mapping entfernt unnötige Felder und vereinheitlicht das Ergebnis.

Bei längeren Abfragen kannst du eine Fortschrittsmeldung aktivieren. Der Agent sagt dann beispielsweise, dass er die Angaben gerade prüft. Ein Ergebnis soll er erst bestätigen, wenn die Antwort des Dienstes vorliegt.

4. Im Editor testen¶

Nutze das Testpanel mit Formularfeldern oder, wo angeboten, rohem JSON. Prüfe Typen, Pflichtfelder und Anfragevorschau. Das Ausführen kontaktiert den echten Endpunkt und kann Datensätze erstellen oder ändern.

Vergleiche die ursprüngliche API-Antwort mit der verarbeiteten Antwort für den Agenten. Änderungen am Mapping oder Skript kannst du mit Beispiel-JSON in der Vorschau prüfen, ohne die Anfrage erneut zu senden.

5. Zuweisen und im Anruf testen¶

Weise das gespeicherte Tool dem vorgesehenen Agent zu. Teste vollständige Eingaben, fehlende Angaben und einen API-Fehler. Prüfe den Datensatz im Zielsystem und die abschließende Aussage des Agenten. Lass Im Hintergrund ausführen deaktiviert, wenn das Gespräch auf Erfolg warten muss.

Für eine Abfrage am Anrufanfang nutze Pre Processing, für Versand nach dem Anruf Post Processing.