Anrufbenachrichtigung

Was sind Anrufbenachrichtigungen?

Das Modul Anrufbenachrichtigungen ermöglicht es Ihnen, automatisch Anrufdaten an eine URL Ihrer Wahl zu senden. Diese Anrufbenachrichtigungen werden für alle Anrufe innerhalb Ihrer Portalumgebung an die angegebene URL gesendet.

Wenn Sie diese Anrufbenachrichtigungen in Ihre CRM-Software integrieren, können Sie den Anrufer, die Uhrzeit des Anrufs und seine Dauer sehen.

Die Anrufbenachrichtigungen werden für eingehende, interne und ausgehende Anrufe ausgelöst. Sie können Anrufbenachrichtigungen auch für andere Zwecke verwenden, z. B. zur Messung von Anrufstatistiken.

‣

Die Anrufbenachrichtigung löst aus

Während eines Anrufs werden zu sechs verschiedenen Zeitpunkten Informationen für eingehende, interne und ausgehende Anrufe an die angegebene URL gesendet: Erstellt, Klingeln, Angenommen, Warme Weiterleitung, Kalte Weiterleitung und Aufgelegt. Bei verschiedenen wichtigen Ereignissen während eines Anrufs werden Benachrichtigungen an die angegebene URL gesendet. Die Benachrichtigungen werden als POST-Anfrage mit den Daten in einem JSON-Dokument gesendet. Nachfolgend können Sie lesen, welche Informationen genau gesendet werden.

‣

Erstellt

‣

Klingeln

Eine ringing-Benachrichtigung wird gesendet, wenn das Telefon aufgrund eines eingehenden Anrufs zu klingeln beginnt.

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

{
  "call_id": "ua9-grq-prd-1693575683.22973164",  "timestamp": "2023-09-01T13:41:26.020742+00:00",  "status": "ringing",  "version": "v2",  "direction": "inbound",  "caller": {
    "number": "+31507009920",    "name": "Johan",    "account_number": null,    "user_numbers": [],    "user_emails": []
  },  "destination": {
    "number": "+31332022074",    "targets": [
      {
        "number": "+31332022074",        "name": null,        "account_number": "201",        "user_numbers": [
          "610"        ],        "user_emails": [
          "email@email.com"        ]
      }
    ]
  }
}

call_id: Eine eindeutige Zeichenfolge zur Identifizierung des Anrufs.
Zeitstempel: Das Datum und die Uhrzeit, zu der der Webhook generiert wird, im Format ISO 8601.
Status: Der Status des Anrufs. Für diese Benachrichtigungsart lautet er ringing.
Version: Ein Versionsattribut, das in Zukunft verwendet werden kann, um auf eine andere Version der Webhooks zu migrieren. Derzeit ist es immer v2.
Richtung: Ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Anrufe zwischen Kollegen werden als outboundgekennzeichnet.
Anrufer: Informationen über den Anrufer.

Nummer: Die Telefonnummer, die der Anrufer benutzt.
Name: Der Name des Anrufers.
Account_Nummer: Diese Informationen werden nicht mit dem Ereignis ringing gesendet.
User_Nummern: Diese Informationen werden nicht mit dem Ereignis ringing gesendet.
User_E-Mails: Diese Informationen werden nicht mit dem Ereignis ringing gesendet.

Ziel: Informationen darüber, wohin der Anruf geleitet wird.

Nummer: Die Telefonnummer, die der Anrufer gewählt hat.
Ziele: Die Telefone, die für diesen Anruf klingeln. Telefone, die nicht erreichbar sind, werden nicht angezeigt.

Nummer: Die Nummer, die angerufen wird. Dies ist normalerweise die gleiche wie die Zielnummer, kann sich aber ändern, wenn der Anruf weitergeleitet wird.
Name: Der Name der angerufenen Person. Bei eingehenden Anrufen ist dies fast immer null.
Account_Nummer: Die internen Nummern der User, die ihr VoIP Account für die Erreichbarkeit eingerichtet haben (sofern verfügbar, kann ein leeres Feld sein).
User_Nummern: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Feld sein).
User_E-Mails: Die E-Mail-Adressen der User.

‣

Beantwortet (in Arbeit)

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

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

