Gespreksnotificaties

• Beschrijving: Geef deze gespreksnotificatie een naam die je meteen herkent. Enkel jouw team ziet dit, nooit de beller.
• Service: Kies waar deze notificatie naartoe gaat: selecteer Custom om het zelf in te stellen, of Robin om het rechtstreeks naar de Robin integratie te sturen.
• Web hook URL: Plak de volledige webhook-URL, inclusief https://, waar je deze notificaties naartoe wilt sturen.

• Call notifications_send_summary_events: Als je dit vakje aanvinkt, worden gesprekssamenvattingen meegestuurd met de gespreksnotificaties. Opgelet: Intelligence moet hiervoor ingeschakeld zijn.
• Call notifications_send_transcription_events: Als je dit vakje aanvinkt, worden gesprekstranscripties meegestuurd met de gespreksnotificaties. Opgelet: Intelligence moet hiervoor ingeschakeld zijn.

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

Created

Een created gebeurtenis wordt geactiveerd wanneer een inkomend gesprek wordt gestart.

• call_id: Een unieke string om het gesprek te identificeren.
• timestamp: De datum en tijd waarop de webhook wordt gegenereerd, in ISO 8601 formaat.
• status: De status van het gesprek. Voor dit notificatietype is dit created.
• 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. De created gebeurtenis wordt enkel verstuurd voor inkomende gesprekken.
• caller: Informatie over de beller.
• number: Het telefoonnummer dat de beller gebruikt.
• name: De naam van de beller.
• account_number: Deze informatie wordt niet meegestuurd met de created gebeurtenis.
• user_numbers: Deze informatie wordt niet meegestuurd met de created gebeurtenis.
• user_emails: Deze informatie wordt niet meegestuurd met de created gebeurtenis.
• destination: Informatie over waar het gesprek naartoe wordt geleid.
• number: Het telefoonnummer dat de beller heeft gebeld.

Ringing

Een ringing notificatie wordt verstuurd wanneer telefoons beginnen te rinkelen door een inkomend gesprek.

Het is mogelijk dat meerdere ringing notificaties achter elkaar worden verstuurd wanneer nieuwe toestellen beginnen te rinkelen.

• call_id: Een unieke string om het gesprek te identificeren.
• timestamp: De datum en tijd waarop de webhook wordt gegenereerd, in ISO 8601 formaat.
• status: De status van het gesprek. Voor dit notificatietype is dit ringing.
• 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: Deze informatie wordt niet meegestuurd met de ringing gebeurtenis.
• user_numbers: Deze informatie wordt niet meegestuurd met de ringing gebeurtenis.
• user_emails: Deze informatie wordt niet meegestuurd met de ringing gebeurtenis.
• destination: Informatie over waar het gesprek naartoe wordt geleid.
• number: Het telefoonnummer dat de beller heeft gebeld.
• targets: De telefoons die rinkelen voor dit gesprek. Telefoons die niet bereikbaar zijn, worden niet getoond.
• number: Het nummer dat wordt gebeld. Dit is meestal hetzelfde als destination.number, maar 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.

Opgenomen (bezig)

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

