Notifications d'appel

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 pendant 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 exactement quelles informations sont 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, c'est created.
• version: Un attribut de version qui pourrait être utilisé à l'avenir pour migrer vers une autre version des webhooks. Actuellement, c'est toujours v2.
• direction: Si un appel est entrant (inbound) ou sortant (outbound). L'événement créé n'est envoyé que pour les appels entrants.
• 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: 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 suite à un appel entrant.

Il est possible que plusieurs notifications ringing soient envoyées successivement à 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, c'est ringing.
• version: Un attribut de version qui pourrait être utilisé à l'avenir pour migrer vers une autre version des webhooks. Actuellement, c'est toujours 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 utilisé par l'appelant.
• 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, c'est presque toujours null.
• account_number: Les numéros internes des utilisateurs qui ont configuré leur compte VoIP pour être joignables (si disponibles, peut être un tableau vide).
• user_numbers: Les numéros internes des utilisateurs qui sont joignables (si disponibles, 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 ! Le 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 se peut 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 de génération du webhook, au format ISO 8601.
• status: Le statut de l'appel. Pour ce type de notification, c'est in-progress.
• version : Un attribut de version qui pourra ê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 concernant 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 cela est presque toujours 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 concernant 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 redirigé.
• name : Le nom de la personne appelée. Pour les appels entrants, cela est presque toujours 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 supervisé

Une notification warm-transfer est envoyée lorsqu'un appel est transféré de manière « supervisée ». Lors d'un transfert supervisé, le transféreur appelle d'abord le nouveau participant, celui-ci décroche, 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 en quelque sorte 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 permettant d'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 pourra ê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 concernant 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 cela est presque toujours 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 concernant 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 redirigé.
• name : Le nom de la personne appelée. Pour les appels entrants, cela est presque toujours 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 concernant le participant qui a effectué le transfert.
• number : Le numéro de téléphone utilisé par le transféreur.
• name : Le nom du transféreur.
• account_number : Le numéro interne du Compte VoIP (lorsque disponible, pour les appels entrants cela est presque toujours 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 direct

Une notification cold-transfer est envoyée lorsqu'un appel est transféré de manière directe. Lors d'un transfert direct, 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 supervisé, il y a toujours un seul destinataire, alors que dans un transfert direct il peut y en avoir plusieurs (par exemple, si l'appel est transféré vers un Groupe d'appel).
• Pour un transfert supervisé, des notifications ringing et in-progress sont d'abord générées. Dans un transfert direct, 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 auxquelles le webhook est généré, au format ISO 8601.
• status : Le statut de l'appel. Pour ce type de notification, il est transfer.
• version : Un attribut de version qui pourra ê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 concernant 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.
• 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 est généralement identique à 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 est presque toujours null.
• account_number : Les numéros internes des utilisateurs qui ont configuré leur Compte VoIP pour être joignables (lorsqu'ils sont disponibles, peut être un tableau vide).
• 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.
• redirector : Informations concernant le participant qui a effectué le transfert.
• number : Le numéro de téléphone utilisé par le transféreur.
• name : Le nom du transféreur.
• 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.

Raccrochage (ended)

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

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 auxquelles le webhook est généré, au format ISO 8601.
• status : Le statut de l'appel. Pour ce type de notification, il est ended.
• reason : La raison pour laquelle l'appel s'est terminé. La raison peut avoir l'une des valeurs suivantes :
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 : Un attribut de version qui pourra ê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 concernant 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.

Plusieurs notifications sont envoyées pour chaque appel. Les notifications envoyées dépendent de la manière dont l'appel est traité. Vous trouverez ci-dessous 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)

Sans réponse

Le téléphone de l'appelé sonne mais il n'y a pas de réponse.

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

Appelé indisponible

L'appelé n'est pas disponible (par exemple, le téléphone est configuré sur Ne pas déranger), le téléphone ne sonne donc pas et l'appel n'obtient pas de réponse.

• ended - A appelle B (raison : busy)

Transfert accompagné

Dans un transfert accompagné (transfert assisté), 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 connecte A et C
• ended - A et C raccrochent (raison : completed)

Transfert direct

Dans un transfert direct (transfert à froid), A appelle d'abord B, puis l'un des participants transfère l'appel vers C sans attendre de voir 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)

Transfert semi-accompagné

Dans un transfert semi-accompagné (transfert tiède), A appelle d'abord B, puis l'un des participants transfère l'appel vers 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)

Prise d'appel

Lorsque deux téléphones font partie du même groupe de prise d'appels, il est possible de prendre un appel destiné à un autre téléphone depuis l'un d'entre eux.

• ringing - A appelle B
• in-progress - A appelle C
• ended - A n'appelle plus C (raison : completed)

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 & C
• in-progress ou ended, selon que quelqu'un réponde ou non.

• Rendez-vous sur 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 de Package, sauf si vous préférez utiliser une option standard.
• Remplissez l'URL vers laquelle les notifications de conversation doivent être envoyées.
• Complétez le champ Jeton API si votre package sélectionné en fournit un.

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

• Cliquez sur Enregistrer.

Voici quelques exemples d'intégrations en combinaison avec Zapier :

• Envoyer un message sur Slack en cas d'appel manqué.
• Envoyer un e-mail en cas d'appel manqué.
• Intégration Robin.
• Intégration Microsoft Flow
• Intégration Zapier

Et un exemple avec N8N et notre API de transcription d'appels

Obtenir automatiquement les transcriptions d'appels en utilisant N8N