Anrufbenachrichtigungen

Während eines Anrufs werden Informationen zu sechs verschiedenen Zeitpunkten an die angegebene URL gesendet – bei eingehenden, internen und ausgehenden Gesprächen: Erstellt, Klingelt, Angenommen, Warm transfer, Cold transfer und Aufgelegt. Benachrichtigungen werden bei verschiedenen wichtigen Ereignissen während eines Anrufs an die angegebene URL gesendet. Die Benachrichtigungen werden als POST-Request mit den Daten in einem JSON-Dokument verschickt. Im Folgenden erfährst Du, welche Informationen genau gesendet werden.

Erstellt

Ein created-Event wird ausgelöst, wenn ein eingehender Anruf initiiert wird.

• call_id: Eine eindeutige Zeichenkette zur Identifizierung des Anrufs.
• timestamp: Datum und Uhrzeit, wann der Webhook generiert wird, im ISO 8601-Format.
• status: Der Status des Anrufs. Bei diesem Benachrichtigungstyp ist es created.
• version: Ein Versionsattribut, das in Zukunft für die Migration zu einer anderen Webhook-Version verwendet werden kann. Aktuell ist es immer v2.
• direction: Ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Das created-Event wird nur bei eingehenden Anrufen gesendet.
• caller: Informationen über den Anrufer.
• number: Die Telefonnummer, die der Anrufer verwendet.
• name: Der Name des Anrufers.
• account_number: Diese Information wird beim created-Event nicht gesendet.
• user_numbers: Diese Information wird beim created-Event nicht gesendet.
• user_emails: Diese Information wird beim created-Event nicht gesendet.
• destination: Informationen darüber, wohin der Anruf geleitet wird.
• number: Die Telefonnummer, die der Anrufer gewählt hat.

Klingelt

Eine ringing-Benachrichtigung wird gesendet, wenn Telefone aufgrund eines eingehenden Anrufs zu klingeln beginnen.

Es ist möglich, dass mehrere ringing-Benachrichtigungen nacheinander gesendet werden, wenn neue Geräte zu klingeln beginnen.

• call_id: Eine eindeutige Zeichenkette zur Identifizierung des Anrufs.
• timestamp: Datum und Uhrzeit, wann der Webhook generiert wird, im ISO 8601-Format.
• status: Der Status des Anrufs. Bei diesem Benachrichtigungstyp ist es ringing.
• version: Ein Versionsattribut, das in Zukunft für die Migration zu einer anderen Webhook-Version verwendet werden kann. Aktuell ist es immer v2.
• direction: Ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Gespräche zwischen Kollegen werden als outbound markiert.
• caller: Informationen über den Anrufer.
• number: Die Telefonnummer, die der Anrufer verwendet.
• name: Der Name des Anrufers.
• account_number: Diese Information wird beim ringing-Event nicht gesendet.
• user_numbers: Diese Information wird beim ringing-Event nicht gesendet.
• user_emails: Diese Information wird beim ringing-Event nicht gesendet.
• destination: Informationen darüber, wohin der Anruf geleitet wird.
• number: Die Telefonnummer, die der Anrufer gewählt hat.
• targets: Die Telefone, die bei diesem Anruf klingeln. Telefone, die nicht erreichbar sind, werden nicht angezeigt.
• number: Die Nummer, die angerufen wird. Diese ist normalerweise identisch mit destination.number, kann sich aber ändern, wenn der Anruf weitergeleitet wird.
• name: Der Name der Person, die angerufen wird. Bei eingehenden Anrufen ist dies fast immer null.
• account_number: Die internen Nummern der User, die ihren VoIP Account als erreichbar eingerichtet haben (sofern verfügbar, kann ein leeres Array sein).
• user_numbers: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.

Angenommen (in Bearbeitung)

Eine in-progress-Benachrichtigung wird gesendet, wenn ein Anruf angenommen wird.

Hinweis! Das target, das den Anruf annimmt, ist nicht immer eines der Geräte, die ursprünglich geklingelt haben. Durch die Anrufübernahme kann es vorkommen, dass der Anruf auf einem anderen Gerät angenommen wird.

