Kampagne starten
const url = 'https://api.speakki.de/v1/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/start';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.speakki.de/v1/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/start \ --header 'Authorization: Bearer <token>'Startet einen Entwurf: sofort oder zum geplanten Zeitpunkt (start_at). Die Einwilligung der Empfänger haben Sie beim Anlegen bestätigt.
Berechtigung: campaigns:write.
Authorizations
Abschnitt betitelt „Authorizations“Parameters
Abschnitt betitelt „Parameters“Path Parameters
Abschnitt betitelt „Path Parameters“ID der Kampagne.
Responses
Abschnitt betitelt „Responses“Die Kampagne.
Eine Kampagne: eine feste Empfängerliste, die der Assistent nacheinander anruft.
object
ID der Kampagne.
Name der Kampagne.
draft Entwurf, scheduled Start geplant, running läuft, paused pausiert, completed alle Empfänger erledigt, canceled abgebrochen.
Absender in E.164.
Namen der Variablen, die die Empfänger mitbringen.
Platzhalter des Assistenten, für die die Empfänger keinen Wert haben. Solche Empfänger werden übersprungen.
Anrufzeiten der Kampagne. Nur innerhalb von Montag bis Samstag, 8 bis 20 Uhr, und innerhalb der Anrufzeiten der Organisation.
object
Wochentage, 1 = Montag bis 6 = Samstag.
Beginn in deutscher Zeit, frühestens 08:00.
Ende in deutscher Zeit, spätestens 20:00.
Pause zwischen zwei Empfängern in Sekunden.
Versuche je Empfänger.
Abstand zwischen zwei Versuchen in Minuten.
Herkunft der Kontakte, wie beim Anlegen angegeben.
Angelegt am.
Empfänger nach Stand.
object
Alle Empfänger der Kampagne.
Noch nicht angerufen.
Anruf läuft oder wartet auf den nächsten Versuch.
Gespräch geführt.
Anruf beendet ohne Gespräch.
Nie angerufen (Sperrliste, gesperrter Kontakt, ungültig oder Kampagne abgebrochen).
Example
{ "id": "3f8a2b1c-9d4e-4a6f-8b2c-1e5d7f9a0b3c", "name": "Terminerinnerung November", "status": "running", "assistant_id": "5e2a9c1b-7f43-4c1d-8b0a-3d9e6f2a1c44", "from_number_id": null, "from_number": "+493023125010", "contact_list_id": null, "variables": [ "name", "termin" ], "missing_variables": [], "start_at": null, "call_window": { "days": [ 1, 2, 3, 4, 5 ], "from": "09:00", "to": "17:00" }, "pause_seconds": 30, "max_attempts": 2, "retry_delay_minutes": 120, "contact_source": "Bestandskunden mit Einwilligung aus dem Kundenportal", "consent_confirmed_at": "2026-11-16T08:55:00.000Z", "next_dispatch_at": "2026-11-16T09:03:00.000Z", "started_at": "2026-11-16T08:55:00.000Z", "completed_at": null, "created_at": "2026-11-16T08:50:00.000Z", "counts": { "total": 120, "pending": 97, "queued": 1, "reached": 15, "not_reached": 5, "skipped": 2 }}Ungültige Anfrage.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "invalid_request", "message": "Die Anfrage ist ungültig." }}API-Schlüssel fehlt oder ist ungültig.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "unauthorized", "message": "Der API-Schlüssel fehlt oder ist ungültig. Senden Sie ihn als „Authorization: Bearer spk_live_…“." }}Nicht erlaubt: Tarif, Freischaltung oder Berechtigung des Schlüssels.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "insufficient_scope", "message": "Diesem API-Schlüssel fehlt die Berechtigung für diese Anfrage." }}{ "error": { "code": "plan_required", "message": "Ausgehende Anrufe sind ab dem Tarif Professional enthalten." }}{ "error": { "code": "access_not_approved", "message": "Ausgehende Anrufe sind für diese Organisation noch nicht freigeschaltet." }}Nicht gefunden.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "not_found", "message": "Nicht gefunden." }}Passt nicht zum aktuellen Zustand.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "conflict", "message": "Die Anfrage passt nicht zum aktuellen Zustand." }}Zu viele Anfragen. retry-after und x-ratelimit-reset nennen die Sekunden, bis wieder Anfragen möglich sind.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "rate_limited", "message": "Zu viele Anfragen. Bitte versuchen Sie es gleich noch einmal." }}Interner Fehler.
Einheitliches Fehlerformat aller Antworten unter /v1.
object
Der Fehler.
object
Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.
Meldung für Menschen, auf Deutsch.
Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.
object
Examples
{ "error": { "code": "internal_error", "message": "Interner Fehler. Bitte versuchen Sie es später noch einmal." }}