Voice API Webhooks-Referenz

Vonage verwendet neben seiner Voice API auch Webhooks, damit Ihre Anwendung mit dem Anruf interagieren kann. Es gibt zwei erforderliche und einen optionalen Webhook-Endpunkt:

  • Antwort Webhook wird gesendet, wenn ein Anruf angenommen wird. Dies gilt sowohl für eingehende als auch für ausgehende Anrufe.
  • Ereignis-Webhook wird für alle Ereignisse gesendet, die während eines Anrufs auftreten. Ihre Anwendung kann jeden Ereignistyp protokollieren, darauf reagieren oder ignorieren.
  • Fallback-URL wird verwendet, wenn entweder der Webhook Antwort oder Ereignis fehlschlägt oder einen HTTP-Fehlerstatus zurückgibt.
  • Fehler werden auch an den Ereignis-Webhook-Endpunkt übermittelt, wenn sie auftreten.

Weitere allgemeine Informationen finden Sie in unserem Webhooks-Leitfaden.

Signierte Webhooks

Signierte Webhooks sind eine Möglichkeit, um zu verifizieren, dass die Anfrage von Vonage stammt und die Nutzdaten während der Übertragung nicht manipuliert wurden. Voice API, sowie die Nachrichten und Versenden APIs, unterstützen standardmäßig signierte Rückrufe. Siehe Dekodierung signierter Webhooks um zu erfahren, wie man eine eingehende JWT-Signatur entschlüsselt.

Antwort Webhook

Wenn ein eingehender Anruf angenommen wird, wird eine HTTP-Anfrage an die answer_url die Sie beim Einrichten der Anwendung angegeben haben. Für ausgehende Anrufe geben Sie den answer_url wenn Sie den Anruf tätigen.

Standardmäßig ist der Antwort-Webhook ein GET Anfrage, aber dies kann überschrieben werden in POST durch Einstellung der answer_method Feld. Für eingehende Anrufe konfigurieren Sie diese Werte beim Erstellen der Anwendung. Für ausgehende Anrufe geben Sie diese Werte beim Tätigen eines Anrufs an.

Webhook-Datenfelder beantworten

Feld Beispiel Beschreibung
to 442079460000 Die Nummer, die den Anruf entgegengenommen hat. (Dies ist die virtuelle Nummer, die in Ihrem Applikation.)
from 447700900000 Die Nummer, die anrief to. Dabei kann es sich um eine Festnetz- oder Handynummer handeln oder um eine andere virtuelle Nummer, wenn der Anruf programmgesteuert erfolgt ist.
from_user JaneDoe Der Benutzername, der die to nur, wenn der Anruf über das Client SDK getätigt wurde. In diesem Fall, from abwesend sein wird (d. h., from und from_user nie beide gleichzeitig vorhanden sein werden).
endpoint_type phone Der Sprachkanaltyp, der den Anruf beantwortet hat. Mögliche Werte sind phone, sip, websocket, app, vbc.
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Eine eindeutige Kennung für diesen Aufruf
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Ein eindeutiger Bezeichner für dieses Gespräch
region_url https://api-ap-3.vonage.com Regionaler API-Endpunkt, der zur Steuerung des Aufrufs verwendet werden soll REST-API; siehe die vollständige Liste der Regionen hier
custom_data { "key": "value" } Ein benutzerdefiniertes Datenobjekt, das optional als Parameter an die serverCall Methode, wenn ein Anruf von einer Anwendung mit der Client SDK

Übermittlung zusätzlicher Daten mit SIP-Headern

Zusätzlich zu den oben genannten Feldern können Sie alle zusätzlichen Header angeben, die Sie bei der Verwendung von SIP Connect benötigen. Alle angegebenen Header müssen beginnen mit X- und wird an Ihr answer_url mit einem Präfix von SipHeader_. Wenn Sie zum Beispiel eine Überschrift von X-UserId mit einem Wert von 1938ND9Vonage wird hinzufügen SipHeader_X-UserId=1938ND9 auf die Anfrage an Ihr answer_url.