• call_id: Eine eindeutige Zeichenfolge zur Identifizierung des Anrufs.
• timestamp: Datum und Uhrzeit der Webhook-Generierung im ISO-8601-Format.
• status: Der Status des Anrufs. Für diesen Benachrichtigungstyp ist er in-progress.
• version: Ein Versions-Attribut, das künftig für die Migration zu einer anderen Webhook-Version genutzt werden kann. Aktuell ist es immer v2.
• direction: Gibt an, ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Anrufe zwischen Kollegen werden als outbound markiert.
• caller: Informationen über den Anrufer.
• number: Die Telefonnummer, die der Anrufer verwendet.
• name: Der Name des Anrufers.
• account_number: Die interne Nummer des VoIP Accounts (sofern verfügbar, bei eingehenden Anrufen ist diese fast immer null).
• user_numbers: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.
• destination: Informationen darüber, wohin der Anruf geleitet wird.
• number: Die Telefonnummer, die der Anrufer gewählt hat.
• targets: Die Telefone, die für diesen Anruf klingeln. Nicht erreichbare Telefone werden nicht angezeigt.
• number: Die angerufene Nummer. Diese ist normalerweise identisch mit destination.number, kann sich aber bei einer Weiterleitung ändern.
• name: Der Name der angerufenen Person. Bei eingehenden Anrufen ist dieser fast immer null.
• account_number: Die internen Nummern der User, die ihren VoIP Account auf erreichbar eingestellt haben (sofern verfügbar, kann ein leeres Array sein).
• user_numbers: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.

Warm Transfer

Eine warm-transfer-Benachrichtigung wird gesendet, wenn ein Anruf „warm" weitergeleitet wird. Bei einem Warm Transfer ruft der Weiterleitende zunächst den neuen Teilnehmer an, dieser nimmt ab, spricht mit dem Weiterleitenden, und dann wird der Anruf weitergeleitet.

Der Anruf vom Weiterleitenden zur dritten Partei erzeugt ebenfalls ringing- und in-progress-Benachrichtigungen mit eigener call_id. Während einer Weiterleitung werden diese beiden Anrufe im Grunde zu einem einzigen Anruf zusammengeführt. Die call_id eines der beiden Anrufe wird dann für den Anruf nach der Weiterleitung verwendet. Die andere call_id wird in der Weiterleitung als merged_id angegeben und anschließend verworfen.

• call_id: Eine eindeutige Zeichenfolge zur Identifizierung des Anrufs, übernommen von einem der vorherigen Anrufe.
• merged_id: Die call_id des anderen vorherigen Anrufs, die nicht mehr verwendet wird.
• timestamp: Datum und Uhrzeit der Webhook-Generierung im ISO-8601-Format.
• status: Der Status des Anrufs. Für diesen Benachrichtigungstyp ist er transfer.
• version: Ein Versions-Attribut, das künftig für die Migration zu einer anderen Webhook-Version genutzt werden kann. Aktuell ist es immer v2.
• direction: Gibt an, ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Anrufe zwischen Kollegen werden als outbound markiert.
• caller: Informationen über den Anrufer.
• number: Die Telefonnummer, die der Anrufer verwendet.
• name: Der Name des Anrufers.
• account_number: Die interne Nummer des VoIP Accounts (sofern verfügbar, bei eingehenden Anrufen ist diese fast immer null).
• user_numbers: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.
• destination: Informationen darüber, wohin der Anruf geleitet wird.
• number: Die Telefonnummer, die der Anrufer gewählt hat.
• targets: Die Telefone, die für diesen Anruf klingeln. Nicht erreichbare Telefone werden nicht angezeigt.
• number: Die angerufene Nummer. Diese ist normalerweise identisch mit destination.number, kann sich aber bei einer Weiterleitung ändern.
• name: Der Name der angerufenen Person. Bei eingehenden Anrufen ist dieser fast immer null.
• account_number: Die internen Nummern der User, die ihren VoIP Account auf erreichbar eingestellt haben (sofern verfügbar, kann ein leeres Array sein).
• user_numbers: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.
• redirector: Informationen über den Teilnehmer, der die Weiterleitung durchgeführt hat.
• number: Die Telefonnummer, die der Weiterleitende verwendet.
• name: Der Name des Weiterleitenden.
• account_number: Die interne Nummer des VoIP Accounts (sofern verfügbar, bei eingehenden Anrufen ist diese fast immer null).
• user_numbers: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.