{
  "call_id": "ua9-grq-prd-1693575683.22973164",  "timestamp": "2023-09-01T13:41:26.992074+00:00",  "status": "in-progress",  "version": "v2",  "direction": "inbound",  "caller": {
    "number": "+31507009920",    "name": "Johan",    "account_number": null,    "user_numbers": [],    "user_emails": []
  },  "destination": {
    "number": "+31332022074",    "target": {
      "number": "+31332022074",      "name": null,      "account_number": "201",      "user_numbers": [
        "610"      ],      "user_emails": [
        "email@email.com"      ]
    }
  }
}

call_id: Eine eindeutige Zeichenfolge zur Identifizierung des Anrufs.
Zeitstempel: Das Datum und die Uhrzeit, zu der der Webhook generiert wird, im Format ISO 8601.
Status: Der Status des Anrufs. Für diese Benachrichtigungsart lautet er in-progress.
Version: Ein Versionsattribut, das in Zukunft verwendet werden kann, um auf eine andere Version der Webhooks zu migrieren. Derzeit ist es immer v2.
Richtung: Ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Anrufe zwischen Kollegen werden als outbound gekennzeichnet.
Anrufer: Informationen über den Anrufer.

Nummer: Die Telefonnummer, die der Anrufer benutzt.
Name: Der Name des Anrufers.
Account_Nummer: Die interne Nummer des VoIP Account (sofern verfügbar, bei eingehenden Anrufen ist dies fast immer null).
User_Nummern: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Feld sein).
User_E-Mails: Die E-Mail-Adressen der User.

Ziel: Informationen darüber, wohin der Anruf geleitet wird.

Nummer: Die Telefonnummer, die der Anrufer gewählt hat.
Ziele: Die Telefone, die für diesen Anruf klingeln. Telefone, die nicht erreichbar sind, werden nicht angezeigt.

Nummer: Die angerufene Nummer. Dies ist normalerweise die gleiche wie die Zielnummer, kann sich aber ändern, wenn der Anruf weitergeleitet wird.
Name: Der Name der angerufenen Person. Bei eingehenden Anrufen ist dies fast immer null.
Account_Nummer: Die internen Nummern der User, die ihr VoIP Account für die Erreichbarkeit eingerichtet haben (sofern verfügbar, kann ein leeres Feld sein).
User_Nummern: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Feld sein).
User_E-Mails: Die E-Mail-Adressen der User.

‣

Warme Weiterleitung

Eine warm-transfer-Benachrichtigung wird gesendet, wenn ein Anruf „warm“ weitergeleitet wird. Bei einer warmen Weiterleitung ruft der Umleitende zunächst den neuen Teilnehmer an, der neue Teilnehmer antwortet, spricht mit dem Umleitenden und dann wird der Anruf übergeben.

Der Anruf vom Absender an den Dritten erzeugt auch ringing- und in-progress-Benachrichtigungen mit ihrer eigenen call_id. Bei einer Weiterleitung werden diese beiden Anrufe im Wesentlichen zu einem einzigen Anruf zusammengeführt. Die call_id von einem der beiden Anrufe wird dann für den Anruf nach der Weiterleitung verwendet. Die andere call_id wird als merged_id in die Weiterleitung einbezogen und dann verworfen.

{
  "call_id": "ua7-ams-prd-1693576700.23986757",  "merged_id": "ua7-ams-prd-1693576711.23987220",  "timestamp": "2023-09-01T13:58:44.399054+00:00",  "status": "warm-transfer",  "version": "v2",  "direction": "inbound",  "caller": {
    "number": "+31507009920",    "name": "Johan N",    "account_number": null,    "user_numbers": [],    "user_emails": []
  },  "destination": {
    "number": "629",    "target": {
      "number": "629",      "name": null,      "account_number": "203",      "user_numbers": [
        "629"      ],      "user_emails": [
        "email2@email.com"      ]
    }
  },  "redirector": {
    "number": "610",    "name": "Johan N",    "account_number": "201",    "user_numbers": [
      "610"    ],    "user_emails": [
      "email@email.com"    ]
  }
}

