Webhooks

Webhooks #

Les webhooks post-appel fournissent des informations sur chaque appel qui s'est terminé sur le système. Ces informations peuvent être utilisées pour mettre à jour des systèmes externes ou démarrer des automatisations de flux de travail, en utilisant des produits tels que Azure Logic Apps ou Zapier.

Exemples de cas d'utilisation :

  • Ajoutez un événement d'historique des appels contre a CRM enregistrement
  • Ajouter des détails de lecture d'enregistrement d'appels à un CRM enregistrement
  • Enregistrer des ventes réussies en CRM
  • Suivre les plaintes des clients dans un système externe
Information Circle info
Plusieurs webhooks peuvent être configurés (selon la licence) pour fournir des informations de post-appel à différents systèmes externes selon les besoins.

Configuration d'un webhook #

Conditions de filtre #

Par défaut, un webhook se déclenche pour toutes les sessions d'appel à moins qu'un filtre ne soit appliqué. Des filtres peuvent être ajoutés pour la plupart des propriétés d'appel afin de permettre au webhook d'être limité pour ne tirer que sur les appels « externes », par exemple, ou pour appeler qui correspondent à un numéro « DID » spécifique.

Ajoutez des options de filtre selon vos besoins. Lorsque plusieurs champs de filtre sont ajoutés, ils sont combinés à l'aide d'un ' ET' opérateur.

Information Circle info
Pour plus d'informations sur le filtrage, référez-vous ici

Mesures à prendre #

Paramètre Options Désignation des marchandises
URL https:// Fournir un HTTPS URL que la gâchette appellera lorsqu'elle sera déclenchée.
Méthode de demande GET, POST, PUT Choisissez la méthode de demande requise pour le webhook.
Format de demande JSON, Données de formulaire Choisissez le format de demande requis pour le webhook si POST ou PUT sont sélectionnés comme méthode Request.
Données de charge utile supplémentaires Paire clé/valeur Si nécessaire, des informations statiques supplémentaires peuvent être ajoutées à la charge utile du webhook. Entrez toutes les données supplémentaires sous forme de paires clé/valeur selon les besoins.
Tentatives de nouvelle tentative 0 - 10 Par défaut 1. Entrez le nombre de fois que le webhook devrait réessayer si le à tout moment il y a un échec
Hand Left warning
La configuration du déclencheur Webhook est mise en cache pour améliorer les performances. Tout nouveau déclencheur ou modification de déclencheurs existants peut prendre jusqu'à 10 minutes avant qu'ils ne prennent effet.
Information Circle info
Le délai d'attente pour une demande de webhook est de 10 secondes. Le temps entre les tentatives de nouvelle tentative est égal au Numéro de tentative x 2 secondes

Données de charge utile

Le tableau ci-dessous affiche les données fournies dans la charge utile de déclenchement.

