Zum Hauptinhalt springen
POST
/
api
/
user
/
campaigns
Kampagne erstellen
curl --request POST \
  --url https://app.famulor.de/api/user/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "assistant_id": 123,
  "timezone": "<string>",
  "max_calls_in_parallel": 123,
  "allowed_hours_start_time": "<string>",
  "allowed_hours_end_time": "<string>",
  "allowed_days": [
    {}
  ],
  "max_retries": 123,
  "retry_interval": 123,
  "retry_on_voicemail": true,
  "retry_on_goal_incomplete": true,
  "goal_completion_variable": "<string>",
  "mark_complete_when_no_leads": true,
  "phone_number_ids": [
    {}
  ]
}
'
{
  "message": "Campaign created successfully",
  "data": {
    "id": 1,
    "name": "Product Demo Campaign",
    "status": "draft",
    "max_calls_in_parallel": 3,
    "mark_complete_when_no_leads": true,
    "allowed_hours_start_time": "09:00:00",
    "allowed_hours_end_time": "17:00:00",
    "allowed_days": [
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday"
    ],
    "max_retries": 3,
    "retry_interval": 60,
    "created_at": "2026-02-23T10:00:00.000000Z",
    "updated_at": "2026-02-23T10:00:00.000000Z"
  }
}
Dieser Endpunkt ermöglicht es Ihnen, eine neue Outbound-Anrufkampagne mit der angegebenen Konfiguration zu erstellen.

​
Request Body

​
name
string
erforderlich
Der Name der Kampagne. Maximal 255 Zeichen.
​
assistant_id
integer
erforderlich
Die ID des Assistenten für die Kampagne. Muss ein Outbound-fähiger Assistent sein.
​
timezone
string
Zeitzonen-Kennung für die Kampagne (z. B. America/New_York, Europe/London). Standard: Zeitzone Ihres Kontos.
​
max_calls_in_parallel
integer
Standard:"3"
Maximale Anzahl gleichzeitiger Anrufe. Minimum: 1. Maximum abhängig vom Parallel-Anruf-Limit Ihres Tarifs (bis 10).
​
allowed_hours_start_time
string
Standard:"00:00"
Beginn des erlaubten Anrufzeitfensters im Format H:i (z. B. 09:00).
​
allowed_hours_end_time
string
Standard:"23:59"
Ende des erlaubten Anrufzeitfensters im Format H:i (z. B. 17:00).
​
allowed_days
array
Standard:"alle 7 Tage"
Array mit Wochentagen, an denen Anrufe erlaubt sind. Gültige Werte: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
​
max_retries
integer
Standard:"3"
Maximale Anzahl Wiederholungsversuche bei fehlgeschlagenen Anrufen. Bereich: 1–5.
​
retry_interval
integer
Standard:"60"
Abstand in Minuten zwischen Wiederholungsversuchen. Bereich: 10–4320 (bis zu 3 Tage).
​
retry_on_voicemail
boolean
Ob Anrufe, die beim Anrufbeantworter gelandet sind, erneut versucht werden sollen.
​
retry_on_goal_incomplete
boolean
Ob Anrufe wiederholt werden sollen, bei denen das Ziel nicht erreicht wurde.
​
goal_completion_variable
string
Name einer Boolean-Variable aus dem Post-Call-Schema Ihres Assistenten zur Erfassung der Zielerreichung. Maximal 255 Zeichen.
​
mark_complete_when_no_leads
boolean
Standard:"true"
Ob die Kampagne automatisch als abgeschlossen markiert werden soll, wenn keine Leads mehr zu verarbeiten sind.
​
phone_number_ids
array
Array mit Telefonnummer-IDs für die Kampagne. Jede ID muss eine eindeutige Ganzzahl sein.

​
Response

​
message
string
Erfolgsmeldung zur Bestätigung der Kampagnenerstellung
​
data
object
Die erstellten Kampagnendaten

​
Fehlerantworten

​
403 Forbidden
​
404 Not Found
​
422 Validation Error
{
  "message": "Campaign created successfully",
  "data": {
    "id": 1,
    "name": "Product Demo Campaign",
    "status": "draft",
    "max_calls_in_parallel": 3,
    "mark_complete_when_no_leads": true,
    "allowed_hours_start_time": "09:00:00",
    "allowed_hours_end_time": "17:00:00",
    "allowed_days": [
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday"
    ],
    "max_retries": 3,
    "retry_interval": 60,
    "created_at": "2026-02-23T10:00:00.000000Z",
    "updated_at": "2026-02-23T10:00:00.000000Z"
  }
}