Information
- OpenAPI version:
3.1.0
Mit der Speakki API starten Sie ausgehende Anrufe und Kampagnen Ihrer Assistenten aus eigenen Programmen und lesen Gespräche, Kontakte und Termine.
Anmeldung: Jede Anfrage trägt einen API-Schlüssel als Authorization: Bearer spk_live_…. Schlüssel legen Sie im Dashboard unter Verbindungen an. Der API-Zugang ist ab dem Tarif Professional enthalten.
Berechtigungen: Jeder Schlüssel hat feste Berechtigungen.
calls:read: Anrufe lesen. Ausgehende und eingehende Anrufe, Assistenten und Rufnummern abrufen.calls:write: Anrufe starten. Ausgehende Anrufe starten und geplante Anrufe abbrechen.campaigns:read: Kampagnen lesen. Kampagnen mit Empfängern und Fortschritt abrufen.campaigns:write: Kampagnen verwalten. Kampagnen anlegen, starten, pausieren und abbrechen.contacts:read: Kontakte lesen. Kontakte der Organisation abrufen.appointments:read: Termine lesen. Termine der Organisation abrufen.suppressions:write: Sperrliste pflegen. Nummern auf die Sperrliste für ausgehende Anrufe setzen und entfernen.Fehler: Jede Antwort, die kein Erfolg ist, hat die Form { "error": { "code", "message", "details" } }. Der code ist fest und für Programme gedacht.
Grenzen: POST /v1/calls hat einen eigenen Zähler mit 30 Anfragen je Minute und Schlüssel. Alle übrigen Routen teilen sich zusammen 120 Anfragen je Minute und Schlüssel; Anfragen an POST /v1/calls zählen dort nicht mit. Jede Antwort trägt x-ratelimit-limit (erlaubte Anfragen im Zeitfenster), x-ratelimit-remaining (davon noch übrig) und x-ratelimit-reset (Sekunden, bis das Zeitfenster neu beginnt). Ist die Grenze erreicht, antwortet die API mit 429 und dem Code rate_limited, dazu retry-after (Sekunden bis zur nächsten möglichen Anfrage).
Zeiten: ISO 8601 in UTC, zum Beispiel 2026-11-16T09:00:00.000Z.
Blättern: Listen liefern next_cursor. Senden Sie ihn als cursor, um die nächste Seite zu lesen. null heißt, es gibt keine weitere Seite.
Webhooks: Am Assistenten lässt sich ein Webhook hinterlegen. Er meldet call.ended, outbound_call.finished und outbound_campaign.finished. Die Objekte in outbound_call.finished und outbound_campaign.finished sind dieselben wie Call und Campaign in dieser API.
API-Schlüssel der Organisation, beginnt mit spk_live_.
Security scheme type: http