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, Warmes Verbinden, Kaltes Verbinden 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 versendet. Im Folgenden kannst du nachlesen, welche Informationen genau übermittelt 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 wurde, 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. Derzeit 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 mitgesendet.
• user_numbers: Diese Information wird beim created-Event nicht mitgesendet.
• user_emails: Diese Information wird beim created-Event nicht mitgesendet.
• 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 wurde, 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. 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: Diese Information wird beim ringing-Event nicht mitgesendet.
• user_numbers: Diese Information wird beim ringing-Event nicht mitgesendet.
• user_emails: Diese Information wird beim ringing-Event nicht mitgesendet.
• 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 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 (falls verfügbar, kann ein leeres Array sein).
• 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.

Angenommen (in Bearbeitung)

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

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

• call_id: Ein eindeutiger String 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 es in-progress.
• version: Ein Versionsattribut, das in Zukunft für die Migration zu einer anderen Webhook-Version 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.
• 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 ä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.

Warme Weiterleitung

Eine warm-transfer-Benachrichtigung wird gesendet, wenn ein Anruf "warm" weitergeleitet wird. Bei einer warmen Weiterleitung ruft der Weiterleitende zunächst den neuen Teilnehmer an, der neue Teilnehmer 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 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 ist in der Weiterleitung als merged_id enthalten und wird dann verworfen.

• call_id: Ein eindeutiger String zur Identifizierung des Anrufs, der von einem der vorherigen Anrufe übernommen wurde.
• 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 es transfer.
• version: Ein Versionsattribut, das in Zukunft für die Migration zu einer anderen Webhook-Version 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.
• 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 ä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.
• 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.

Kalte Weiterleitung

Eine cold-transfer Benachrichtigung wird versendet, wenn ein Anruf kalt weitergeleitet wird. Bei einer kalten Weiterleitung ruft die weiterleitende Person den neuen Teilnehmer an, leitet den Anruf jedoch weiter, ohne abzuwarten, ob oder wer abnimmt.

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

• Bei einer warmen Weiterleitung gibt es immer eine angerufene Partei, während es bei einer kalten Weiterleitung mehrere geben kann (z. B. wenn der Anruf an eine Anrufgruppe weitergeleitet wird).
• Bei einer warmen Weiterleitung werden zuerst ringing und in-progress Benachrichtigungen generiert. Bei einer kalten Weiterleitung wird nur eine ringing Benachrichtigung versendet, und eine in-progress Benachrichtigung folgt nur dann, wenn die dritte Partei den Anruf annimmt.

Der Anruf von der weiterleitenden Person zur dritten Partei generiert ebenfalls eine ringing Benachrichtigung 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 einbezogen und anschließend verworfen.

• call_id: Eine eindeutige Zeichenkette 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 in Zukunft verwendet werden kann, um zu einer anderen Version der Webhooks zu migrieren. Aktuell 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 (wo verfügbar, bei eingehend Anrufen ist dies fast immer null).
• user_numbers: Die internen Nummern der User, die erreichbar sind (wo 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. 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 angerufenen Person. Bei eingehend Anrufen ist dies fast immer null.
• account_number: Die internen Nummern der User, die ihren VoIP Account so eingerichtet haben, dass sie erreichbar sind (wo verfügbar, kann ein leeres Array sein).
• user_numbers: Die internen Nummern der User, die erreichbar sind (wo 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 (wo verfügbar, bei eingehend Anrufen ist dies fast immer null).
• user_numbers: Die internen Nummern der User, die erreichbar sind (wo verfügbar, kann ein leeres Array sein).
• user_emails: Die E-Mail-Adressen der User.

Auflegen (ended)

Eine ended Benachrichtigung wird versendet, wenn ein Anruf beendet wird. Es gibt mehrere Gründe, warum ein Anruf enden kann.

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

• 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. Für diesen 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 Aufbau des Anrufs verhindert hat.
5. cancelled: Der Anrufer hat aufgelegt, bevor jemand abnehmen konnte.
6. abandon: Der Anrufer hat aufgelegt, während er in der Warteschleife gewartet hat.
• version: Ein Versionsattribut, das in Zukunft verwendet werden kann, um zu einer anderen Version der Webhooks zu migrieren. 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 (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.

Transkription erstellt

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

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

{            
  "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, ist dies das letzte Event 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 eine Beschreibung im Feld Beschreibung ein, um den Zweck der Benachrichtigung zu definieren.
• Wähle 'Custom' aus den Paket-Optionen, es sei denn, du möchtest lieber eine Standardoption verwenden.
• Gib die URL ein, an die die Gesprächsbenachrichtigungen gesendet werden sollen.
• Gib das API-Token ein, sofern dein gewähltes Paket eines bereitstellt.

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

• Klicke auf Speichern.