Notifications d'appel

• Description : Donnez à cette notification d'appel un nom que vous reconnaîtrez en un coup d'œil. Seul votre équipe le voit, jamais l'appelant.
• Service : Choisissez où cette notification doit être envoyée : sélectionnez Personnalisé pour la configurer vous-même, ou Robin pour l'envoyer directement à l'intégration Robin.
• URL du webhook : Collez l'URL complète du webhook, y compris https://, où vous souhaitez que ces notifications soient envoyées.

• Call notifications_send_summary_events : Si vous cochez cette case, les résumés d'appel seront inclus avec les notifications d'appel. Veuillez noter : Intelligence doit être activé pour que cela fonctionne.
• Call notifications_send_transcription_events : Si vous cochez cette case, les transcriptions d'appel seront incluses avec les notifications d'appel. Veuillez noter : Intelligence doit être activé pour que cela fonctionne.

Pendant un appel, les informations sont envoyées à l'URL spécifiée à six moments différents pour les appels entrants, internes et sortants : Créé, Sonnerie, Répondu, Transfert accompagné, Transfert direct et Raccroché. Les notifications sont envoyées à l'URL spécifiée lors de divers événements importants au cours d'un appel. Les notifications sont envoyées sous forme de requête POST avec les données dans un document JSON. Ci-dessous, vous pouvez lire quelles informations sont exactement envoyées.

Créé

Un événement created est déclenché lorsqu'un appel entrant est initié.

• call_id : Une chaîne unique pour identifier l'appel.
• timestamp : La date et l'heure de génération du webhook, au format ISO 8601.
• status : Le statut de l'appel. Pour ce type de notification, il s'agit de created.
• version : Un attribut de version qui peut être utilisé à l'avenir pour migrer vers une autre version des webhooks. Actuellement, il s'agit toujours de v2.
• direction : Si un appel est entrant (inbound) ou sortant (outbound). L'événement créé est uniquement envoyé pour les appels entrants.
• caller : Informations sur l'appelant.
• number : Le numéro de téléphone que l'appelant utilise.
• name : Le nom de l'appelant.
• account_number : Cette information n'est pas envoyée avec l'événement created.
• user_numbers : Cette information n'est pas envoyée avec l'événement created.
• user_emails : Cette information n'est pas envoyée avec l'événement created.
• destination : Informations sur la destination de l'appel.
• number : Le numéro de téléphone composé par l'appelant.

Sonnerie

Une notification ringing est envoyée lorsque les téléphones commencent à sonner en raison d'un appel entrant.

Il est possible que plusieurs notifications ringing soient envoyées successivement au fur et à mesure que de nouveaux appareils commencent à sonner.

• call_id : Une chaîne unique pour identifier l'appel.
• timestamp : La date et l'heure de génération du webhook, au format ISO 8601.
• status : Le statut de l'appel. Pour ce type de notification, il s'agit de ringing.
• version : Un attribut de version qui peut être utilisé à l'avenir pour migrer vers une autre version des webhooks. Actuellement, il s'agit toujours de v2.
• direction : Si un appel est entrant (inbound) ou sortant (outbound). Les appels entre collègues sont marqués comme outbound.
• caller : Informations sur l'appelant.
• number : Le numéro de téléphone que l'appelant utilise.
• name : Le nom de l'appelant.
• account_number : Cette information n'est pas envoyée avec l'événement ringing.
• user_numbers : Cette information n'est pas envoyée avec l'événement ringing.
• user_emails : Cette information n'est pas envoyée avec l'événement ringing.
• destination : Informations sur la destination de l'appel.
• number : Le numéro de téléphone composé par l'appelant.
• targets : Les téléphones qui sonnent pour cet appel. Les téléphones injoignables ne sont pas affichés.
• number : Le numéro qui est appelé. Il s'agit généralement du même numéro que destination.number, mais peut changer si l'appel est redirigé.
• name : Le nom de la personne appelée. Pour les appels entrants, il s'agit presque toujours de null.
• account_number : Les numéros internes des utilisateurs qui ont configuré leur Compte VoIP pour être joignables (lorsque disponible, peut être un tableau vide).
• user_numbers : Les numéros internes des utilisateurs qui sont joignables (lorsque disponible, peut être un tableau vide).
• user_emails : Les adresses e-mail des utilisateurs.

