Anrufbenachrichtigungen

Während eines Anrufs werden Informationen zu sechs verschiedenen Zeitpunkten an die angegebene URL gesendet – sowohl für eingehende, interne als auch ausgehende Anrufe: Erstellt, Klingelt, Angenommen, Warme Weiterleitung, Kalte Weiterleitung 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 genau, welche Informationen übermittelt werden.

Erstellt

Ein created-Event wird ausgelöst, wenn ein eingehender Anruf initiiert 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. Bei diesem Benachrichtigungstyp ist es created.
• version: Ein Versions-Attribut, das in Zukunft verwendet werden kann, um auf eine andere Version der Webhooks zu migrieren. Aktuell ist es immer v2.
• direction: Ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Das created-Event wird nur für eingehende Anrufe 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 aufgrund eines eingehenden Anrufs Telefone 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 Zeichenfolge zur Identifizierung des Anrufs.
• timestamp: Datum und Uhrzeit der Webhook-Generierung im ISO 8601-Format.
• status: Der Status des Anrufs. Bei diesem Benachrichtigungstyp ist es ringing.
• version: Ein Versions-Attribut, das in Zukunft verwendet werden kann, um auf eine andere Version der Webhooks zu migrieren. Aktuell ist es immer v2.
• direction: Ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Anrufe zwischen Kolleg:innen werden als outbound gekennzeichnet.
• 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 für diesen 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 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 User, die erreichbar sind (sofern verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.

Angenommen (in-progress)

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 Call Pickup 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. Bei diesem Benachrichtigungstyp ist es in-progress.
• version: Ein Versionsattribut, das künftig für die Migration auf eine andere Version der Webhooks verwendet werden kann. Derzeit ist es immer v2.
• direction: Gibt an, ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Anrufe zwischen Kolleg:innen 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 dies 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 läuten. Telefone, die nicht erreichbar sind, werden nicht angezeigt.
• number: Die Nummer, die angerufen wird. Diese ist normalerweise dieselbe wie 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 so eingerichtet haben, dass sie erreichbar sind (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 zuerst den neuen Teilnehmer an, der neue Teilnehmer nimmt ab, spricht mit dem Weiterleitenden, und dann wird der Anruf weitergeleitet.

Der Anruf vom Weiterleitenden zum Dritten erzeugt ebenfalls ringing und in-progress Benachrichtigungen mit einer eigenen call_id. Während einer Weiterleitung 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 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, 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, wann der Webhook generiert wird, im ISO 8601-Format.
• status: Der Status des Anrufs. Für diesen Benachrichtigungstyp ist es transfer.
• version: Ein Versionsattribut, das künftig für die Migration auf eine andere Version der Webhooks verwendet werden kann. Derzeit ist es immer v2.
• direction: Gibt an, ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Anrufe zwischen Kolleg:innen 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 dies 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 läuten. Telefone, die nicht erreichbar sind, werden nicht angezeigt.
• number: Die Nummer, die angerufen wird. Diese ist normalerweise dieselbe wie 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 so eingerichtet haben, dass sie erreichbar sind (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 dies 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 kalt weitergeleitet wird. Bei einem Cold Transfer ruft der Weiterleitende den neuen Teilnehmer an, leitet den Anruf aber weiter, 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 einen Angerufenen, während es bei einem Cold Transfer mehrere geben kann (z. B. wenn der Anruf an eine Anrufgruppe weitergeleitet wird).
• Für einen Warm Transfer werden zuerst ringing und in-progress Benachrichtigungen generiert. Bei einem Cold Transfer wird nur eine ringing Benachrichtigung gesendet, und eine in-progress Benachrichtigung folgt nur dann, wenn der Dritte den Anruf annimmt.

Der Anruf vom Weiterverbindenden zur dritten Partei erzeugt ebenfalls eine ringing-Benachrichtigung mit einer eigenen call_id. Während einer Weiterverbindung 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 Weiterverbindung verwendet. Die andere call_id ist in der Weiterverbindung als merged_id enthalten und wird 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, wann der Webhook erzeugt wird, im ISO 8601-Format.
• status: Der Status des Anrufs. Bei diesem Benachrichtigungstyp ist es transfer.
• version: Ein Versionsattribut, das in Zukunft für die Migration zu einer anderen Version der Webhooks verwendet werden kann. Derzeit ist es immer v2.
• direction: Ob ein Anruf eingehend oder ausgehend ist. Derzeit 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 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 läuten. Telefone, die nicht erreichbar sind, werden nicht angezeigt.
• number: Die Nummer, die angerufen wird. Diese ist normalerweise identisch mit destination.number, kann sich jedoch ä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 so eingerichtet haben, dass sie erreichbar sind (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 Weiterverbindung durchgeführt hat.
• number: Die Telefonnummer, die der Weiterverbindende verwendet.
• name: Der Name des Weiterverbindenden.
• 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 User, die erreichbar sind (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 beendet 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, wann der Webhook erzeugt wird, 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: The call was successfully completed.
2. busy: The call was rejected, the callee was busy.
3. no-answer: No one answered the call for various reasons.
4. failed: An error occurred preventing the call from being established.
5. cancelled: The caller hung up before anyone could answer.
6. abandon: The caller hung up while waiting in the queue.
• version: Ein Versionsattribut, das in Zukunft für die Migration zu einer anderen Version der Webhooks verwendet werden kann. Derzeit 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 (sofern verfügbar, bei eingehenden Anrufen ist dies 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.

Für jeden Anruf werden mehrere Benachrichtigungen versendet. Welche Benachrichtigungen gesendet werden, hängt davon ab, wie der Anruf bearbeitet wird. Im Folgenden findest du die Reihenfolge der Benachrichtigungen für die gängigsten Anrufarten.

Einfacher Anruf

Ein erfolgreicher Anruf mit zwei Teilnehmern:

• ringing - A ruft B an
• in-progress - A ruft B an
• ended - A ruft B an (Grund: completed)

Keine Antwort

Das Telefon des Angerufenen klingelt, wird aber nicht abgenommen.

• ringing - A ruft B an
• ended - A ruft B an (Grund: busy oder no-answer, je nach Gerät)

Angerufener nicht erreichbar

Der Angerufene ist nicht erreichbar (z. B. ist das Telefon auf Bitte nicht stören eingestellt), daher klingelt das Telefon nicht und der Anruf wird nicht angenommen.

• ended - A ruft B an (Grund: busy)

Vermitteltes Verbinden

Beim vermittelten Verbinden (warm transfer) ruft A zunächst B an, dann verbindet einer der Teilnehmer den Anruf mit C. Der Teilnehmer ruft zuerst C an, und nachdem beide miteinander gesprochen haben, wird der Anruf verbunden. Nur die Teilnehmer A und C bleiben im Gespräch.

• ringing - A ruft B an
• in-progress - A ruft B an
• ringing - B ruft C an
• in-progress - B ruft C an
• warm-transfer - B verbindet A und C
• ended - A und C legen auf (Grund: completed)

Blindes Verbinden

Beim blinden Verbinden (cold transfer) ruft A zunächst B an, dann verbindet einer der Teilnehmer den Anruf mit C, ohne abzuwarten, ob C erreichbar ist.

• ringing - A ruft B an
• in-progress - A ruft B an
• ringing - B ruft C an
• cold-transfer - B verbindet A und C
• in-progress - A ruft C an
• ended - A ruft C nicht mehr an (Grund: completed)

Halb-vermitteltes Verbinden

Beim halb-vermittelten Verbinden (lukewarm transfer) ruft A zunächst B an, dann verbindet einer der Teilnehmer den Anruf mit C. Der Teilnehmer versucht zunächst, C anzurufen, verbindet den Anruf jedoch weiter, bevor C antwortet.

• ringing - A ruft B an
• in-progress - A ruft B an
• ringing - B ruft C an
• cold-transfer - B verbindet A und C
• in-progress - A ruft C an
• ended - A ruft C nicht mehr an (Grund: completed)

Anruf-Übernahme

Wenn sich zwei Telefone in derselben Pickup-Gruppe befinden, ist es möglich, einen für ein anderes Telefon bestimmten Anruf von einem Telefon aus entgegenzunehmen.

• ringing - A ruft B an
• in-progress - A ruft C an
• ended - A ruft C nicht mehr an (Grund: completed)

Rufumleitung

Wenn ein User sein Telefon so eingestellt hat, dass eingehende Anrufe automatisch an eine andere Nummer weitergeleitet werden.

• ringing - A ruft B an
• ringing - A ruft B & C an
• in-progress oder ended, je nachdem, ob jemand abnimmt.

• Gehe zu Anrufbenachrichtigungen.
• Klicke auf Hinzufügen.
• Gib bitte eine Beschreibung in das Feld Beschreibung ein, um den Zweck der Benachrichtigung anzugeben.
• Wähle 'Custom' aus den Package-Optionen, es sei denn, du möchtest lieber eine Standardoption verwenden.
• Fülle bitte die URL aus, an die die Gesprächsbenachrichtigungen gesendet werden sollen.
• Fülle das API Token aus, falls dein gewähltes Package eines zur Verfügung stellt.

Hinweis: Dies ist nur erforderlich, wenn dein Package ein API Token bereitstellt.

• Klicke auf Speichern.

Hier findest du 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 Anruftranskriptions-API

Anruf-Transkriptionen automatisch mit N8N abrufen