REST-API zum Auslösen KI-gestützter ausgehender Anrufe an Ihre Kontakte. Lösen Sie
einen einzelnen Anruf oder mehrere Anrufe auf einmal aus, personalisieren Sie den
Prompt pro Anruf und verfolgen Sie die Ergebnisse.
Basis-URL: https://aipro.placetel.de/api/v1/outbound
Authentifizierung
Jede Anfrage muss ein Bearer-Token im Authorization-Header senden:
Erzeugen (oder erneuern) Sie Ihr Token auf der Seite Ausgehende Anrufe in Ihrem
Dashboard („API-Token generieren”). Das Token wird nur einmal angezeigt — bewahren
Sie es sicher auf; beim Erneuern wird das vorherige Token ungültig. Jedes Token
erreicht nur Ihre eigenen Assistenten und Daten.
Alle Rufnummern müssen im E.164-Format vorliegen — ein +, gefolgt von Ziffern.
Senden Sie das exakte Format; Nummern werden nicht für Sie umformatiert.
Endpunkte
Einzelnen Anruf auslösen
Löst einen einzelnen ausgehenden Anruf aus. Der Anruf wird sofort gewählt.
Anfrage-Body (JSON)
Antwort
Verwenden Sie call_id, um den Anruf zu referenzieren. Ergebnis und Transkript des
Anrufs erscheinen in Ihrem Dashboard — siehe Ergebnisse verfolgen.
Mehrere Anrufe auf einmal auslösen
Löst Anrufe an mehrere Zielrufnummern in einer Anfrage aus. Bis zu 10
Zielrufnummern.
Anfrage-Body (JSON)
Jede Zielrufnummer ist ein Objekt mit einem Feld phone und optionalen
prompt_variables pro Zielrufnummer:
Wenn Sie keine Werte pro Zielrufnummer benötigen, lassen Sie prompt_variables weg:
Um für alle Zielrufnummern dieselben Werte zu verwenden, senden Sie stattdessen
ein einzelnes prompt_variables auf oberster Ebene:
prompt_variables auf oberster Ebene und pro Zielrufnummer können nicht
kombiniert werden — nutzen Sie das eine oder das andere.
Die gesamte Anfrage wird validiert, bevor ein Anruf ausgelöst wird. Schlägt
die Validierung fehl — etwa ein ungültiges Rufnummernformat, mehr als 10
Zielrufnummern oder eine fehlende bzw. ungültige Prompt-Variable — wird die
gesamte Anfrage mit einem 400 abgelehnt, und es werden keine Anrufe
ausgelöst.
Nach bestandener Validierung wird jede Zielrufnummer unabhängig gewählt.
Schlägt bei einer Nummer der Anruf auf Telefonieebene fehl, werden die übrigen
trotzdem ausgeführt — ein Sammelauftrag kann also je Zielrufnummer eine Mischung
aus Erfolgen und Fehlern zurückgeben (siehe die Antwort unten).
Doppelte Zielrufnummern (identische Nummern) werden entfernt — jede eindeutige
Nummer wird einmal angerufen.
Antwort
Ein Sammelauftrag liefert 201 zurück, auch wenn einzelne — oder alle — Anrufe
fehlschlagen: Prüfen Sie success und status je Eintrag in results[]; die
Zähler succeeded / failed auf oberster Ebene fassen den Sammelauftrag zusammen.
Ein anderer Status als 201 bedeutet, dass die gesamte Anfrage abgelehnt wurde
(siehe Fehler). Die Ergebnisse der Anrufe erscheinen zudem in Ihrem
Dashboard — siehe Ergebnisse verfolgen.
Ergebnisse verfolgen
Die Ergebnisse der Anrufe finden Sie in Ihrem Dashboard — im Verlauf ausgehender Anrufe
oder in den Konversationen: ob der jeweilige Anruf zustande kam, samt vollständigem
Gespräch und Transkript. Filtern Sie nach dem Assistenten, mit dem Sie die Anrufe ausgelöst haben, um sie zu finden.
Prompt personalisieren
Setzen Sie zur Anrufzeit dynamische Werte in den Prompt Ihres Assistenten ein, damit
jeder Empfänger eine individuell zugeschnittene Nachricht hört.
1. Platzhalter hinzufügen — im Prompt des Assistenten mit der {{name}}-Syntax:
2. Werte übergeben — in prompt_variables beim Auslösen des Anrufs:
Der Prompt wird vor dem Anruf mit Ihren Werten aufgelöst.
Regeln
- Jeder
{{Platzhalter}} im Prompt muss übergeben werden, sonst wird die Anfrage
mit 400 abgelehnt.
- Nicht im Prompt verwendete Schlüssel werden akzeptiert und ignoriert.
- Schlüsselnamen sollten in Kleinbuchstaben und
snake_case sein (Buchstaben,
Ziffern, Unterstriche), z. B. customer_name.
- Werte müssen Zeichenketten sein (senden Sie Zahlen und boolesche Werte als
Zeichenketten, z. B.
"3", "true").
- Bis zu 25 Schlüssel; jeder Wert bis zu 500 Zeichen.
- Nutzen Sie im Sammelauftrag entweder
prompt_variables pro Zielrufnummer oder
gemeinsam auf oberster Ebene, nicht beides.
Fehler
Alle Fehler haben dieselbe Form:
HTTP-Statuscodes
Häufige Validierungsfehler (400)
Schnellstart
Ein Anruf:
Personalisierte Sammelanrufe:
Ergebnisse prüfen — Ergebnisse und Transkripte der Anrufe erscheinen in Ihrem
Dashboard; siehe Ergebnisse verfolgen.