Gespräch beendet
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.
Parameters
Abschnitt betitelt „Parameters“Header Parameters
Abschnitt betitelt „Header Parameters“Name des Ereignisses.
ID der Zustellung. Bleibt bei Wiederholungen gleich und eignet sich zum Erkennen doppelter Zustellungen.
t=<Unix-Zeit>,v1=<Hex>: HMAC-SHA256 mit dem Secret des Webhooks über <t>.<roher Body>.
Request Bodyrequired
Abschnitt betitelt „Request Bodyrequired“Webhook-Ereignis nach jedem geführten Gespräch (eingehend und ausgehend). Feldnamen in camelCase, anders als bei den übrigen Objekten dieser API.
object
Version der Payload.
Name des Ereignisses.
ID der Zustellung, bleibt über Wiederholungen gleich (auch im Header Speakki-Delivery-Id).
Zeitpunkt der Zustellung.
true beim Testereignis aus dem Dashboard, sonst false.
Die Organisation.
object
ID der Organisation.
Name der Organisation.
Das Gespräch.
object
ID des Gesprächs, dieselbe wie id in GET /v1/conversations/{id}.
Interne ID des Telefonats.
INBOUND eingehend, OUTBOUND ausgehend.
Beginn des Gesprächs.
Name des Gesprächspartners, falls bekannt.
Nummer des Gesprächspartners in E.164.
Bearbeitungsstand im Posteingang: OPEN, IN_PROGRESS, DONE oder ARCHIVED.
Zusammenfassung des Gesprächs.
Link zum Gespräch im Dashboard.
Ergebnisse des Gesprächs, zum Beispiel ein gebuchter Termin.
object
Fester Schlüssel des Ergebnisses.
Bezeichnung des Ergebnisses.
Fähigkeit des Assistenten, die das Ergebnis erzeugt hat.
Nur bei „Anliegen aufnehmen“: Schlüssel des Falls.
Nur bei „Anliegen aufnehmen“: Name des Falls.
Zeitpunkt des Ergebnisses.
Daten, die der Assistent im Gespräch erfasst hat.
object
Name der Erfassung im Assistenten.
Bezeichnung der Erfassung.
Nur bei „Anliegen aufnehmen“: Schlüssel des Falls.
Nur bei „Anliegen aufnehmen“: Name des Falls.
true, wenn der Anrufer vor den letzten Angaben aufgelegt hat.
Zeitpunkt der Erfassung.
Die erfassten Angaben.
object
Name des Felds.
Typ des Felds, zum Beispiel string.
Der erfasste Wert.
object
assistant der Assistent, user der Gesprächspartner.
Der gesprochene Text.
Zeitpunkt der Äußerung, falls bekannt.
Responses
Abschnitt betitelt „Responses“Jede Antwort mit Status 2xx gilt als zugestellt. Der Inhalt der Antwort wird nicht gelesen.