Zum Inhalt springen
Hilfe-Center
Support kontaktierenApp öffnen

Kampagne abgeschlossen

POST

Genau einmal je Kampagne, sobald sie abgeschlossen (completed) oder abgebrochen (canceled) ist, mit den Zählern der Empfänger.

Speakki sendet das Ereignis als POST mit JSON an die URL, die am Assistenten hinterlegt ist. Nur für veröffentlichte Assistenten mit eingeschaltetem Webhook. Antwortet Ihr Server nicht mit 2xx, wird die Zustellung mit wachsendem Abstand wiederholt. Prüfen Sie die Signatur im Header Speakki-Signature (HMAC-SHA256 mit dem Secret des Webhooks über <t>.<roher Body>), und nutzen Sie Speakki-Delivery-Id, um doppelte Zustellungen zu erkennen.

Speakki-Event
required
string

Name des Ereignisses.

Speakki-Delivery-Id
required
string format: uuid

ID der Zustellung. Bleibt bei Wiederholungen gleich und eignet sich zum Erkennen doppelter Zustellungen.

Speakki-Signature
required
string

t=<Unix-Zeit>,v1=<Hex>: HMAC-SHA256 mit dem Secret des Webhooks über <t>.<roher Body>.

Media typeapplication/json

Webhook-Ereignis, sobald eine Kampagne abgeschlossen (completed) oder abgebrochen (canceled) ist. Genau einmal je Kampagne.

object
event
required

Name des Ereignisses.

string
Allowed value: outbound_campaign.finished
created_at
required

Zeitpunkt des Abschlusses.

string format: date-time
data
required

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

Jede Antwort mit Status 2xx gilt als zugestellt. Der Inhalt der Antwort wird nicht gelesen.