Let op! Het target dat de oproep opneemt is niet altijd één van de toestellen die oorspronkelijk overging. Door het opnemen van oproepen kan het gebeuren dat de oproep op een ander toestel 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 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: Het interne nummer van het VoIP-account (indien beschikbaar, voor inkomende oproepen 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 de oproep naartoe gaat.
• number: Het telefoonnummer dat de beller heeft gebeld.
• targets: De telefoons die overgaan voor deze oproep. Telefoons die onbereikbaar zijn worden niet getoond.
• 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 bereikbaar hebben gemaakt (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.

Warm doorverbinden

Een warm-transfer notificatie wordt verstuurd wanneer een oproep "warm" wordt doorverbonden. Bij een warm doorverbinden belt de doorverbinder eerst de nieuwe deelnemer, de nieuwe deelnemer neemt op, spreekt met de doorverbinder en daarna wordt de oproep doorverbonden.

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

• call_id: Een unieke string om de oproep te identificeren, overgenomen van één van de vorige oproepen.
• merged_id: De call_id van de andere vorige oproep, die niet langer zal worden gebruikt.
• 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 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 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: Het interne nummer van het VoIP-account (indien beschikbaar, voor inkomende oproepen 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 de oproep naartoe gaat.
• number: Het telefoonnummer dat de beller heeft gebeld.
• targets: De telefoons die overgaan voor deze oproep. Telefoons die onbereikbaar zijn worden niet getoond.
• 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 bereikbaar hebben gemaakt (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 doorverbinding 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 oproepen 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.

Cold transfer

Een cold-transfer notificatie wordt verstuurd wanneer een gesprek cold wordt doorverbonden. Bij een cold transfer belt de doorverbinder de nieuwe deelnemer op, maar verbindt het gesprek door zonder te wachten of er iemand opneemt.

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

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

Het gesprek van de doorverbinder 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 gesprek. De call_id van één 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 vervolgens niet meer gebruikt.

• call_id: Een unieke string om het gesprek te identificeren, overgenomen van één 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 of uitgaand is. Momenteel worden alleen 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 wordt geleid.
• 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 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.

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 door één van de deelnemers werd opgehangen, na een ringing notificatie als niemand heeft opgenomen, of als enige notificatie als er geen toestellen bereikbaar waren.

• call_id: Een unieke string om het gesprek te identificeren.
• 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 ended.
• reason: De reden waarom het gesprek eindigde. De reden kan één van de volgende waarden zijn:
1. completed: Het gesprek werd succesvol voltooid.
2. busy: Het gesprek werd geweigerd, de gebelde persoon was in gesprek.
3. no-answer: Niemand heeft het gesprek beantwoord om verschillende redenen.
4. failed: Er is een fout opgetreden waardoor het gesprek niet tot stand kon komen.
5. cancelled: De beller heeft opgehangen voordat iemand kon opnemen.
6. abandon: De beller heeft opgehangen terwijl deze in de wachtrij stond.
• 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 oproepen 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 de oproep naartoe gaat.
• number: Het telefoonnummer dat de beller heeft gebeld.

Transcriptie aangemaakt

Een call_transcription notificatie wordt verstuurd wanneer de transcriptie klaar is.

Als Voys Intelligence is ingeschakeld. Dit is de eerste gebeurtenis die volgt op een ended notificatie. Als gesprekssamenvattingen zijn ingeschakeld, zal de summary gebeurtenis binnenkort volgen.

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

Samenvatting aangemaakt

Een summary notificatie wordt verstuurd wanneer de gesprekssamenvatting klaar is.

Als Voys Intelligence is ingeschakeld. Dit is de laatste gebeurtenis voor een specifieke oproep.

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

Gespreksopname aangemaakt

Een call recording created gebeurtenis wordt verstuurd zodra een opname van een gesprek beschikbaar is.

De inhoud van de gebeurtenis ziet er als volgt uit:

{
"call_id": "ua0-grq-prd-1741083170.160935",
"recording_url": "https://api.voys.nl/api/v2/clients/9f515223-c139-4704-a031-57342c8809a4/callrecordings/ua0-grq-prd-1741083170.160935/audio"
}

Je kunt recording_url rechtstreeks gebruiken om de opname op te halen met je API-sleutel. Je hoeft de URL niet zelf op te bouwen of je klant-ID op te zoeken.

Voor elk gesprek worden meerdere notificaties verstuurd. De verzonden notificaties zijn afhankelijk van hoe het gesprek wordt afgehandeld. Hieronder vind je de volgorde van notificaties voor de meest voorkomende types gesprekken.

Eenvoudig gesprek

Een geslaagd gesprek met twee deelnemers:

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

Eenvoudig gesprek met Voys Intelligence ingeschakeld

Een geslaagd gesprek met twee deelnemers:

• ringing - A belt B
• in-progress - A belt B
• ended - A belt B (reden: completed)
• call_transcription - transcriptie van het gesprek is klaar
• summary - samenvatting van het gesprek is klaar

Niet opgenomen

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 beschikbaar

De gebelde persoon is niet beschikbaar (bijvoorbeeld, de telefoon staat op Niet storen), waardoor de telefoon niet overgaat en de oproep niet wordt opgenomen.

• ended - A belt B (reden: busy)

Attended Transfer

Bij een attended transfer (warme transfer) belt A eerst B, waarna een van de deelnemers het gesprek doorverbindt naar C. De deelnemer belt eerst C, en nadat ze hebben gesproken, wordt het gesprek doorverbonden. Alleen 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)
• call_transcription - transcriptie van het gesprek is klaar (één per gespreksdeel, indien ingeschakeld)
• summary - samenvatting van het gesprek is klaar (één per gespreksdeel, indien ingeschakeld)

Blind transfer

Bij een blind transfer (koude transfer) belt A eerst B, waarna een van de deelnemers het gesprek doorverbindt naar C zonder te wachten om te zien 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 langer (reden: completed)
• call_transcription - transcriptie van het gesprek is klaar
• summary - samenvatting van het gesprek is klaar

Semi-attended transfer

Bij een semi-attended transfer (lauwwarme transfer) belt A eerst naar B, waarna een van de deelnemers het gesprek doorzet naar C. De deelnemer probeert eerst C te bellen maar zet 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 langer (reden: completed)
• call_transcription - transcriptie van het gesprek is klaar
• summary - samenvatting van het gesprek is klaar

Call Pickup

Wanneer twee toestellen in dezelfde PickupGroup zitten, is het mogelijk om vanaf het ene toestel een oproep over te nemen die bedoeld is voor het andere toestel.

• ringing - A belt B
• in-progress - A belt C
• ended - A belt C niet langer (reden: completed)
• call_transcription - transcriptie van het gesprek is klaar
• summary - samenvatting van het gesprek is klaar

Doorschakelen

Wanneer een gebruiker zijn toestel instelt om inkomende oproepen automatisch door te schakelen naar een ander nummer.

• ringing - A belt B
• ringing - A belt B & C
• in-progress of ended, afhankelijk van of iemand opneemt.
• call_transcription - transcriptie van het gesprek is klaar
• summary - samenvatting van het gesprek is klaar

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

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

En een voorbeeld met N8N en onze API voor gespreksopnames

n8n: gespreksopnames, transcripties en samenvattingen bijhouden