Warnung: Kopfzeilen, die mit X-Nexmo werden nicht an Ihre answer_url

Beispiele für Webhook-Datenfelder beantworten

Für eine GET Anfrage sind die Variablen in der URL enthalten, etwa so:

/answer.php?to=442079460000&from=447700900000&conversation_uuid=CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab&uuid=aaaaaaaa-bbbb-cccc-dddd-0123456789ab&SipHeader_X-UserId=1938ND9

Wenn Sie die Einstellung answer_method zu POST dann erhalten Sie die Anfrage mit Daten im JSON-Format im Body:

{
  "from": "442079460000",
  "to": "447700900000",
  "uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "conversation_uuid": "CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "SipHeader_X-UserId": "1938ND9"
}

Antwort auf den Antwort-Webhook

Vonage erwartet von Ihnen die Rücksendung einer NCCO im JSON-Format, die die auszuführenden Aktionen enthält.

Ereignis-Webhook

Ereignis-Webhook-HTTP-Anfragen treffen am Ereignis-Webhook-Endpunkt ein, wenn sich der Status eines Anrufs ändert. Die URL ist die event_url die Sie bei der Erstellung Ihrer Anwendung angegeben haben, es sei denn, Sie überschreiben sie, indem Sie eine bestimmte event_url wenn Sie einen Anruf starten.

Standardmäßig werden die eingehenden Anfragen POST Anfragen mit einem JSON-Körper. Sie können die Methode überschreiben, um GET durch Konfigurieren der event_method zusätzlich zu den event_url. Es wird erwartet, dass Ihr System auf die HTTP-Anfrage antwortet. Wenn Ihr System das Ereignis nicht bestätigt oder stattdessen mit einer 429, 502, 503 oder 504 antwortet, wird ein erneuter Versuch unternommen. Für Ereignisse, die die Rückgabe eines NCCO erfordern, wird dann die Fallback-URL verwendet. Beziehen Sie sich auf die Fallback-URL Abschnitt für weitere Einzelheiten.

Das Format der enthaltenen Daten hängt davon ab, welches Ereignis eingetreten ist:

Gestartet

Zeigt an, dass die Aufforderung erstellt wurde.

Feld Beispiel Beschreibung
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
status started Anrufstatus
direction outbound Rufrichtung, kann entweder sein inbound oder outbound
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)

Zurück zur Liste der Ereignis-Webhooks

Klingeln

Das Anrufziel läutet.

Feld Beispiel Beschreibung
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
status ringing Anrufstatus
direction outbound Rufrichtung, kann entweder sein inbound oder outbound
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)

Zurück zur Liste der Ereignis-Webhooks

Antwortet

Der Anruf wurde beantwortet.

Feld Beispiel Beschreibung
start_time null Dieses Feld wird derzeit nicht unterstützt.
rate 0.12 Kosten des Anrufs in Euro
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
status answered Anrufstatus
direction inbound Rufrichtung, kann entweder sein inbound oder outbound
network null Art des Netzes, das für den Anruf verwendet wurde
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)

Zurück zur Liste der Ereignis-Webhooks

Beschäftigt

Das Ziel ist mit einem anderen Anrufer in der Leitung.

Feld Beispiel Beschreibung
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
status busy Anrufstatus
direction outbound Richtung des Anrufs, dies wird sein outbound in diesem Zusammenhang
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)
sip_code 404 Der zurückgegebene SIP-Statuscode (z. B., 404, 480, oder 487) über die registrierte event_urlmit zusätzlichen Informationen über den Grund für den Abschluss oder das Scheitern des Anrufs. Siehe SIP-Statuscodes, beschrieben hier.

Zurück zur Liste der Ereignis-Webhooks

Abgebrochen

Ein ausgehender Anruf wird vom Absender abgestellt, bevor er beantwortet wird.

Feld Beispiel Beschreibung
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
status cancelled Anrufstatus
direction outbound Richtung des Anrufs, dies wird sein outbound in diesem Zusammenhang
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)

