Skip to main content
POST
Kampagne erstellen
Erstellt eine neue Kampagne. Kampagnen starten im Status draft — Leads hinzufügen, dann mit Kampagnen-Status aktualisieren starten. Unterstützte Channels:
  • call (Standard) — Outbound-Voice mit einem OUTBOUND-Assistenten
  • whatsapp — freigegebenes WhatsApp-Template über einen deiner Sender
  • sms — SMS-Text von einer SMS-fähigen Nummer (kann auf der Plattform vorübergehend nicht verfügbar sein)

Request Body

Gemeinsam

string
erforderlich
Kampagnenname. Maximal 255 Zeichen.
string
Standard:"call"
call, whatsapp oder sms.
string
IANA-Zeitzone für das Sende-/Anrufzeitfenster (z. B. America/New_York). Standard: Assistenten-Zeitzone bei Anrufkampagnen, sonst Konten-Zeitzone.
array
Bevorzugter Schedule: ein oder mehrere tägliche Fenster als Objekte mit start und end in HH:MM. Übernacht-Fenster sind erlaubt, wenn end vor start liegt (z. B. 16:0002:00).
string
Standard:"00:00"
Legacy-Einzelfenster-Start (HH:MM). Wird verwendet, wenn schedule_windows fehlt.
string
Standard:"23:59"
Legacy-Einzelfenster-Ende (HH:MM). Übernacht, wenn end < start.
string
Optionale ISO-Datetime. Wenn gesetzt, kann die Kampagne zu diesem Zeitpunkt automatisch starten.
array
Standard:"alle 7 Tage"
Wochentage: mondaysunday.
integer
Standard:"3"
Max. Retry-Versuche pro Lead. Bereich: 1–5.
integer
Standard:"60"
Minuten zwischen Retries. Bereich: 10–4320.
boolean
Standard:"true"
Kampagne automatisch als abgeschlossen markieren, wenn keine Arbeit mehr übrig ist.

Anrufkampagnen

integer
Pflicht bei channel=call. Muss ein OUTBOUND-Assistent sein, der dir gehört.
integer
Standard:"3"
Parallele Anrufe (tarifbegrenzt, max. 10).
array
Outbound-Absender-Nummern-IDs, die deinem Konto zur Verfügung stehen.
boolean
Retry, wenn der Anruf beim Anrufbeantworter landet.
boolean
Weiter retryen, bis eine Boolean-Post-Call-Goal-Variable true ist.
string
Name der Boolean-Post-Call-Schema-Variable für retry_on_goal_incomplete.
string
Optionaler Call→Text-Follow-up nach max. Anruf-Retries: whatsapp oder sms.
integer
Pflicht bei fallback_channel=whatsapp.
integer
Pflicht bei fallback_channel=whatsapp. Muss ein freigegebenes Template auf diesem Sender sein.
integer
Pflicht bei fallback_channel=sms.
string
Pflicht bei fallback_channel=sms. Unterstützt {{variable}}-Platzhalter.
object
Mappt WhatsApp-Template-Platzhalter (z. B. "1") auf Lead-Variablen-Keys für den Fallback-Send.

WhatsApp-Kampagnen

integer
Pflicht bei channel=whatsapp. Sender, der dir gehört.
integer
Pflicht bei channel=whatsapp. Freigegebenes Template auf diesem Sender.
object
Mappt Template-Platzhalter (z. B. "1") auf Lead-Variablen-Keys.
integer
Sende-Rate pro Kampagne (1–10). WhatsApp-Kampagnen teilen sich zusätzlich einen nutzerweiten Pool von 10 In-Flight-Sends über alle aktiven WhatsApp-Kampagnen.

SMS-Kampagnen

integer
Pflicht bei channel=sms. Muss SMS-fähig und für dich verfügbar sein.
string
Pflicht bei channel=sms. Max. 1600 Zeichen. Unterstützt {{variable}}-Platzhalter.

Response

string
Erfolgsmeldung
object
Erstellte Kampagne (gleiche Form wie Kampagne abrufen), inklusive Channel, Schedule, Text-Config und Fallback-Feldern.

Fehlerantworten

Tarif-Limit, ungültiger Assistent/Sender/Template, deaktivierter Channel oder Validierungsfehler.