Cold Transfer

Eine cold-transfer-Benachrichtigung wird gesendet, wenn ein Anruf per Cold Transfer verbunden wird. Bei einem Cold Transfer ruft die verbindende Person den neuen Teilnehmer an, verbindet den Anruf aber, ohne abzuwarten, ob oder wer abnimmt.

Es gibt zwei wesentliche Unterschiede zwischen einem cold-transfer und einem warm-transfer:

• Bei einem Warm Transfer gibt es immer nur einen Angerufenen, während bei einem Cold Transfer mehrere Angerufene möglich sind (z. B. wenn der Anruf zu einer Anrufgruppe verbunden wird).
• Bei einem Warm Transfer werden zunächst ringing- und in-progress-Benachrichtigungen erzeugt. Bei einem Cold Transfer wird nur eine ringing-Benachrichtigung gesendet, und eine in-progress-Benachrichtigung folgt erst, wenn der Dritte den Anruf annimmt.

Der Anruf von der verbindenden Person zum Dritten erzeugt ebenfalls eine ringing-Benachrichtigung mit einer eigenen call_id. Während einer Verbindung werden diese beiden Anrufe im Wesentlichen zu einem einzigen Anruf zusammengeführt. Die call_id eines der beiden Anrufe wird dann für den Anruf nach der Verbindung verwendet. Die andere call_id wird im Transfer als merged_id aufgenommen und anschließend verworfen.

