SpeakKI API für Entwickler
Mit der SpeakKI API steuern Sie Ihren Assistenten aus eigenen Programmen. Ihr Terminsystem lässt zum Beispiel am Vortag an jeden Termin erinnern, Ihr CRM stößt einen Rückruf an.
Was die API kann
Abschnitt betitelt „Was die API kann“- Anrufe starten: Ihr Assistent ruft eine Nummer an, sofort oder zu einem geplanten Zeitpunkt. Siehe Anrufe starten.
- Kampagnen: Ihr Assistent ruft eine Liste von Empfängern nacheinander an. Siehe Kampagnen.
- Daten lesen: geführte Gespräche mit Zusammenfassung und erfassten Angaben, dazu Kontakte und Termine. Siehe Gespräche, Kontakte, Termine.
- Sperrliste pflegen: Nummern eintragen, die nie angerufen werden. Siehe Regeln und Grenzen.
- Webhooks empfangen: Ihr Programm erfährt sofort, wenn ein Gespräch, ein Anruf oder eine Kampagne beendet ist. Siehe Webhooks.
Den ersten Anruf starten Sie mit dem Schnellstart in wenigen Minuten.
Voraussetzungen
Abschnitt betitelt „Voraussetzungen“| Was | Wofür | Wo |
|---|---|---|
| Tarif Professional | API-Zugang und ausgehende Anrufe | Einstellungen › Abrechnung |
| API-Schlüssel | jede Anfrage | KI einstellen › Verbindungen › Webhooks & API |
| Freischaltung für ausgehende Anrufe | Anrufe und Kampagnen | Ausgehende Anrufe › Freischaltung beantragen |
| Assistent mit dem Abschnitt Ausgehende Anrufe | Anrufe und Kampagnen | am Assistenten: Ausgehende Anrufe erlauben einschalten, Begrüßung, Auftrag und Absender hinterlegen |
Für das Lesen von Gesprächen, Kontakten und Terminen reichen Tarif und Schlüssel.
Die Freischaltung beantragt ein Administrator Ihrer Organisation einmalig. Sie nennen den Anwendungsfall und bestätigen die Regeln für ausgehende Anrufe. Das SpeakKI-Team prüft den Antrag und gibt ihn frei.
Basis-Adresse und Format
Abschnitt betitelt „Basis-Adresse und Format“https://api.speakki.de/v1- Anfragen und Antworten sind JSON in UTF-8. Senden Sie bei
POSTden HeaderContent-Type: application/json. - Jede Anfrage trägt Ihren Schlüssel:
Authorization: Bearer spk_live_.... Siehe Authentifizierung. - Feldnamen stehen in
snake_case, Status und Ergebnisse klein geschrieben. - Zeiten sind ISO 8601 in UTC, zum Beispiel
2026-11-16T09:00:00.000Z. - Telefonnummern stehen in E.164, zum Beispiel
+4915228817386. - Unbekannte Felder in einer Anfrage lehnt die API mit
invalid_requestab.
Blättern in Listen
Abschnitt betitelt „Blättern in Listen“Listen liefern data und next_cursor. Mit limit wählen Sie 1 bis 100 Einträge je Seite, Standard ist 25. Für die nächste Seite senden Sie next_cursor als cursor. Ist next_cursor gleich null, gibt es keine weitere Seite.
curl "https://api.speakki.de/v1/calls?limit=50&cursor=WERT_AUS_NEXT_CURSOR" \ -H "Authorization: Bearer spk_live_IHR_SCHLUESSEL"Referenz und OpenAPI
Abschnitt betitelt „Referenz und OpenAPI“- API-Referenz: jede Anfrage mit Feldern, Antworten und Beispielen.
- OpenAPI-Datei (Version 3.1) zum Herunterladen, zum Beispiel für Postman oder einen Code-Generator. Die API liefert dieselbe Datei unter
https://api.speakki.de/v1/openapi.json.