Zum Inhalt springen
Hilfe-Center
Support kontaktierenApp öffnen

Kampagne fortsetzen

POST
/v1/campaigns/{id}/resume
curl --request POST \
--url https://api.speakki.de/v1/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/resume \
--header 'Authorization: Bearer <token>'

Setzt eine pausierte Kampagne beim nächsten Empfänger fort.

Berechtigung: campaigns:write.

id
required
string format: uuid

ID der Kampagne.

Die Kampagne.

Media typeapplication/json

Eine Kampagne: eine feste Empfängerliste, die der Assistent nacheinander anruft.

object
id
required

ID der Kampagne.

string format: uuid
name
required

Name der Kampagne.

string
status
required

draft Entwurf, scheduled Start geplant, running läuft, paused pausiert, completed alle Empfänger erledigt, canceled abgebrochen.

string
Allowed values: draft scheduled running paused completed canceled
assistant_id
required
Any of:
string format: uuid
from_number_id
required
Any of:
string format: uuid
from_number
required

Absender in E.164.

string | null
contact_list_id
required
Any of:
string format: uuid
variables
required

Namen der Variablen, die die Empfänger mitbringen.

Array<string>
missing_variables
required

Platzhalter des Assistenten, für die die Empfänger keinen Wert haben. Solche Empfänger werden übersprungen.

Array<string>
start_at
required
Any of:
string format: date-time
call_window
required

Anrufzeiten der Kampagne. Nur innerhalb von Montag bis Samstag, 8 bis 20 Uhr, und innerhalb der Anrufzeiten der Organisation.

object
days
required

Wochentage, 1 = Montag bis 6 = Samstag.

Array<integer>
>= 1 items
from
required

Beginn in deutscher Zeit, frühestens 08:00.

string
/^([01]\d|2[0-3]):[0-5]\d$/
to
required

Ende in deutscher Zeit, spätestens 20:00.

string
/^([01]\d|2[0-3]):[0-5]\d$/
pause_seconds
required

Pause zwischen zwei Empfängern in Sekunden.

integer
max_attempts
required

Versuche je Empfänger.

integer
retry_delay_minutes
required

Abstand zwischen zwei Versuchen in Minuten.

integer
contact_source
required

Herkunft der Kontakte, wie beim Anlegen angegeben.

string
consent_confirmed_at
required
Any of:
string format: date-time
next_dispatch_at
required
Any of:
string format: date-time
started_at
required
Any of:
string format: date-time
completed_at
required
Any of:
string format: date-time
created_at
required

Angelegt am.

string format: date-time
counts
required

Empfänger nach Stand.

object
total
required

Alle Empfänger der Kampagne.

integer
pending
required

Noch nicht angerufen.

integer
queued
required

Anruf läuft oder wartet auf den nächsten Versuch.

integer
reached
required

Gespräch geführt.

integer
not_reached
required

Anruf beendet ohne Gespräch.

integer
skipped
required

Nie angerufen (Sperrliste, gesperrter Kontakt, ungültig oder Kampagne abgebrochen).

integer

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.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

Exampleinvalid_request
{
"error": {
"code": "invalid_request",
"message": "Die Anfrage ist ungültig."
}
}

API-Schlüssel fehlt oder ist ungültig.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

Exampleunauthorized
{
"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.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

{
"error": {
"code": "insufficient_scope",
"message": "Diesem API-Schlüssel fehlt die Berechtigung für diese Anfrage."
}
}

Nicht gefunden.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

Examplenot_found
{
"error": {
"code": "not_found",
"message": "Nicht gefunden."
}
}

Passt nicht zum aktuellen Zustand.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

Exampleconflict
{
"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.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

Examplerate_limited
{
"error": {
"code": "rate_limited",
"message": "Zu viele Anfragen. Bitte versuchen Sie es gleich noch einmal."
}
}

Interner Fehler.

Media typeapplication/json

Einheitliches Fehlerformat aller Antworten unter /v1.

object
error
required

Der Fehler.

object
code
required

Fester Code für Programme. Neue Codes können dazukommen, bestehende ändern sich nicht.

string
Allowed values: unauthorized insufficient_scope invalid_request not_found conflict rate_limited internal_error plan_required access_not_approved billing_blocked assistant_not_found assistant_outbound_disabled from_number_missing from_number_not_allowed invalid_number country_not_allowed special_number own_number suppressed contact_blocked outside_call_hours daily_limit_reached number_called_today missing_variables
message
required

Meldung für Menschen, auf Deutsch.

string
details

Zusatz je Code, z. B. fields bei invalid_request oder missing_variables bei missing_variables.

object
key
additional properties

Examples

Exampleinternal_error
{
"error": {
"code": "internal_error",
"message": "Interner Fehler. Bitte versuchen Sie es später noch einmal."
}
}