Zurück zur Liste der Ereignis-Webhooks

Unbeantwortet

Entweder ist der Empfänger nicht erreichbar oder der Empfänger hat den Anruf abgelehnt.

Feld Beispiel Beschreibung
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
status unanswered Anrufstatus
detail unavailable Gibt an, ob der Teilnehmer vorübergehend nicht erreichbar ist (unavailable) oder der Beförderer konnte innerhalb einer angemessenen Zeit keine Antwort geben (timeout)
direction outbound Richtung des Anrufs, dies wird sein outbound in diesem Zusammenhang
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)
sip_code 404 Der zurückgegebene SIP-Statuscode (z. B., 404, 480, oder 487) über die registrierte event_urlmit zusätzlichen Informationen über den Grund für den Abschluss oder das Scheitern des Anrufs. Siehe SIP-Statuscodes, beschrieben hier.

Zurück zur Liste der Ereignis-Webhooks

Getrennt

Wenn die WebSocket-Verbindung von der Anwendungsseite aus irgendeinem Grund beendet wird, wird der Disconnected-Event-Callback gesendet. Wenn die Antwort einen NCCO enthält, wird dieser verarbeitet, wenn kein NCCO vorhanden ist, wird die normale Ausführung fortgesetzt.

Feld Beispiel Beschreibung
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
status disconnected Anrufstatus
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)

Zurück zur Liste der Ereignis-Webhooks

Abgelehnt

Der Anruf wurde von Vonage abgewiesen, bevor er verbunden wurde.

Feld Beispiel Beschreibung
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
status rejected Anrufstatus
detail restricted Zeigt an, ob to oder from Numbers sind ungültig (invalid_number), der vom Betreiber abgewiesene Anruf (restricted) oder vom Angerufenen abgelehnt (declined)
direction outbound Richtung des Anrufs, dies wird sein outbound in diesem Zusammenhang
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)
sip_code 404 Der zurückgegebene SIP-Statuscode (z. B., 404, 480, oder 487) über die registrierte event_urlmit zusätzlichen Informationen über den Grund für den Abschluss oder das Scheitern des Anrufs. Siehe SIP-Statuscodes, beschrieben hier.

Zurück zur Liste der Ereignis-Webhooks

Gescheitert

Der ausgehende Anruf konnte nicht verbunden werden.

Feld Beispiel Beschreibung
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
status failed Anrufstatus
detail cannot_route Zeigt an, dass das Ziel nicht unterstützt wird oder für den Account gesperrt ist (cannot_route), ist die Nummer nicht verfügbar (number_out_of_service) oder ein Serverfehler aufgetreten ist (internal_error)
direction outbound Richtung des Anrufs, dies wird sein outbound in diesem Zusammenhang
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)
sip_code 404 Der zurückgegebene SIP-Statuscode (z. B., 404, 480, oder 487) über die registrierte event_urlmit zusätzlichen Informationen über den Grund für den Abschluss oder das Scheitern des Anrufs. Siehe SIP-Statuscodes, beschrieben hier.

Zurück zur Liste der Ereignis-Webhooks

Mensch/Maschine

Bei einem programmgesteuerten ausgehenden Anruf, wenn die machine_detection gesetzt ist, wird ein Ereignis mit einem Status von human oder machine wird gesendet, je nachdem, ob eine Person den Anruf entgegengenommen hat oder nicht.

Feld Beispiel Beschreibung
call_uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf (Hinweis call_uuid, nicht uuid wie in einigen anderen Endpunkten)
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
status human Anrufstatus, kann entweder sein human wenn eine Person antwortet oder machine wenn der Anruf von der Mailbox oder einem anderen automatischen Dienst entgegengenommen wurde
sub_state beep_start Erweiterter Geräteerkennungsstatus, wenn der Anruf von einem Voicemail- oder Faxgerät entgegengenommen wird und der Signalton erkannt wird. Mögliche Werte sind beep_start für Voicemail, fax für Faxgerät und beep_timeout.
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)