• call_id: Eine eindeutige Zeichenfolge zur Identifizierung des Anrufs, die von einem der vorherigen Anrufe übernommen wird.
• merged_id: Die call_id des anderen vorherigen Anrufs, die nicht mehr verwendet wird.
• timestamp: Datum und Uhrzeit der Webhook-Erzeugung im ISO 8601-Format.
• status: Der Status des Anrufs. Bei diesem Benachrichtigungstyp ist es transfer.
• version: Ein Versionsattribut, das in Zukunft zur Migration auf eine andere Version der Webhooks genutzt werden kann. Aktuell ist es immer v2.
• direction: Ob ein Anruf eingehend oder ausgehend ist. Aktuell werden nur eingehende Anrufe unterstützt, daher ist dieser Wert immer inbound.
• caller: Informationen über den Anrufer.
• number: Die Telefonnummer, die der Anrufer verwendet.
• name: Der Name des Anrufers.
• account_number: Die interne Nummer des VoIP Accounts (sofern verfügbar, bei eingehenden Anrufen ist dies fast immer null).
• user_numbers: Die internen Nummern der erreichbaren User (sofern verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.
• destination: Informationen darüber, wohin der Anruf geleitet wird.
• number: Die Telefonnummer, die der Anrufer gewählt hat.
• targets: Die Telefone, die für diesen Anruf klingeln. Nicht erreichbare Telefone werden nicht angezeigt.
• number: Die Nummer, die angerufen wird. Diese ist normalerweise identisch mit destination.number, kann sich aber ändern, wenn der Anruf umgeleitet wird.
• name: Der Name der angerufenen Person. Bei eingehenden Anrufen ist dies fast immer null.
• account_number: Die internen Nummern der User, die ihren VoIP Account als erreichbar eingerichtet haben (sofern verfügbar, kann ein leeres Array sein).
• user_numbers: Die internen Nummern der erreichbaren User (sofern verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.
• redirector: Informationen über den Teilnehmer, der die Verbindung durchgeführt hat.
• number: Die Telefonnummer, die der Verbindende verwendet.
• name: Der Name des Verbindenden.
• account_number: Die interne Nummer des VoIP Accounts (sofern verfügbar, bei eingehenden Anrufen ist dies fast immer null).
• user_numbers: Die internen Nummern der erreichbaren User (sofern verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.

Auflegen (ended)

Eine ended-Benachrichtigung wird gesendet, wenn ein Anruf beendet wird. Es gibt verschiedene Gründe, warum ein Anruf enden kann.

Eine ended-Benachrichtigung kann nach einer in-progress-Benachrichtigung gesendet werden, wenn der Anruf von einem der Teilnehmer aufgelegt wurde, nach einer ringing-Benachrichtigung, wenn niemand geantwortet hat, oder als einzige Benachrichtigung, wenn keine Geräte erreichbar waren.

• call_id: Eine eindeutige Zeichenfolge zur Identifizierung des Anrufs.
• timestamp: Datum und Uhrzeit der Webhook-Erzeugung im ISO 8601-Format.
• status: Der Status des Anrufs. Bei diesem Benachrichtigungstyp ist es ended.
• reason: Der Grund, warum der Anruf beendet wurde. Der Grund kann einer der folgenden Werte sein:
1. completed: Der Anruf wurde erfolgreich abgeschlossen.
2. busy: Der Anruf wurde abgelehnt, der Angerufene war beschäftigt.
3. no-answer: Niemand hat den Anruf aus verschiedenen Gründen angenommen.
4. failed: Ein Fehler ist aufgetreten, der den Verbindungsaufbau verhindert hat.
5. cancelled: Der Anrufer hat aufgelegt, bevor jemand abnehmen konnte.
6. abandon: Der Anrufer hat aufgelegt, während er in der Warteschleife wartete.
• version: Ein Versionsattribut, das in Zukunft zur Migration auf eine andere Version der Webhooks genutzt werden kann. Aktuell ist es immer v2.
• direction: Ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Anrufe zwischen Kollegen werden als outbound markiert.
• caller: Informationen über den Anrufer.
• number: Die Telefonnummer, die der Anrufer verwendet.
• name: Der Name des Anrufers.
• account_number: Die interne Nummer des VoIP Accounts (falls verfügbar, bei eingehenden Anrufen fast immer null).
• user_numbers: Die internen Nummern der User, die erreichbar sind (falls verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.
• destination: Informationen darüber, wohin der Anruf geleitet wird.
• number: Die Telefonnummer, die der Anrufer gewählt hat.

Transkription erstellt

Eine call_transcription Benachrichtigung wird gesendet, sobald die Transkription fertig ist.

Wenn Voys Intelligence aktiviert ist. Dies ist das erste Ereignis, das auf eine ended Benachrichtigung folgt. Falls Anrufzusammenfassungen aktiviert sind, folgt in Kürze das summary Ereignis.

{            
  "call_id": "ua0-grq-prd-1780997460.58680",
  "call_transcription": "Speaker 1: Hi how are you.\nSpeaker 2: Hey great that you called.",        
}

Zusammenfassung erstellt

Eine summary Benachrichtigung wird gesendet, sobald die Anrufzusammenfassung fertig ist.

Wenn Voys Intelligence aktiviert ist. Dies ist das letzte Ereignis für einen bestimmten Anruf.

{
  "call_id": "ua0-grq-prd-1780997460.58680", 
  "summary": "This was a great call."
}

• Gehe zu Anrufbenachrichtigungen.
• Klicke auf Hinzufügen.
• Gib im Feld Beschreibung eine Beschreibung ein, um den Zweck der Benachrichtigung festzulegen.
• Wähle bei Paket die Option 'Custom', es sei denn, Du möchtest eine Standardoption verwenden.
• Gib die URL ein, an die die Gesprächsbenachrichtigungen gesendet werden sollen.
• Gib das API-Token ein, falls Dein gewähltes Paket eines bereitstellt.

Hinweis: Dies ist nur erforderlich, wenn Dein Paket ein API-Token ausstellt.

• Klicke auf Speichern.

Hier sind einige Beispiele für Kopplungen in Kombination mit Zapier:

• Eine Nachricht an Slack bei einem verpassten Anruf senden.
• Eine E-Mail bei einem verpassten Anruf senden.
• Robin-Kopplung.
• Microsoft Flow-Kopplung
• Zapier-Kopplung

Und ein Beispiel mit N8N und unserer Call Transcription API

Gesprächstranskriptionen automatisch mit N8N abrufen