Zum Inhalt springen
Hilfe-Center
Support kontaktierenApp öffnen

Gespräch beendet

POST

Nach jedem geführten Gespräch eines veröffentlichten Assistenten, eingehend und ausgehend, mit Zusammenfassung, erfassten Daten und Transkript (soweit die Aufzeichnung aktiv war).

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 nach jedem geführten Gespräch (eingehend und ausgehend). Feldnamen in camelCase, anders als bei den übrigen Objekten dieser API.

object
version
required

Version der Payload.

number
Allowed value: 1
event
required

Name des Ereignisses.

string
Allowed value: call.ended
deliveryId
required

ID der Zustellung, bleibt über Wiederholungen gleich (auch im Header Speakki-Delivery-Id).

string
occurredAt
required

Zeitpunkt der Zustellung.

string format: date-time
test
required

true beim Testereignis aus dem Dashboard, sonst false.

boolean
organization
required

Die Organisation.

object
id
required

ID der Organisation.

string format: uuid
name
required

Name der Organisation.

string | null
agent
required

Der Assistent, der das Gespräch geführt hat.

object
id
required
Any of:
string format: uuid
name
required

Technischer Name des Assistenten.

string | null
call
required

Das Gespräch.

object
interactionId
required

ID des Gesprächs, dieselbe wie id in GET /v1/conversations/{id}.

string format: uuid
callId
required

Interne ID des Telefonats.

string format: uuid
direction
required

INBOUND eingehend, OUTBOUND ausgehend.

string
Allowed values: INBOUND OUTBOUND
outboundCallId
required
Any of:
string format: uuid
startedAt
required

Beginn des Gesprächs.

string format: date-time
endedAt
required
Any of:
string format: date-time
durationSec
required
Any of:
integer
callerName
required

Name des Gesprächspartners, falls bekannt.

string | null
callerPhone
required

Nummer des Gesprächspartners in E.164.

string | null
status
required

Bearbeitungsstand im Posteingang: OPEN, IN_PROGRESS, DONE oder ARCHIVED.

string
category
required
Any of:
object
slug
required

Fester Schlüssel der Einordnung.

string
label
required

Bezeichnung der Einordnung.

string
summary
required

Zusammenfassung des Gesprächs.

string | null
dashboardUrl
required

Link zum Gespräch im Dashboard.

string
contact
required
Any of:
object
id
required

ID des Kontakts.

string format: uuid
name
required

Name der Person.

string | null
company
required

Firma.

string | null
phone
required

Rufnummer in E.164.

string | null
email
required

E-Mail-Adresse.

string | null
outcomes
required

Ergebnisse des Gesprächs, zum Beispiel ein gebuchter Termin.

Array<object>
object
category
required

Fester Schlüssel des Ergebnisses.

string
label
required

Bezeichnung des Ergebnisses.

string
toolName
required

Fähigkeit des Assistenten, die das Ergebnis erzeugt hat.

string | null
caseKey
required

Nur bei „Anliegen aufnehmen“: Schlüssel des Falls.

string | null
caseName
required

Nur bei „Anliegen aufnehmen“: Name des Falls.

string | null
occurredAt
required

Zeitpunkt des Ergebnisses.

string format: date-time
capturedData
required

Daten, die der Assistent im Gespräch erfasst hat.

Array<object>
object
toolName
required

Name der Erfassung im Assistenten.

string
label
required

Bezeichnung der Erfassung.

string | null
caseKey
required

Nur bei „Anliegen aufnehmen“: Schlüssel des Falls.

string | null
caseName
required

Nur bei „Anliegen aufnehmen“: Name des Falls.

string | null
incomplete
required

true, wenn der Anrufer vor den letzten Angaben aufgelegt hat.

boolean
capturedAt
required

Zeitpunkt der Erfassung.

string
fields
required

Die erfassten Angaben.

Array<object>
object
name
required

Name des Felds.

string
type
required

Typ des Felds, zum Beispiel string.

string | null
value
required

Der erfasste Wert.

transcript
required
Any of:
Array<object>
object
role
required

assistant der Assistent, user der Gesprächspartner.

string
Allowed values: assistant user
content
required

Der gesprochene Text.

string
timestamp
required

Zeitpunkt der Äußerung, falls bekannt.

string | null

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