Zurück zur Liste der Ereignis-Webhooks

Zeitüberschreitung

Überschreitet die Dauer der Klingelphase die angegebene ringing_timeout Dauer, wird dieses Ereignis gesendet.

Feld Beispiel Beschreibung
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
status timeout Anrufstatus
direction outbound Richtung des Anrufs, dies wird sein outbound in diesem Zusammenhang
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)

Zurück zur Liste der Ereignis-Webhooks

Abgeschlossen

Das Gespräch ist beendet, dieses Ereignis enthält auch zusammenfassende Daten über das Gespräch.

Feld Beispiel Beschreibung
end_time 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
network GB-FIXED Die Art des Netzes, das für den Anruf verwendet wurde
duration 2 Gesprächsdauer (in Sekunden)
start_time 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)
rate 0.00450000 Kosten pro Minute des Anrufs (EUR)
price 0.00015000 Gesamtkosten der Aufforderung (EUR)
from 442079460000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
status completed Anrufstatus
direction Eingehend Rufrichtung, kann entweder sein inbound oder outbound
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)
disconnected_by user Kann einer von zwei Werten sein:
platform - Der Anruf wurde von der Voice API-Plattform beendet, z. B. hat das NCCO seine letzte Aktion beendet und die Verbindung wurde unterbrochen.
user - Der Anruf wurde vom Benutzer beendet, z. B. durch Auflegen, Abweisen des Anrufs oder Nichtmelden.
sip_code 404 Der zurückgegebene SIP-Statuscode (z. B., 404, 480, oder 487) über die registrierte event_urlmit zusätzlichen Informationen über den Grund für den Abschluss oder das Scheitern des Anrufs. Siehe SIP-Statuscodes, beschrieben hier.

Zurück zur Liste der Ereignis-Webhooks

Datensatz

Dieser Webhook kommt an, wenn ein NCCO mit einer "Record"-Aktion beendet ist. Wenn Sie eine Record-Aktion erstellen, können Sie eine andere eventUrl an die dieses Ereignis gesendet werden soll. Dies kann nützlich sein, wenn Sie für diesen Ereignistyp einen eigenen Code verwenden möchten.

Feld Beispiel Beschreibung
start_time 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)
recording_url https://api.nexmo.com/v1/files/bbbbbbbb-aaaa-cccc-dddd-0123456789ab Wo Sie die Aufzeichnung herunterladen können
size 12222 Die Größe der Aufzeichnungsdatei (in Bytes)
recording_uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Ein eindeutiger Bezeichner für diese Aufzeichnung
end_time 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)

Transkription

Feld Beispiel Beschreibung
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
type record Die NCCO-Aktion des Typs record
recording_uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Ein eindeutiger Bezeichner für diese Aufzeichnung
status transcribed Status der Transkription
transcription_url https://api.nexmo.com/v1/files/bbbbbbbb-aaaa-cccc-dddd-0123456789ab Die URL der Datei, die die Transkription der Aufnahme enthält

Zurück zur Liste der Ereignis-Webhooks

Eingabe

Dieser Webhook wird von Vonage gesendet, wenn ein NCCO mit der Aktion "Eingabe" beendet wurde.

Feld Beispiel Beschreibung
from 447700900000 Die Nummer, von der der Anruf kam
to 447700900000 Die Nummer, unter der der Anruf getätigt wurde
dtmf siehe unten DTMF-Erfassungsergebnisse
speech siehe unten Ergebnisse der Spracherkennung
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Anruf. Die Eigenschaft wird möglicherweise nicht angezeigt, wenn eine Eingabe eine DTMF-Zeitüberschreitung erreicht.
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)

DTMF-Erfassungsergebnisse

Feld Beispiel Beschreibung
digits 42 Die vom Benutzer gedrückten Tasten
timed_out true Ob die DTMF-Eingabe eine Zeitüberschreitung aufweist: true wenn es so wäre, false wenn nicht

Spracherkennungsergebnisse