call_id: Eine eindeutige Zeichenfolge zur Identifizierung des Anrufs, die von einem der vorherigen Anrufe übernommen wurde.
Zusammengeführte_ID: Die Anrufer_ID des anderen vorherigen Aufrufs, die nicht mehr verwendet wird.
Zeitstempel: Das Datum und die Uhrzeit, zu der der Webhook generiert wird, im Format ISO 8601.
Status: Der Status des Anrufs. Für diese Benachrichtigungsart lautet er transfer.
Version: Ein Versionsattribut, das in Zukunft verwendet werden kann, um auf eine andere Version der Webhooks zu migrieren. Derzeit ist es immer v2.
Richtung: Ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Anrufe zwischen Kollegen werden als outbound gekennzeichnet.
Anrufer: Informationen über den Anrufer.

Nummer: Die Telefonnummer, die der Anrufer benutzt.
Name: Der Name des Anrufers.
Account_Nummer: Die interne Nummer des VoIP Account (sofern verfügbar, bei eingehenden Anrufen ist dies fast immer null).
User_Nummern: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Feld sein).
User_E-Mails: Die E-Mail-Adressen der User.

Ziel: Informationen darüber, wohin der Anruf geleitet wird.

Nummer: Die Telefonnummer, die der Anrufer gewählt hat.
Ziele: Die Telefone, die für diesen Anruf klingeln. Telefone, die nicht erreichbar sind, werden nicht angezeigt.

Nummer: Die angerufene Nummer. Dies ist normalerweise die gleiche wie die Zielnummer, kann sich aber ändern, wenn der Anruf weitergeleitet wird.
Name: Der Name der angerufenen Person. Bei eingehenden Anrufen ist dies fast immer null.
Account_Nummer: Die internen Nummern der User, die ihr VoIP Account für die Erreichbarkeit eingerichtet haben (sofern verfügbar, kann ein leeres Feld sein).
User_Nummern: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Feld sein).
User_E-Mails: Die E-Mail-Adressen der User.

Umleitende Person: Informationen über den Teilnehmer, der die Weiterleitung durchgeführt hat.

Nummer: Die Telefonnummer, die der Umleitende verwendet.
Name: Der Name der umleitenden Person.
Account_Nummer: Die interne Nummer des VoIP Account (sofern verfügbar, bei eingehenden Anrufen ist dies fast immer null).
User_Nummern: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Feld sein).
User_E-Mails: Die E-Mail-Adressen der User.

‣

Kalte Weiterleitung

Eine cold-transfer-Benachrichtigung wird gesendet, wenn ein Anruf kalt weitergeleitet wird. Bei einer kalten Weiterleitung ruft der Umleitende den neuen Teilnehmer an, leitet den Anruf aber weiter, ohne abzuwarten, ob jemand oder wer antwortet.

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

Bei einer warmen Weiterleitung gibt es immer nur einen angerufenen Teilnehmer, während es bei einer kalten Weiterleitung mehrere sein können (z. B. wenn der Anruf an eine Anrufgruppe weitergeleitet wird).
Bei einer warmen Weiterleitung werden zuerst die Benachrichtigungen ringing und in-progress generiert. Bei einer kalten Weiterleitung wird nur eine ringingBenachrichtigung gesendet, und eine in-progressBenachrichtigung folgt nur, wenn der Dritte den Anruf entgegennimmt.

Der Anruf vom Absender zum Dritten erzeugt ebenfalls eine ringing-Benachrichtigung mit einer eigenen call_id. Bei einer Weiterleitung werden diese beiden Anrufe im Wesentlichen zu einem einzigen Anruf zusammengeführt. Die call_id von einem der beiden Anrufe wird dann für den Anruf nach der Weiterleitung verwendet. Die andere call_id wird als merged_id in die Übertragung einbezogen und dann verworfen.

{
  "call_id": "ua4-grq-prd-1693576927.25584586",  "merged_id": "ua4-grq-prd-1693576937.25585499",  "timestamp": "2023-09-01T14:02:17.054643+00:00",  "status": "cold-transfer",  "version": "v2",  "direction": "inbound",  "caller": {
    "number": "+31507009920",    "name": "Johan N",    "account_number": null,    "user_numbers": [],    "user_emails": []
  },  "destination": {
    "number": "629",    "targets": [
      {
        "number": "629",        "name": null,        "account_number": "203",        "user_numbers": [
          "629"        ],        "user_emails": [
          "email2@email.com"        ]
      }
    ]
  },  "redirector": {
    "number": "+31332022074",    "name": null,    "account_number": "201",    "user_numbers": [
      "610"    ],    "user_emails": [
      "email@email.com"    ]
  }
}

