Gespreksnotificaties

• Call notifications_send_summary_events: Als je dit vakje aanvinkt, worden gesprekssamenvattingen meegestuurd met de gespreksnotificaties. Let op: Intelligence moet hiervoor ingeschakeld zijn.
• Call notifications_send_transcription_events: Als je dit vakje aanvinkt, worden gesprekstranscripties meegestuurd met de gespreksnotificaties. Let op: Intelligence moet hiervoor ingeschakeld zijn.
• Beschrijving: Geef deze gespreksnotificatie een naam die je meteen herkent. Alleen je team ziet deze naam, 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 versturen.
• Web hook URL: Plak de volledige webhook-URL, inclusief https://, waarnaar je deze notificaties wilt versturen.

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 kun je lezen welke informatie er precies wordt verzonden.

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 type notificatie is dit created.
• version: Een versie-attribuut dat in de toekomst kan worden gebruikt om naar een andere versie van de webhooks te migreren. Momenteel is dit altijd v2.
• direction: Of een gesprek inkomend (inbound) of uitgaand (outbound) is. De created gebeurtenis wordt alleen verzonden 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 verzonden bij de created gebeurtenis.
• user_numbers: Deze informatie wordt niet verzonden bij de created gebeurtenis.
• user_emails: Deze informatie wordt niet verzonden bij de created gebeurtenis.
• destination: Informatie over waar het gesprek naartoe wordt geleid.
• number: Het telefoonnummer dat de beller heeft gekozen.

Ringing

Een ringing notificatie wordt verzonden wanneer telefoons beginnen te rinkelen als gevolg van een inkomend gesprek.

Het is mogelijk dat meerdere ringing notificaties achter elkaar worden verzonden naarmate 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 type notificatie is dit ringing.
• version: Een versie-attribuut dat in de toekomst kan worden gebruikt om naar een andere versie van de webhooks te migreren. 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 verzonden bij de ringing gebeurtenis.
• user_numbers: Deze informatie wordt niet verzonden bij de ringing gebeurtenis.
• user_emails: Deze informatie wordt niet verzonden bij de ringing gebeurtenis.
• destination: Informatie over waar het gesprek naartoe wordt geleid.
• number: Het telefoonnummer dat de beller heeft gekozen.
• targets: De telefoons die rinkelen voor dit gesprek. 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 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 (waar beschikbaar, kan een lege array zijn).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (waar 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 aanvankelijk overging. Door call pickup 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 (waar beschikbaar, voor inkomende oproepen is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (waar 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 toestellen die overgaan voor deze oproep. 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 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 (waar beschikbaar, kan een lege array zijn).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (waar beschikbaar, kan een lege array zijn).
• user_emails: De e-mailadressen van de gebruikers.

Warme transfer

Een warm-transfer notificatie wordt verstuurd wanneer een oproep "warm" wordt doorverbonden. Bij een warme transfer 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 transfer 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 transfer. 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 (waar beschikbaar, voor inkomende oproepen is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (waar 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 toestellen die overgaan voor deze oproep. 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 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 (waar beschikbaar, kan een lege array zijn).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (waar 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 (waar beschikbaar, voor inkomende oproepen is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (waar 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 koud wordt doorverbonden. Bij een cold transfer belt de doorverbinder de nieuwe deelnemer op maar verbindt het gesprek door zonder te wachten om te zien of en wie er 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 een in-progress notificatie volgt alleen als de derde partij het gesprek opneemt.

Het gesprek van de doorverbinder naar de derde partij genereert ook een ringing notificatie met zijn eigen call_id. Tijdens een transfer worden deze twee gesprekken in essentie samengevoegd tot één enkel gesprek. De call_id van één van de twee gesprekken wordt dan gebruikt voor het gesprek na de transfer. De andere call_id wordt in de transfer opgenomen als de 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: De call_id van het andere vorige gesprek, die niet langer wordt gebruikt.
• 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 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 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 (waar beschikbaar, voor inkomende gesprekken is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (waar 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 gekozen.
• targets: De toestellen die voor dit gesprek rinkelen. Toestellen die onbereikbaar 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 (waar beschikbaar, kan een lege array zijn).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (waar 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 redirector gebruikt.
• name: De naam van de redirector.
• account_number: Het interne nummer van het VoIP-account (waar beschikbaar, voor inkomende gesprekken is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (waar 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 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 notificatietype is dit ended.
• reason: De reden waarom het gesprek is beëindigd. De reden kan één van de volgende waarden zijn:
1. completed: Het gesprek werd succesvol afgerond.
2. busy: Het gesprek werd afgewezen, de gebelde partij was in gesprek.
3. no-answer: Niemand heeft het gesprek opgenomen om verschillende redenen.
4. failed: Er is een fout opgetreden waardoor het gesprek niet kon worden tot stand gebracht.
5. cancelled: De beller heeft opgehangen voordat iemand kon opnemen.
6. abandon: De beller heeft opgehangen terwijl hij 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 (waar beschikbaar, voor inkomende oproepen is dit bijna altijd null).
• user_numbers: De interne nummers van de gebruikers die bereikbaar zijn (waar 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.

Transcriptie aangemaakt

Een call_transcription notificatie wordt verstuurd wanneer de transcriptie klaar is.

Als Voys Intelligence is ingeschakeld, is dit de eerste gebeurtenis die volgt op een ended notificatie. Als gesprekssamenvatting is ingeschakeld, zal de summary gebeurtenis snel 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, is dit de laatste gebeurtenis voor een specifiek gesprek.

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

Voor elk gesprek worden meerdere notificaties verstuurd. Welke notificaties worden verstuurd, hangt af 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

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 omdat de telefoon op Niet storen staat), waardoor de telefoon niet overgaat en het gesprek niet wordt opgenomen.

• ended - A belt B (reden: busy)

Attended Transfer

Bij een attended transfer (warme doorverbinding) belt A eerst B, waarna één 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 doorverbinding) belt A eerst B, waarna één van de deelnemers het gesprek doorverbindt naar C zonder te wachten om te zien of C bereikbaar 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)
• call_transcription - transcriptie van het gesprek is klaar
• summary - samenvatting van het gesprek is klaar

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)
• call_transcription - transcriptie van het gesprek is klaar
• summary - samenvatting van het gesprek is klaar

Call Pickup

Wanneer twee telefoons in dezelfde pickup group zitten, is het mogelijk om vanuit de ene telefoon een oproep die bedoeld is voor de andere telefoon op te nemen.

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

Doorschakelen

Wanneer een gebruiker zijn of haar telefoon zo instelt dat inkomende oproepen 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.
• call_transcription - transcriptie van het gesprek is klaar
• summary - samenvatting van het gesprek is klaar