Paramètre Désignation des marchandises
triggerID L'id unique pour le déclencheur pour la demande de crochet Web est renvoyée pour.
id L'ID de l'entité qui change (id d'utilisateur ou id de locataire).
tenantId Id client locataire auquel l'événement est associé.
cdr La charge utile des données d'appel
customData Si configuré contre le déclencheur, toutes les informations supplémentaires de paire de clé/valeur de charge utile seront passées ici.

CDR Données

Paramètre Désignation des marchandises
id L'ID de session pour le CDR enregistrer.
dType CDR type d'enregistrement - « CloudSessionCdr »
sVer CDR version - 1
pbxId ~.Dimensions.~ id pour la plate-forme de communication le CDR provient de (p. ex. ~.pbx.kazoo.name.~)
pbxName Le nom configuré de la plate-forme de communication
tz Identificateur TZ pour les temps d'appel.
début Heure de début de la session d'appel.
réponse Heure à laquelle les appels ont été répondus pour la première fois.
fin Heure de fin de la session d'appel.
dur Durée de l'appel en secondes.
anneau Temps de sonnerie de l'appel en quelques secondes.
parler Parlez de l'heure de l'appel en quelques secondes.
tenir Maintenez l'heure de l'appel en quelques secondes.
parc Garez l'heure de l'appel en quelques secondes.
perdu Indication indiquant si l'appel a été abandonné - 1/0
lostinParc Indication indiquant si l'appel a été abandonné alors qu'il était stationné - 1/0
aban Indication de savoir si l'appel était un appel de sonnerie court ou non - 1/0
ans Indication de si l'appel était ans - 1/0
court métrage Indication de si l'appel a été appelé comme ayant une courte durée - 1/0
cause Effacez la cause de l'appel.
dir Direction de l'appel. 0 - Inconnu, 1 - Interne, 2 - Entrant, 3 - Sortant, 4 - Les deux
type Type d'appel. 0 - Inconnu, 1 - Interne, 2 - Externe
t2t Indication de si l'appel était un joncteur réseau à l'appel de joncteur réseau - 1/0
cliNum Numéro d'identification de l'appelant (CLI) dans E.164 format.
cliName Nom de l'appelant
cliLoc Emplacement de l'interface de ligne de
cliArea Indicatif régional cli
cliState État CLI (États-Unis uniquement)
cliCtry Pays CLI
ddiNum Numéro DID dans E.164 format.
ddiName Nom DID
fRngDevNum Numéro d'appareil du premier rang.
fRngDevName Nom de l'appareil du premier rang.
lRngDevNum Numéro de l'appareil du dernier rang.
lRngDevName Nom de l'appareil de dernier rang.
ansDevNum Numéro du répondeur.
ansDevName Nom du répondeur.
lAnsDevNum Dernier numéro de répondeur.
lAnsDevName Nom du dernier répondeur.
fRngUsrNum Numéro d'utilisateur du premier rang.
fRngUsrName Nom d'utilisateur du premier rang.
lRngUsrNum Dernier numéro d'utilisateur de sonné.
lRngUsrName Nom d'utilisateur du dernier rang.
ansUsrNum Numéro d'utilisateur répondant.
ansUsrName Répondant au nom d'utilisateur.
lAnsUsrNum Dernier numéro d'utilisateur de réponse.
lAnsUsrName Nom d'utilisateur de la dernière réponse.
fRngAgtNum Numéro d'agent du premier rang.
fRngAgtName Nom de l'agent de premier rang.
lRngAgtNum Dernier numéro d'agent de sonné.
lRngAgtName Nom de l'agent du dernier rang.
ansAgtNum Numéro de l'agent répondant.
ansAgtName Nom de l'agent répondant.
lAnsAgtNum Dernier numéro d'agent répondeur.
lAnsAgtName Nom de l'agent répondeur de dernier.
rteID Numéro de préfixe. N'importe quel nombre ajouté au CLI comme préfixe pendant le routage par la plate-forme de transmissions.
rteName Nom du préfixe. N'importe quelle chaîne ajoutée au nom de l'appelant comme préfixe pendant le routage par la plate-forme de transmissions.
fRngGroupName Nom du groupe du premier rang.
lRngGroupName Nom du groupe du dernier rang.
ansGroupName Nom du groupe de répondants.
hasRec Indication indiquant si l'appel a été enregistré - 1/0
taux Indication indiquant si l'appel a été noté - 1/0
rateCost Le coût du tarif (double).
rateBand Nom de la bande pour le taux.
rateName Nom du taux appliqué.
enregistrementIds Tableau de chaînes d'Ids pour tous les enregistrements associés à cette session d'appel.
directorymatches Élément d'annuaire de contacts Tableau de tous les contacts correspondant à l'appel.
balises Tableau contenant une paire clé/valeur de toutes les balises appliquées à l'appel.

CDR Élément de répertoire de contacts

Légende Désignation des marchandises Type
titre Titre de la personne-ressource (M., Mme, Dr, etc.) chaîne
nom complet Nom complet du contact. Ceci est utilisé dans les rapports et ~.UcClient.~ pour aider les utilisateurs à identifier les appelants. chaîne
nom de l'entreprise Le nom de l'entreprise pour qui le contact travaille. chaîne
jobTitle La position de contact avec l'entreprise. chaîne
téléphone1 à téléphone4 Une adresse e-mail de contact pour le contact. E.164
courriel Jusqu'à 4 champs de numéro de téléphone de contact différents chaîne
crmId Un identifiant unique pour l'enregistrement de contact d'un CRM système chaîne
champ1 à champ 10 10 champs pour transporter des données personnalisées pour l'enregistrement de contact chaîne
Color Wand tip
Le triggerId peut être trouvé en modifiant un déclencheur configuré dans le portail client et en copiant le GUID à partir de la fin du URL. p. ex. https://myreports.com/en-GB/webhooks/00000000-0000-0000-0000-000000000000

Exemple JSON charge utile

Exemple JSON format de charge utile pour PUT/POST demandes :

{
    « triggerId » : « 00000000-0000-0000-0000-000000000000000 »,
    « id » : « 000000000-0000-0000-0000-00000000000000 »,
    « tenantId » : « 00000000-0000-0000-0000-000000000000000 »,
    « cdr » : {
        « id » : « 000000000-0000-0000-0000-00000000000000 »,
        « dType » : « CloudSessionCdr »,
        « sVer » : 1,
        « pbxId » : « 00000000-0000-0000-0000-00000000000000 »,
        « pbxName » : « BenDV1 - Dev - Ben »,
        « tz » : « Europe/Londres »,
        « début » : « 2024-05-29T09:37:35+01:00 »,
        « fin » : « 2024-05-29T09:37:45+01:00 »,
        « dur » : 10,
        « anneau » : 10,
        « perdu » : 1,
        « cause » : « NORMAL_ COMPENSATION »,
        « dir » : 2,
        « type » : 2,
        « cliNum » : « \\u002B447000000000 »,
        « cliLoc » : « Royaume-Uni »,
        « cliCtry » : « GB »,
        « ddiNum » : « \\u002B441610000000 »,
        « fRngDevNum » : « utilisateur_ **\*\***",
        « fRngDevName » : « (T42S) Test User »,
        « lRngDevNum » : « user\_**\*\***",
        « lRgDevName » : « (T42S) Utilisateur de test »,
        « fRngUsrNum » : « 302 »,
        « fRngUsrName » : « Utilisateur de test »,
        « lRngUsrNum » : « 302 »,
        « lRngUsrName » : « Utilisateur de test »,
        « fRngAgtNum » : « 302 »,
        « fRngAgtName » : « Utilisateur de test »,
        « lRngAgtNum » : « 302 »,
        « lRngAgtName » : « Utilisateur de test »,
        « hasRec » : 1,
        « recordingIds » : [" 000000000-0000-0000-0000-0000000000000"]["00000000-0000-0000-0000-000000000000"],
        « directoryMatches » : [ {
            « dirName » : « My Global »,
            « dirId » : « 000000000-0000-0000-0000-000000000000000 »,
            « dirType » : « DirectoryContactMatch »,
            « contactId » : « 00000000-0000-0000-0000-000000000000000 »,
            « champs » : {
            « fullName » : « Exemple de contact »,
            « companyName » : « Société »,
            « jobTitle » : « Titre du poste »,
            « e-mail » : « Adresse e-mail »,
            « champ1 » : « champ1 »,
            « field2 » : « field2 »,
            « field3 » : « field3 »,
            « field4 » : « field4 »,
            « champ5 » : « champ5 »,
            « champ6 » : « champ6 »,
            « field7 » : « field7 »,
            « champ8 » : « champ8 »,
            « field9 » : « field9 »,
            « champ10 » : « 301 »
            }][{
            "dirName": "My Global",
            "dirId": "00000000-0000-0000-0000-000000000000",
            "dirType": "DirectoryContactMatch",
            "contactId": "00000000-0000-0000-0000-000000000000",
            "fields": {
            "fullName": "Example Contact",
            "companyName": "Company",
            "jobTitle": "Job Title",
            "email": "Email Address",
            "field1": "field1",
            "field2": "field2",
            "field3": "field3",
            "field4": "field4",
            "field5": "field5",
            "field6": "field6",
            "field7": "field7",
            "field8": "field8",
            "field9": "field9",
            "field10": "301"
            }],
        « tags » : {
            « Soutien » : « étape 1 »
        }
    },
    « customData » : {
        « crochet » : « post-appel »
    }
}