call_id: Eine eindeutige Zeichenfolge zur Identifizierung des Anrufs, die von einem der vorherigen Anrufe übernommen wurde.
Zusammengeführte_ID: Die Anrufer_ID des anderen vorherigen Aufrufs, die nicht mehr verwendet wird.
Zeitstempel: Das Datum und die Uhrzeit, zu der der Webhook generiert wird, im Format ISO 8601.
Status: Der Status des Anrufs. Für diese Benachrichtigungsart lautet er transfer.
Version: Ein Versionsattribut, das in Zukunft verwendet werden kann, um auf eine andere Version der Webhooks zu migrieren. Derzeit ist es immer v2.
Richtung: Ob ein Anruf eingehend oder ausgehend ist. Derzeit werden nur eingehende Anrufe unterstützt, daher ist dieser Wert immer inbound.
Anrufer: Informationen über den Anrufer.

Nummer: Die Telefonnummer, die der Anrufer benutzt.
Name: Der Name des Anrufers.
Account_Nummer: Die interne Nummer des VoIP Account (sofern verfügbar, bei eingehenden Anrufen ist dies fast immer null).
User_Nummern: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Feld sein).
User_E-Mails: Die E-Mail-Adressen der User.

Ziel: Informationen darüber, wohin der Anruf geleitet wird.

Nummer: Die Telefonnummer, die der Anrufer gewählt hat.
Ziele: Die Telefone, die für diesen Anruf klingeln. Telefone, die nicht erreichbar sind, werden nicht angezeigt.

Nummer: Die angerufene Nummer. Dies ist normalerweise die gleiche wie die Zielnummer, kann sich aber ändern, wenn der Anruf weitergeleitet wird.
Name: Der Name der angerufenen Person. Bei eingehenden Anrufen ist dies fast immer null.
Account_Nummer: Die internen Nummern der User, die ihr VoIP Account für die Erreichbarkeit eingerichtet haben (sofern verfügbar, kann ein leeres Feld sein).
User_Nummern: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Feld sein).
User_E-Mails: Die E-Mail-Adressen der User.

Umleitende Person: Informationen über den Teilnehmer, der die Weiterleitung durchgeführt hat.

Nummer: Die Telefonnummer, die der Umleitende verwendet.
Name: Der Name der umleitenden Person.
Account_Nummer: Die interne Nummer des VoIP Account (sofern verfügbar, bei eingehenden Anrufen ist dies fast immer null).
User_Nummern: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Feld sein).
User_E-Mails: Die E-Mail-Adressen der User.

‣

Aufgelegt (beendet)

Eine ended-Benachrichtigung wird gesendet, wenn ein Anruf beendet wird. Es gibt mehrere Gründe, warum ein Anruf beendet werden 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": "ua9-grq-prd-1693575683.22973164",  "timestamp": "2023-09-01T13:41:27.653775+00:00",  "status": "ended",  "reason": "completed",  "version": "v2",  "direction": "inbound",  "caller": {
    "number": "+31507009920",    "name": "Johan",    "account_number": null,    "user_numbers": [],    "user_emails": []
  },  "destination": {
    "number": "+31332022074"  }
}

call_id: Eine eindeutige Zeichenfolge zur Identifizierung des Anrufs.
Zeitstempel: Das Datum und die Uhrzeit, zu der der Webhook generiert wird, im Format ISO 8601.
Status: Der Status des Anrufs. Für diese Benachrichtigungsart lautet er ended.
Grund: Der Grund, warum der Anruf beendet wurde. Der Grund kann einer der folgenden Werte sein:

Abgeschlossen: Der Anruf wurde erfolgreich abgeschlossen.
Besetzt: Der Anruf wurde abgewiesen, der Angerufene war beschäftigt.
Keine Antwort: Aus verschiedenen Gründen hat niemand auf den Anruf reagiert.
Fehlgeschlagen: Es ist ein Fehler aufgetreten, der den Verbindungsaufbau verhindert hat.
Annulliert: Der Anrufer legte auf, bevor jemand antworten konnte.
Aufgegeben: Der Anrufer hat aufgelegt, während er in der Warteschleife wartete.

