Gespreksnotificaties

Tijdens een gesprek wordt op zes verschillende momenten informatie verzonden naar de opgegeven URL voor inkomende, interne en uitgaande gesprekken: Created, Ringing, Answered, Warm transfer, Cold transfer en Hang-up. Notificaties worden verzonden naar de opgegeven URL bij verschillende belangrijke gebeurtenissen tijdens een gesprek. De notificaties worden verzonden als een POST-verzoek met de gegevens in een JSON-document. Hieronder kan je lezen welke informatie er precies wordt verzonden.

Created

Een created event wordt geactiveerd wanneer een inkomende oproep wordt geïnitieerd.

• call_id: Een unieke string om de oproep te identificeren.
• timestamp: De datum en het tijdstip waarop de webhook wordt gegenereerd, in ISO 8601-formaat.
• status: De status van de oproep. Voor dit type notificatie is dit created.
• version: Een versie-attribuut dat in de toekomst kan worden gebruikt om te migreren naar een andere versie van de webhooks. Momenteel is dit altijd v2.
• direction: Of een oproep inkomend (inbound) of uitgaand (outbound) is. Het created event wordt enkel verzonden voor inkomende oproepen.
• caller: Informatie over de beller.
• number: Het telefoonnummer dat de beller gebruikt.
• name: De naam van de beller.
• account_number: Deze informatie wordt niet verzonden met het created event.
• user_numbers: Deze informatie wordt niet verzonden met het created event.
• user_emails: Deze informatie wordt niet verzonden met het created event.
• destination: Informatie over waar de oproep naartoe wordt geleid.
• number: Het telefoonnummer dat de beller heeft gekozen.

Ringing

Een ringing notificatie wordt verzonden wanneer telefoons beginnen te rinkelen door een inkomende oproep.

Het is mogelijk dat er meerdere ringing notificaties achtereenvolgens worden verzonden naarmate nieuwe apparaten beginnen te rinkelen.

• call_id: Een unieke string om de oproep te identificeren.
• timestamp: De datum en het tijdstip waarop de webhook wordt gegenereerd, in ISO 8601-formaat.
• status: De status van de oproep. Voor dit type notificatie is dit ringing.
• version: Een versie-attribuut dat in de toekomst kan worden gebruikt om te migreren naar een andere versie van de webhooks. Momenteel is dit altijd v2.
• direction: Of een oproep inkomend (inbound) of uitgaand (outbound) is. Gesprekken tussen collega's worden gemarkeerd als outbound.
• caller: Informatie over de beller.
• number: Het telefoonnummer dat de beller gebruikt.
• name: De naam van de beller.
• account_number: Deze informatie wordt niet verzonden met het ringing event.
• user_numbers: Deze informatie wordt niet verzonden met het ringing event.
• user_emails: Deze informatie wordt niet verzonden met het ringing event.
• destination: Informatie over waar de oproep naartoe wordt geleid.
• number: Het telefoonnummer dat de beller heeft gekozen.
• targets: De telefoons die rinkelen voor deze oproep. Telefoons die niet bereikbaar zijn, worden niet weergegeven.
• number: Het nummer dat wordt gebeld. Dit is meestal hetzelfde als destination.number, maar kan veranderen als de oproep wordt doorgeschakeld.
• name: De naam van de persoon die wordt gebeld. Voor inkomende oproepen is dit bijna altijd null.
• account_number: De interne nummers van de gebruikers die hun VoIP-account hebben ingesteld om bereikbaar te zijn (indien beschikbaar, kan een lege array zijn).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (indien beschikbaar, kan een lege array zijn).
• user_emails: De e-mailadressen van de gebruikers.

Answered (in-progress)

Een in-progress notificatie wordt verzonden wanneer een oproep wordt opgenomen.

Let op! De target die de oproep opneemt, is niet altijd een van de apparaten die oorspronkelijk rinkelden. Door call pickup kan het gebeuren dat de oproep op een ander apparaat wordt opgenomen.

