Zum Inhalt springen
Hilfe-Center
Support kontaktierenApp öffnen

Ausgehender Anruf abgeschlossen

POST

Genau einmal je ausgehendem Anruf, sobald er abgeschlossen ist: completed, not_reached, blocked oder canceled. Kommt auch ohne Gespräch. Zwischen zwei Versuchen feuert es nicht.

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 ein ausgehender Anruf abgeschlossen ist (completed, not_reached, blocked oder canceled). Genau einmal je Anruf.

object
event
required

Name des Ereignisses.

string
Allowed value: outbound_call.finished
created_at
required

Zeitpunkt des Abschlusses.

string format: date-time
data
required

Ein ausgehender Anruf (Auftrag) mit seinen Versuchen.

object
id
required

ID des Anrufs.

string format: uuid
status
required

queued wartet (auch zwischen zwei Versuchen), dialing klingelt, in_progress Gespräch läuft, completed Gespräch geführt, not_reached alle Versuche ohne Gespräch, canceled abgebrochen, blocked vor dem Wählen abgelehnt.

string
Allowed values: queued dialing in_progress completed not_reached canceled blocked
block_reason
required
Any of:
string
Allowed values: 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
to
required

Zielnummer in E.164.

string
from
required

Absendernummer in E.164.

string
assistant_id
required
Any of:
string format: uuid
campaign_id
required
Any of:
string format: uuid
variables
required

Werte für die Platzhalter in Begrüßung und Auftrag.

object
key
additional properties
string
metadata
required

Ihre freien Daten, unverändert zurückgegeben.

object
key
additional properties
scheduled_at
required
Any of:
string format: date-time
next_attempt_at
required
Any of:
string format: date-time
max_attempts
required

Versuche insgesamt, die für diesen Anruf erlaubt sind.

integer
attempt_count
required

Bisherige Wählversuche.

integer
last_result
required
Any of:
string
Allowed values: answered no_answer busy voicemail failed
created_at
required

Auftrag angelegt am.

string format: date-time
finished_at
required
Any of:
string format: date-time
attempts
required

Alle Wählversuche in ihrer Reihenfolge.

Array<object>

Ein Wählversuch.

object
number
required

Nummer des Versuchs, beginnend bei 1.

integer
result
required
Any of:
string
Allowed values: answered no_answer busy voicemail failed
started_at
required

Beginn des Wählens.

string format: date-time
ended_at
required
Any of:
string format: date-time
duration_seconds
required
Any of:
integer

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