Version: Ein Versionsattribut, das in Zukunft verwendet werden kann, um auf eine andere Version der Webhooks zu migrieren. Derzeit ist es immer v2.
Richtung: Ob ein Anruf eingehend (inbound) oder ausgehend (outbound) ist. Anrufe zwischen Kollegen werden als outbound gekennzeichnet.
Anrufer: Informationen über den Anrufer.

Nummer: Die Telefonnummer, die der Anrufer benutzt.
Name: Der Name des Anrufers.
Account_Nummer: Die interne Nummer des VoIP Account (sofern verfügbar, bei eingehenden Anrufen ist dies fast immer null).
User_Nummern: Die internen Nummern der User, die erreichbar sind (sofern verfügbar, kann ein leeres Feld sein).
User_E-Mails: Die E-Mail-Adressen der User.

Ziel: Informationen darüber, wohin der Anruf geleitet wird.

Nummer: Die Telefonnummer, die der Anrufer gewählt hat.

‣

Reihenfolge der Benachrichtigungen

Für jeden Anruf werden mehrere Benachrichtigungen gesendet. Welche Benachrichtigungen gesendet werden, hängt davon ab, wie der Anruf behandelt wird. Nachfolgend finden Sie die Reihenfolge der Benachrichtigungen für die häufigsten Arten von Anrufen.

Einfacher Anruf

Ein erfolgreicher Anruf mit zwei Teilnehmern:

Klingeln – A ruft B an
Im Gange – A ruft B an
Beendet – A ruft B an (Grund: completed)

Keine Antwort

Das Telefon des Angerufenen klingelt, wird aber nicht abgenommen.

Klingeln – A ruft B an
Beendet – A ruft B an (Grund: busy oder no-answer je nach Gerät)

Angerufener nicht erreichbar

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

Beendet – A ruft B an (Grund: busy)

Beaufsichtigte Weiterleitung

Bei einer beaufsichtigten Weiterleitung (Warme Weiterleitung) ruft A zunächst B an, dann leitet einer der Teilnehmer den Anruf an C weiter. Der Teilnehmer ruft zunächst C an, und nachdem sie gesprochen haben, wird der Anruf weitergeleitet. Nur Teilnehmer A und C bleiben in dem Gespräch.

Klingeln – A ruft B an
Im Gange – A ruft B an
Klingeln – B ruft C an
Im Gange – B ruft C
Warme Weiterleitung – B verbindet A und C
Beendet – A und C legen auf (Grund: completed)

Blinde Weiterleitung

Bei einer blinden Weiterleitung (Kalte Weiterleitung) ruft A zunächst B an, dann leitet einer der Teilnehmer den Anruf an C weiter, ohne abzuwarten, ob C erreichbar ist.

Klingeln – A ruft B an
Im Gange – A ruft B an
Klingeln – B ruft C an
Kalte Weiterleitung – B verbindet A und C
Im Gange – A ruft C an
Beendet – A ruft C nicht mehr an (Grund: completed)

Halb-beaufsichtigte Weiterleitung

Bei einer halb-beaufsichtigten Weiterleitung (Lauwarme Weiterleitung) ruft A zuerst B an, dann leitet einer der Teilnehmer den Anruf an C weiter. Der Teilnehmer versucht, zuerst C anzurufen, leitet den Anruf aber weiter, bevor C antwortet.

Klingeln – A ruft B an
Im Gange – A ruft B an
Klingeln – B ruft C an
Kalte Weiterleitung – B verbindet A und C
Im Gange – A ruft C an
Beendet – A ruft C nicht mehr an (Grund: completed)

Anruf-Pickup

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

Klingeln – A ruft B an
Im Gange – A ruft C an
Beendet – A ruft C nicht mehr an (Grund: completed)

Rufumleitung

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

Klingeln – A ruft B an
Klingeln – A ruft B an & C
Im Gange oder beendet, je nachdem, ob jemand antwortet.

‣

Einrichten von Anrufbenachrichtigungen

FAQ

‣

Was ist der Unterschied zwischen Anrufbenachrichtigungen und Webhooks?

‣

Für welche Anrufe können Anrufbenachrichtigungen verwendet werden?

‣

Welches Datenformat wird gesendet?

‣

Welche HTTP-Anfragemethode soll ich verwenden?