Gespreksnotificaties

Tijdens een gesprek wordt op zes verschillende momenten informatie verstuurd naar de opgegeven URL voor inkomende, interne en uitgaande gesprekken: Aangemaakt, Overgaat, Beantwoord, Warm doorverbinden, Koud doorverbinden en Ophangen. Notificaties worden verstuurd naar de opgegeven URL bij verschillende belangrijke gebeurtenissen tijdens een gesprek. De notificaties worden verzonden als POST-verzoek met de data in een JSON-document. Hieronder lees je welke informatie er precies wordt verstuurd.

Aangemaakt

Een created-gebeurtenis wordt verstuurd wanneer een inkomende oproep 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 alleen 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 verstuurd bij de created-gebeurtenis.
• user_numbers: Deze informatie wordt niet verstuurd bij de created-gebeurtenis.
• user_emails: Deze informatie wordt niet verstuurd bij de created-gebeurtenis.
• destination: Informatie over waar het gesprek naartoe gaat.
• number: Het telefoonnummer dat de beller heeft gebeld.

Overgaat

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

Het kan voorkomen dat er 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 verstuurd bij de ringing-gebeurtenis.
• user_numbers: Deze informatie wordt niet verstuurd bij de ringing-gebeurtenis.
• user_emails: Deze informatie wordt niet verstuurd bij de ringing-gebeurtenis.
• destination: Informatie over waar het gesprek naartoe gaat.
• number: Het telefoonnummer dat de beller heeft gebeld.
• targets: De telefoons die rinkelen voor dit gesprek. Telefoons die onbereikbaar 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 degene die wordt gebeld. Bij inkomende gesprekken is dit bijna altijd null.
• account_number: De interne nummers van de gebruikers die hun VoIP-account bereikbaar hebben ingesteld (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.

Beantwoord (in-progress)

Een in-progress-notificatie wordt verstuurd wanneer een gesprek wordt beantwoord.

Let op! De target die het gesprek beantwoordt is niet altijd een van de toestellen die aanvankelijk rinkelden. Door call pickup kan het gebeuren dat het gesprek op een ander toestel wordt beantwoord.

• 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 in-progress.
• 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, bij 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 telefoons die overgaan voor dit gesprek. Telefoons die niet bereikbaar zijn, worden niet getoond.
• number: Het nummer dat gebeld wordt. Dit is meestal hetzelfde als destination.number, maar kan veranderen als het gesprek wordt doorgeschakeld.
• name: De naam van de persoon die gebeld wordt. Bij inkomende gesprekken is dit bijna altijd null.
• account_number: De interne nummers van de gebruikers die hun VoIP-account bereikbaar hebben ingesteld (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 transfer

Een warm-transfer notificatie wordt verstuurd als een gesprek 'warm' wordt getransfereerd. Bij een warm transfer belt de doorverbinder eerst de nieuwe deelnemer, de nieuwe deelnemer neemt op, spreekt met de doorverbinder, en dan wordt het gesprek doorverbonden.

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

• call_id: Een unieke string om het gesprek te identificeren, overgenomen van een van de eerdere gesprekken.
• merged_id: Het call_id van het andere eerdere gesprek, dat niet langer gebruikt wordt.
• 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 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, bij 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 telefoons die overgaan voor dit gesprek. Telefoons die niet bereikbaar zijn, worden niet getoond.
• number: Het nummer dat gebeld wordt. Dit is meestal hetzelfde als destination.number, maar kan veranderen als het gesprek wordt doorgeschakeld.
• name: De naam van de persoon die gebeld wordt. Bij inkomende gesprekken is dit bijna altijd null.
• account_number: De interne nummers van de gebruikers die hun VoIP-account bereikbaar hebben ingesteld (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, bij 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.

Cold transfer

Een cold-transfer notificatie wordt verstuurd als een gesprek cold wordt getransfereerd. Bij een cold transfer belt de doorverbinder de nieuwe deelnemer maar verbindt het gesprek door zonder te wachten 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 alleen een ringing notificatie verstuurd, en een in-progress notificatie volgt alleen als de derde partij het gesprek opneemt.

Het gesprek van de doorschakeler 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 in de transfer opgenomen als de merged_id en wordt daarna 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 meer gebruikt wordt.
• 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 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 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 (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 gaat.
• number: Het telefoonnummer dat de beller heeft gekozen.
• 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 bereikbaar hebben ingesteld (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 doorschakeler gebruikt.
• name: De naam van de doorschakeler.
• 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 door een van de deelnemers is 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 notificatietype is dit ended.
• reason: De reden waarom het gesprek is beëindigd. De reden kan een 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 (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 gaat.
• number: Het telefoonnummer dat de beller heeft gekozen.

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

Simpel gesprek

Een succesvol gesprek met twee deelnemers:

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

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 niet bereikbaar

De gebelde persoon is niet bereikbaar (bijvoorbeeld omdat de telefoon op Niet storen staat), dus de telefoon gaat niet over en het gesprek wordt niet opgenomen.

• ended - A belt B (reden: busy)

Attended Transfer

Bij een attended transfer (warme doorverbinding) belt A eerst B, waarna een van de deelnemers het gesprek doorverbindt naar C. De deelnemer belt eerst C, en na onderling overleg wordt het gesprek doorverbonden. Alleen deelnemers A en C blijven in 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 door
• ended - A en C hangen op (reden: completed)

Blind transfer

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

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

Semi-attended transfer

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

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

Call Pickup

Wanneer twee telefoons in dezelfde pickup group staan, kun je een gesprek dat voor een andere telefoon bedoeld is, vanaf een andere telefoon overnemen.

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

Doorschakelen

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

• 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 omschrijving in bij Omschrijving om aan te geven waar de notificatie voor bedoeld is.
• Kies 'Custom' bij Package, tenzij je liever een standaardoptie gebruikt.
• Vul de URL in waar de gespreksnotificaties naartoe gestuurd moeten worden.
• Vul het API token in als je gekozen package er een aanbiedt.

Let op: dit is alleen nodig als je package een API token uitgeeft.

• Klik op Opslaan.

Hieronder een paar 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 call transcription API

Gesprekstranscripties automatisch ophalen met N8N