• call_id: Een unieke string om de oproep te identificeren.
• timestamp: De datum en het tijdstip waarop de webhook wordt gegenereerd, in ISO 8601-formaat.
• status: De status van de oproep. Voor dit type notificatie is dit in-progress.
• version: Een versie-attribuut dat in de toekomst kan worden gebruikt om te migreren naar een andere versie van de webhooks. Momenteel is dit altijd v2.
• direction: Of een gesprek inkomend (inbound) of uitgaand (outbound) is. Gesprekken tussen collega's worden gemarkeerd als outbound.
• caller: Informatie over de beller.
• number: Het telefoonnummer dat de beller gebruikt.
• name: De naam van de beller.
• account_number: Het interne nummer van het VoIP-account (indien beschikbaar, voor inkomende gesprekken is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (indien beschikbaar, kan een lege array zijn).
• user_emails: De e-mailadressen van de gebruikers.
• destination: Informatie over waar het gesprek naartoe gaat.
• number: Het telefoonnummer dat de beller heeft gekozen.
• targets: De toestellen die overgaan voor dit gesprek. Toestellen die niet bereikbaar zijn, worden niet weergegeven.
• number: Het nummer dat wordt gebeld. Dit is meestal hetzelfde als destination.number, maar het kan veranderen als het gesprek wordt doorgeschakeld.
• name: De naam van de persoon die wordt gebeld. Voor inkomende gesprekken is dit bijna altijd null.
• account_number: De interne nummers van de gebruikers die hun VoIP-account hebben ingesteld om bereikbaar te zijn (indien beschikbaar, kan een lege array zijn).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (indien beschikbaar, kan een lege array zijn).
• user_emails: De e-mailadressen van de gebruikers.

Warme transfer

Een warm-transfer notificatie wordt verzonden wanneer een gesprek "warm" wordt doorverbonden. Bij een warme transfer belt de doorverbinder eerst de nieuwe deelnemer, de nieuwe deelnemer neemt op, spreekt met de doorverbinder, en vervolgens wordt het gesprek doorverbonden.

Het gesprek van de doorverbinder naar de derde partij genereert ook ringing en in-progress notificaties met hun eigen call_id. Tijdens een transfer worden deze twee gesprekken in feite samengevoegd tot één enkel gesprek. De call_id van een van de twee gesprekken wordt dan gebruikt voor het gesprek na de transfer. De andere call_id wordt opgenomen in de transfer als de merged_id en wordt daarna verwijderd.

• call_id: Een unieke string om het gesprek te identificeren, overgenomen van een van de vorige gesprekken.
• merged_id: De call_id van het andere vorige gesprek, die niet langer zal worden gebruikt.
• timestamp: De datum en tijd waarop de webhook wordt gegenereerd, in ISO 8601-formaat.
• status: De status van het gesprek. Voor dit type notificatie is dit transfer.
• version: Een versie-attribuut dat in de toekomst kan worden gebruikt om te migreren naar een andere versie van de webhooks. Momenteel is dit altijd v2.
• direction: Of een gesprek inkomend (inbound) of uitgaand (outbound) is. Gesprekken tussen collega's worden gemarkeerd als outbound.
• caller: Informatie over de beller.
• number: Het telefoonnummer dat de beller gebruikt.
• name: De naam van de beller.
• account_number: Het interne nummer van het VoIP-account (indien beschikbaar, voor inkomende gesprekken is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (indien beschikbaar, kan een lege array zijn).
• user_emails: De e-mailadressen van de gebruikers.
• destination: Informatie over waar het gesprek naartoe gaat.
• number: Het telefoonnummer dat de beller heeft gekozen.
• targets: De toestellen die overgaan voor dit gesprek. Toestellen die niet bereikbaar zijn, worden niet weergegeven.
• number: Het nummer dat wordt gebeld. Dit is meestal hetzelfde als destination.number, maar het kan veranderen als het gesprek wordt doorgeschakeld.
• name: De naam van de persoon die wordt gebeld. Voor inkomende gesprekken is dit bijna altijd null.
• account_number: De interne nummers van de gebruikers die hun VoIP-account hebben ingesteld om bereikbaar te zijn (indien beschikbaar, kan een lege array zijn).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (indien beschikbaar, kan een lege array zijn).
• user_emails: De e-mailadressen van de gebruikers.
• redirector: Informatie over de deelnemer die de transfer heeft uitgevoerd.
• number: Het telefoonnummer dat de doorverbinder gebruikt.
• name: De naam van de doorverbinder.
• account_number: Het interne nummer van het VoIP-account (indien beschikbaar, voor inkomende gesprekken is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (indien beschikbaar, kan een lege array zijn).
• user_emails: De e-mailadressen van de gebruikers.

Koude transfer

Een cold-transfer notificatie wordt verzonden wanneer een gesprek koud wordt doorverbonden. Bij een koude transfer belt de doorverbinder de nieuwe deelnemer, maar verbindt het gesprek door zonder te wachten om te zien of of wie er opneemt.

Er zijn twee belangrijke verschillen tussen een cold-transfer en een warm-transfer:

• Bij een warme transfer is er altijd één gebelde partij, terwijl er bij een koude transfer meerdere kunnen zijn (bijvoorbeeld als het gesprek wordt doorverbonden naar een belgroep).
• Voor een warme transfer worden eerst ringing en in-progress notificaties gegenereerd. Bij een koude transfer wordt alleen een ringing notificatie verzonden, en een in-progress notificatie volgt alleen als de derde partij het gesprek opneemt.

Het gesprek van de doorschakelaar naar de derde partij genereert ook een ringing notificatie met een eigen call_id. Tijdens een transfer worden deze twee gesprekken in feite samengevoegd tot één enkel gesprek. Het call_id van één van de twee gesprekken wordt dan gebruikt voor het gesprek na de transfer. Het andere call_id wordt opgenomen in de transfer als merged_id en wordt vervolgens verwijderd.

• call_id: Een unieke string om het gesprek te identificeren, overgenomen van één van de vorige gesprekken.
• merged_id: Het call_id van het andere vorige gesprek, dat niet langer zal worden gebruikt.
• timestamp: De datum en het tijdstip waarop de webhook wordt gegenereerd, in ISO 8601-formaat.
• status: De status van het gesprek. Voor dit type notificatie is dit transfer.
• version: Een versie-attribuut dat in de toekomst gebruikt kan worden om te migreren naar een andere versie van de webhooks. Momenteel is dit altijd v2.
• direction: Of een gesprek inkomend of uitgaand is. Momenteel worden enkel inkomende gesprekken ondersteund, dus deze waarde is altijd inbound.
• caller: Informatie over de beller.
• number: Het telefoonnummer dat de beller gebruikt.
• name: De naam van de beller.
• account_number: Het interne nummer van het VoIP-account (indien beschikbaar, voor inkomende gesprekken is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (indien beschikbaar, kan een lege array zijn).
• user_emails: De e-mailadressen van de gebruikers.
• destination: Informatie over waar het gesprek naartoe gaat.
• number: Het telefoonnummer dat de beller heeft gebeld.
• targets: De toestellen die overgaan voor dit gesprek. Toestellen die niet bereikbaar zijn, worden niet getoond.
• number: Het nummer dat wordt gebeld. Dit is meestal hetzelfde als destination.number, maar het kan veranderen als het gesprek wordt doorgeschakeld.
• name: De naam van de persoon die wordt gebeld. Voor inkomende gesprekken is dit bijna altijd null.
• account_number: De interne nummers van de gebruikers die hun VoIP-account hebben ingesteld om bereikbaar te zijn (indien beschikbaar, kan een lege array zijn).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (indien beschikbaar, kan een lege array zijn).
• user_emails: De e-mailadressen van de gebruikers.
• redirector: Informatie over de deelnemer die de transfer heeft uitgevoerd.
• number: Het telefoonnummer dat de doorschakelaar gebruikt.
• name: De naam van de doorschakelaar.
• account_number: Het interne nummer van het VoIP-account (indien beschikbaar, voor inkomende gesprekken is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (indien beschikbaar, kan een lege array zijn).
• user_emails: De e-mailadressen van de gebruikers.

Ophangen (ended)

Een ended notificatie wordt verstuurd wanneer een gesprek wordt beëindigd. Er zijn verschillende redenen waarom een gesprek kan eindigen.

Een ended notificatie kan worden verstuurd na een in-progress notificatie als het gesprek werd opgehangen door één van de deelnemers, na een ringing notificatie als niemand heeft opgenomen, of als enige notificatie indien geen toestellen bereikbaar waren.

• call_id: Een unieke string om het gesprek te identificeren.
• timestamp: De datum en het tijdstip waarop de webhook wordt gegenereerd, in ISO 8601-formaat.
• status: De status van het gesprek. Voor dit type notificatie is dit ended.
• reason: De reden waarom het gesprek eindigde. De reden kan één van de volgende waarden zijn:
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: Een versie-attribuut dat in de toekomst gebruikt kan worden om te migreren naar een andere versie van de webhooks. Momenteel is dit altijd v2.
• direction: Of een gesprek inkomend (inbound) of uitgaand (outbound) is. Gesprekken tussen collega's worden gemarkeerd als outbound.
• caller: Informatie over de beller.
• number: Het telefoonnummer dat de beller gebruikt.
• name: De naam van de beller.
• account_number: Het interne nummer van het VoIP-account (indien beschikbaar, voor inkomende gesprekken is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (indien beschikbaar, kan een lege array zijn).
• user_emails: De e-mailadressen van de gebruikers.
• destination: Informatie over waar het gesprek naartoe gaat.
• number: Het telefoonnummer dat de beller heeft gebeld.

Voor elk gesprek worden meerdere notificaties verstuurd. Welke notificaties worden verzonden, hangt af van hoe het gesprek wordt afgehandeld. Hieronder vind je de volgorde van notificaties voor de meest voorkomende soorten gesprekken.

Eenvoudig gesprek

Een succesvol gesprek met twee deelnemers:

• ringing - A belt B
• in-progress - A belt B
• ended - A belt B (reden: completed)

Geen antwoord

De telefoon van de gebelde persoon gaat over maar wordt niet opgenomen.

• ringing - A belt B
• ended - A belt B (reden: busy of no-answer afhankelijk van het toestel)

Gebelde persoon niet bereikbaar

De gebelde persoon is niet bereikbaar (bijvoorbeeld wanneer de telefoon op Niet storen staat), waardoor de telefoon niet overgaat en het gesprek niet wordt beantwoord.

• ended - A belt B (reden: busy)

Attended Transfer

Bij een attended transfer (warme transfer) belt A eerst naar B, waarna een van de deelnemers het gesprek doorverbindt naar C. De deelnemer belt eerst met C, en na een gesprek wordt het gesprek doorverbonden. Enkel deelnemers A en C blijven in het gesprek.

• ringing - A belt B
• in-progress - A belt B
• ringing - B belt C
• in-progress - B belt C
• warm-transfer - B verbindt A en C
• ended - A en C hangen op (reden: completed)

Blind transfer

Bij een blind transfer (koude transfer) belt A eerst naar B, waarna een van de deelnemers het gesprek doorverbindt naar C zonder te wachten of C beschikbaar is.

• ringing - A belt B
• in-progress - A belt B
• ringing - B belt C
• cold-transfer - B verbindt A en C
• in-progress - A belt C
• ended - A belt C niet meer (reden: completed)

Semi-attended transfer

Bij een semi-attended transfer (lauwe transfer) belt A eerst naar B, waarna een van de deelnemers het gesprek doorverbindt naar C. De deelnemer probeert eerst C te bellen maar verbindt het gesprek door voordat C opneemt.

• ringing - A belt B
• in-progress - A belt B
• ringing - B belt C
• cold-transfer - B verbindt A en C
• in-progress - A belt C
• ended - A belt C niet meer (reden: completed)

Gesprek overnemen

Wanneer twee toestellen zich in dezelfde PickupGroup bevinden, is het mogelijk om vanaf één toestel een gesprek over te nemen dat voor een ander toestel bedoeld is.

• ringing - A belt B
• in-progress - A belt C
• ended - A belt C niet meer (reden: completed)

Doorschakelen

Wanneer een gebruiker zijn of haar telefoon zo instelt dat inkomende gesprekken automatisch worden doorgeschakeld naar een ander nummer.

• ringing - A belt B
• ringing - A belt B & C
• in-progress of ended, afhankelijk van of iemand opneemt.

• Ga naar Gespreksnotificaties.
• Klik op Toevoegen.
• Vul een beschrijving in het veld Beschrijving in om het doel van de notificatie te specificeren.
• Kies 'Custom' bij de Package opties, tenzij je liever een standaardoptie gebruikt.
• Vul de URL in waar de gespreksnotificaties naartoe gestuurd moeten worden.
• Vul het API token in als je geselecteerde package er één voorziet.

Opmerking: dit is enkel vereist als je package een API token uitgeeft.

• Klik op Opslaan.

Hieronder vind je enkele voorbeelden van integraties in combinatie met Zapier:

• Stuur een bericht naar Slack bij een gemiste oproep.
• Stuur een e-mail bij een gemiste oproep.
• Robin integratie.
• Microsoft Flow integratie
• Zapier integratie

En een voorbeeld met N8N en onze API voor gesprekstranscriptie

Gesprekstranscripties automatisch ophalen met N8N