Répondu (en cours)

Une notification in-progress est envoyée lorsqu'un appel reçoit une réponse.

Remarque : la target qui répond à l'appel n'est pas toujours l'un des appareils qui ont initialement sonné. En raison de la prise d'appel, il peut arriver que l'appel soit répondu sur un appareil différent.

• call_id : Une chaîne unique pour identifier l'appel.
• timestamp : La date et l'heure auxquelles le webhook est généré, au format ISO 8601.
• status : Le statut de l'appel. Pour ce type de notification, il s'agit de in-progress.
• version : Un attribut de version qui peut être utilisé à l'avenir pour migrer vers une autre version des webhooks. Actuellement, il s'agit toujours de v2.
• direction : Indique si un appel est entrant (inbound) ou sortant (outbound). Les appels entre collègues sont marqués comme outbound.
• caller : Informations sur l'appelant.
• number : Le numéro de téléphone utilisé par l'appelant.
• name : Le nom de l'appelant.
• account_number : Le numéro interne du Compte VoIP (lorsque disponible, pour les appels entrants, il s'agit presque toujours de null).
• user_numbers : Les numéros internes des utilisateurs qui sont joignables (lorsque disponible, peut être un tableau vide).
• user_emails : Les adresses e-mail des utilisateurs.
• destination : Informations sur la destination de l'appel.
• number : Le numéro de téléphone composé par l'appelant.
• targets : Les téléphones qui sonnent pour cet appel. Les téléphones qui ne sont pas joignables ne sont pas affichés.
• number : Le numéro appelé. Il s'agit généralement du même que destination.number, mais il peut changer si l'appel est redirigé.
• name : Le nom de la personne appelée. Pour les appels entrants, il s'agit presque toujours de null.
• account_number : Les numéros internes des utilisateurs qui ont configuré leur Compte VoIP pour être joignables (lorsque disponible, peut être un tableau vide).
• user_numbers : Les numéros internes des utilisateurs qui sont joignables (lorsque disponible, peut être un tableau vide).
• user_emails : Les adresses e-mail des utilisateurs.

Transfert accompagné

Une notification warm-transfer est envoyée lorsqu'un appel est transféré de manière « accompagnée ». Dans un transfert accompagné, le transféreur appelle d'abord le nouveau participant, celui-ci répond, parle avec le transféreur, puis l'appel est transféré.

L'appel du transféreur vers le tiers génère également des notifications ringing et in-progress avec leur propre call_id. Lors d'un transfert, ces deux appels sont essentiellement fusionnés en un seul appel. Le call_id de l'un des deux appels est alors utilisé pour l'appel après le transfert. L'autre call_id est inclus dans le transfert en tant que merged_id puis abandonné.

• call_id : Une chaîne unique pour identifier l'appel, reprise de l'un des appels précédents.
• merged_id : Le call_id de l'autre appel précédent, qui ne sera plus utilisé.
• timestamp : La date et l'heure auxquelles le webhook est généré, au format ISO 8601.
• status : Le statut de l'appel. Pour ce type de notification, il s'agit de transfer.
• version : Un attribut de version qui peut être utilisé à l'avenir pour migrer vers une autre version des webhooks. Actuellement, il s'agit toujours de v2.
• direction : Indique si un appel est entrant (inbound) ou sortant (outbound). Les appels entre collègues sont marqués comme outbound.
• caller : Informations sur l'appelant.
• number : Le numéro de téléphone utilisé par l'appelant.
• name : Le nom de l'appelant.
• account_number : Le numéro interne du Compte VoIP (lorsque disponible, pour les appels entrants, il s'agit presque toujours de null).
• user_numbers : Les numéros internes des utilisateurs qui sont joignables (lorsque disponible, peut être un tableau vide).
• user_emails : Les adresses e-mail des utilisateurs.
• destination : Informations sur la destination de l'appel.
• number : Le numéro de téléphone composé par l'appelant.
• targets : Les téléphones qui sonnent pour cet appel. Les téléphones qui ne sont pas joignables ne sont pas affichés.
• number : Le numéro appelé. Il s'agit généralement du même que destination.number, mais il peut changer si l'appel est redirigé.
• name : Le nom de la personne appelée. Pour les appels entrants, il s'agit presque toujours de null.
• account_number : Les numéros internes des utilisateurs qui ont configuré leur Compte VoIP pour être joignables (lorsque disponible, peut être un tableau vide).
• user_numbers : Les numéros internes des utilisateurs qui sont joignables (lorsque disponible, peut être un tableau vide).
• user_emails : Les adresses e-mail des utilisateurs.
• redirector : Informations sur le participant qui a effectué le transfert.
• number : Le numéro de téléphone utilisé par le redirecteur.
• name : Le nom du redirecteur.
• account_number : Le numéro interne du Compte VoIP (lorsque disponible, pour les appels entrants, il s'agit presque toujours de null).
• user_numbers : Les numéros internes des utilisateurs qui sont joignables (lorsque disponible, peut être un tableau vide).
• user_emails : Les adresses e-mail des utilisateurs.

Transfert à froid

Une notification cold-transfer est envoyée lorsqu'un appel est transféré à froid. Dans un transfert à froid, le transféreur appelle le nouveau participant mais transfère l'appel sans attendre de voir si quelqu'un répond ou qui répond.

Il existe deux différences essentielles entre un cold-transfer et un warm-transfer :

• Dans un transfert à chaud, il y a toujours un seul destinataire, alors que dans un transfert à froid, il peut y en avoir plusieurs (par exemple, si l'appel est transféré vers un groupe d'appel).
• Pour un transfert à chaud, les notifications ringing et in-progress sont d'abord générées. Dans un transfert à froid, seule une notification ringing est envoyée, et une notification in-progress ne suit que si le tiers répond à l'appel.

L'appel du transféreur vers le tiers génère également une notification ringing avec son propre call_id. Lors d'un transfert, ces deux appels sont essentiellement fusionnés en un seul appel. Le call_id de l'un des deux appels est alors utilisé pour l'appel après le transfert. L'autre call_id est inclus dans le transfert en tant que merged_id et est ensuite abandonné.

• call_id : Une chaîne unique pour identifier l'appel, reprise de l'un des appels précédents.
• merged_id : Le call_id de l'autre appel précédent, qui ne sera plus utilisé.
• timestamp : La date et l'heure de génération du webhook, au format ISO 8601.
• status : Le statut de l'appel. Pour ce type de notification, il s'agit de transfer.
• version : Un attribut de version qui peut être utilisé à l'avenir pour migrer vers une autre version des webhooks. Actuellement, il est toujours v2.
• direction : Indique si un appel est entrant ou sortant. Actuellement, seuls les appels entrants sont pris en charge, cette valeur est donc toujours inbound.
• caller : Informations sur l'appelant.
• number : Le numéro de téléphone utilisé par l'appelant.
• name : Le nom de l'appelant.
• account_number : Le numéro interne du compte VoIP (lorsqu'il est disponible, pour les appels entrants, il s'agit presque toujours de null).
• user_numbers : Les numéros internes des utilisateurs qui sont joignables (lorsqu'ils sont disponibles, il peut s'agir d'un tableau vide).
• user_emails : Les adresses e-mail des utilisateurs.
• destination : Informations sur la destination de l'appel.
• number : Le numéro de téléphone composé par l'appelant.
• targets : Les téléphones qui sonnent pour cet appel. Les téléphones qui ne sont pas joignables ne sont pas affichés.
• number : Le numéro appelé. Il s'agit généralement du même numéro que destination.number, mais il peut changer si l'appel est transféré.
• name : Le nom de la personne appelée. Pour les appels entrants, il s'agit presque toujours de null.
• account_number : Les numéros internes des utilisateurs qui ont configuré leur compte VoIP pour être joignables (lorsqu'ils sont disponibles, il peut s'agir d'un tableau vide).
• user_numbers : Les numéros internes des utilisateurs qui sont joignables (lorsqu'ils sont disponibles, il peut s'agir d'un tableau vide).
• user_emails : Les adresses e-mail des utilisateurs.
• redirector : Informations sur le participant qui a effectué le transfert.
• number : Le numéro de téléphone utilisé par le redirigeur.
• name : Le nom du redirigeur.
• account_number : Le numéro interne du compte VoIP (lorsqu'il est disponible, pour les appels entrants, il s'agit presque toujours de null).
• user_numbers : Les numéros internes des utilisateurs qui sont joignables (lorsqu'ils sont disponibles, il peut s'agir d'un tableau vide).
• user_emails : Les adresses e-mail des utilisateurs.

Raccrocher (terminé)

Une notification ended est envoyée lorsqu'un appel est terminé. Un appel peut se terminer pour plusieurs raisons.

Une notification ended peut être envoyée après une notification in-progress si l'appel a été raccroché par l'un des participants, après une notification ringing si personne n'a répondu, ou comme seule notification si aucun appareil n'était joignable.

• call_id : Une chaîne unique pour identifier l'appel.
• timestamp : La date et l'heure de génération du webhook, au format ISO 8601.
• status : Le statut de l'appel. Pour ce type de notification, il s'agit de ended.
• reason : La raison pour laquelle l'appel s'est terminé. La raison peut être l'une des valeurs suivantes :
1. completed : L'appel s'est terminé avec succès.
2. busy : L'appel a été rejeté, le destinataire était occupé.
3. no-answer : Personne n'a répondu à l'appel pour diverses raisons.
4. failed : Une erreur s'est produite empêchant l'établissement de l'appel.
5. cancelled : L'appelant a raccroché avant que quiconque ne puisse répondre.
6. abandon : L'appelant a raccroché en attendant dans la file d'attente.
• version : Un attribut de version qui peut être utilisé à l'avenir pour migrer vers une autre version des webhooks. Actuellement, il est toujours v2.
• direction : Indique si un appel est entrant (inbound) ou sortant (outbound). Les appels entre collègues sont marqués comme outbound.
• caller : Informations sur l'appelant.
• number : Le numéro de téléphone utilisé par l'appelant.
• name : Le nom de l'appelant.
• account_number : Le numéro interne du Compte VoIP (lorsqu'il est disponible, pour les appels entrants, il est presque toujours null).
• user_numbers : Les numéros internes des utilisateurs qui sont joignables (lorsqu'ils sont disponibles, peut être un tableau vide).
• user_emails : Les adresses e-mail des utilisateurs.
• destination : Informations concernant la destination de l'appel.
• number : Le numéro de téléphone composé par l'appelant.

Transcription créée

Une notification call_transcription est envoyée lorsque la transcription est prête.

Si Voys Intelligence est activé. Il s'agit du premier événement qui suivra une notification ended. Si les résumés d'appels sont activés, l'événement summary suivra sous peu.

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

Résumé créé

Une notification summary est envoyée lorsque le résumé de l'appel est prêt.

Si Voys Intelligence est activé. Il s'agit du dernier événement pour un appel spécifique.

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

Enregistrement d'appel créé

Un événement call recording created est envoyé dès qu'un enregistrement d'appel est disponible.

Le contenu de l'événement se présente ainsi :

{
"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"
}

Vous pouvez utiliser recording_url directement pour récupérer l'enregistrement avec votre clé API. Pas besoin de construire l'URL vous-même ou de rechercher votre ID client.

Plusieurs notifications sont envoyées pour chaque appel. Les notifications envoyées dépendent de la façon dont l'appel est traité. Voici l'ordre des notifications pour les types d'appels les plus courants.

Appel simple

Un appel réussi avec deux participants :

• ringing - A appelle B
• in-progress - A appelle B
• ended - A appelle B (raison : completed)

Appel simple avec Voys Intelligence activé

Un appel réussi avec deux participants :

• ringing - A appelle B
• in-progress - A appelle B
• ended - A appelle B (raison : completed)
• call_transcription - la transcription de l'appel est prête
• summary - le résumé de l'appel est prêt

Pas de réponse

Le téléphone de l'appelé sonne mais sans réponse.

• ringing - A appelle B
• ended - A appelle B (raison : busy ou no-answer selon l'appareil)

Appelé indisponible

L'appelé est indisponible (par exemple, le téléphone est configuré sur Ne pas déranger), donc le téléphone ne sonne pas et l'appel reste sans réponse.

• ended - A appelle B (raison : busy)

Transfert assisté

Dans un transfert assisté (transfert supervisé), A appelle d'abord B, puis l'un des participants transfère l'appel vers C. Le participant appelle d'abord C, et après avoir échangé, l'appel est transféré. Seuls les participants A et C restent dans l'appel.

• ringing - A appelle B
• in-progress - A appelle B
• ringing - B appelle C
• in-progress - B appelle C
• warm-transfer - B met en relation A et C
• ended - A et C raccrochent (raison : completed)
• call_transcription - la transcription de l'appel est prête (une par segment d'appel, si activé)
• summary - le résumé de l'appel est prêt (un par segment d'appel, si activé)

Transfert direct

Dans un transfert direct (transfert à l'aveugle), A appelle d'abord B, puis l'un des participants transfère l'appel vers C sans attendre de savoir si C est disponible.

• ringing - A appelle B
• in-progress - A appelle B
• ringing - B appelle C
• cold-transfer - B connecte A et C
• in-progress - A appelle C
• ended - A n'appelle plus C (raison : completed)
• call_transcription - la transcription de l'appel est prête
• summary - le résumé de l'appel est prêt

Transfert semi-assisté

Dans un transfert semi-assisté (transfert tiède), A appelle d'abord B, puis l'un des participants transfère l'appel à C. Le participant tente d'abord d'appeler C mais transfère l'appel avant que C ne réponde.

• ringing - A appelle B
• in-progress - A appelle B
• ringing - B appelle C
• cold-transfer - B connecte A et C
• in-progress - A appelle C
• ended - A n'appelle plus C (raison : completed)
• call_transcription - la transcription de l'appel est prête
• summary - le résumé de l'appel est prêt

Prise d'appel

Lorsque deux téléphones appartiennent au même groupe de prise d'appels, il est possible de décrocher depuis un téléphone un appel destiné à un autre téléphone.

• ringing - A appelle B
• in-progress - A appelle C
• ended - A n'appelle plus C (raison : completed)
• call_transcription - la transcription de l'appel est prête
• summary - le résumé de l'appel est prêt

Redirection d'appel

Lorsqu'un utilisateur configure son téléphone pour rediriger automatiquement les appels entrants vers un autre numéro.

• ringing - A appelle B
• ringing - A appelle B et C
• in-progress ou ended, selon qu'une personne réponde ou non.
• call_transcription - la transcription de l'appel est prête
• summary - le résumé de l'appel est prêt

• Accédez à Notifications d'appel.
• Cliquez sur Ajouter.
• Saisissez une description dans le champ Description pour préciser l'objectif de la notification.
• Choisissez « Personnalisé » dans les options Package, sauf si vous préférez utiliser une option standard.
• Renseignez l'URL où les notifications de conversation doivent être envoyées.
• Renseignez le jeton API si votre package sélectionné en fournit un.

Remarque : cela n'est nécessaire que si votre package délivre un jeton API.

• Cliquez sur Enregistrer.