Feld Beispiel Beschreibung
timeout_reason end_on_silence_timeout Zeigt an, ob die Eingabe beendet wurde, als der Benutzer aufhörte zu sprechen (end_on_silence_timeout), nach maximaler Dauer des Timeouts (max_duration) oder wenn der Nutzer nichts gesagt hat (start_timeout)
results siehe unten Array von erkannte Textobjekte
error ERR1: Failed to analyze audio Fehlermeldung.
recording_url https://api-us.nexmo.com/v1/files/eeeeeee-ffff-0123-4567-0123456789ab Sprachaufzeichnung. Enthalten, wenn saveAudio Flagge ist gesetzt auf true im input Aktion. Erfordert JWT-Autorisierung für das Herunterladen, siehe Eine Aufnahme herunterladen.
Text der Abschrift
Feld Beispiel Beschreibung
text sales Transkriptionstext, der die vom Benutzer gesprochenen Worte wiedergibt.
confidence 0.9405097 Die Konfidenzschätzung liegt zwischen 0,0 und 1,0. Eine höhere Zahl bedeutet, dass die Wahrscheinlichkeit, dass die erkannten Wörter richtig sind, höher eingeschätzt wird.

Siehe auch die vollständige Beispiel-Nutzlast in NCCO-Referenz

Zurück zur Liste der Ereignis-Webhooks

Übertragung

Dieser Webhook wird von Vonage gesendet, wenn ein Leg von einem Gespräch in ein anderes übertragen wurde. Dies kann mit einem NCCO oder dem transfer Aktion

Feld Beispiel Beschreibung
conversation_uuid_from CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Die Konversations-ID, in der sich das Bein ursprünglich befand
conversation_uuid_to CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Die Gesprächs-ID, die das Bein übertragen wurde
uuid aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für diesen Aufruf
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)

Zurück zur Liste der Ereignis-Webhooks

Fallback-URL

Auf den Fallback-Webhook wird zugegriffen, wenn entweder der Antwort-Webhook oder der Ereignis-Webhook, wenn das Ereignis mit einem NCCO antworten soll, einen HTTP-Fehlerstatus zurückgibt oder unerreichbar ist. Die Daten, die von der Fallback-URL zurückgegeben werden, sind die gleichen wie die, die in der ursprünglichen Antwort-URL oder Ereignis-URL empfangen werden, mit dem Zusatz von zwei neuen Parametern, reason und original_request:

{
  "reason": "Connection closed.",
  "original_request": {
    "url": "https://api.example.com/webhooks/event",
    "type": "event"
  }
}

Wenn eine Verbindung geschlossen oder zurückgesetzt wurde, eine Zeitüberschreitung oder ein HTTP-Statuscode von 429, 503 oder 504 während der anfänglichen NCCO die answer_url zweimal versucht wird, dann:

  1. Versuchen Sie, die fallback_answer_url zweimal
  2. Wenn kein Erfolg, dann wird der Aufruf beendet

Wenn eine Verbindung geschlossen oder zurückgesetzt wurde, eine Zeitüberschreitung oder ein HTTP-Statuscode von 429, 503 oder 504 während eines laufenden Gesprächs die event_url für Ereignisse, von denen erwartet wird, dass sie einen NCCO zurückgeben (z. B. Rückkehr für ein input oder notify Aktion) zweimal versucht wird, dann:

  1. Versuchen Sie, die fallback_answer_url zweimal
  2. Wenn kein Erfolg, setzen Sie den Anrufablauf fort

Fehler

Der Ereignis-Endpunkt empfängt auch Webhooks im Falle eines Fehlers. Dies kann bei der Fehlersuche in Ihrer Anwendung nützlich sein.

Feld Beispiel Beschreibung
reason Syntax error in NCCO. Invalid value type or action. Informationen über die Art des Fehlers
conversation_uuid CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab Der eindeutige Bezeichner für dieses Gespräch
timestamp 2020-01-01T12:00:00.000Z Zeitstempel (ISO 8601-Format)