Métadonnées de session d'appel

Ce document fournit le schéma de l'enregistrement des métadonnées de session d'appel, c'est-à-dire le document JSON émis par UJET à la fin de chaque appel vocal. UJET transmet l'enregistrement à votre intégration CRM en tant que corps de la commande de fin de session et l'écrit dans votre configuration de stockage externe sous la forme d'un fichier metadata.json. Chaque appel produit un seul enregistrement. L'élément id de premier niveau identifie chaque enregistrement de manière unique. Utilisez ce schéma pour ingérer des enregistrements dans des systèmes en aval, valider les charges utiles reçues ou mapper des champs sur des colonnes d'entrepôt de données.

Racine du schéma

L'enregistrement des métadonnées de la session d'appel est un objet JSON unique qui représente une session d'appel vocal. Trois concepts de premier niveau déterminent l'identité et la forme de l'enregistrement.

Clé primaire : id (entier)

Le id de premier niveau identifie de manière unique la session d'appel dans votre locataire. Un enregistrement existe pour chaque appel. Tous les autres champs, tableaux et objets imbriqués de premier niveau décrivent les attributs de l'appel que ce id identifie.

Discriminant du gestionnaire : agent_info (objet, oneOf)

Objet unique dont la forme varie en fonction du dernier gestionnaire de l'appel. Les deux variantes sont mutuellement exclusives. L'enregistrement ne contient qu'une seule variante :

• Variante avec agent humain : présente si un agent humain a traité l'appel en dernier. Contient email, first_name, last_name et agent_number en plus des champs partagés id, name et avatar_url.

• Variante d'agent virtuel : présente si un agent virtuel a traité l'appel en dernier. Inclut va_alias et omet email, first_name, last_name et agent_number.

Pour détecter la variante d'un enregistrement, recherchez la présence d'un champ spécifique à la variante (généralement agent_info.email pour la variante d'agent humain ou agent_info.va_alias pour la variante d'agent virtuel). Pour connaître la forme complète de chaque variante, consultez agent et virtual_agent.

Discriminants de forme d'appel : call_type, session_type, session_type_v2 (chaîne)

Trois vues parallèles du même type d'appel sous-jacent. Elles ne sont jamais en désaccord sur le type d'appel qu'un enregistrement représente. Elles ne diffèrent que par le vocabulaire qu'elles utilisent pour nommer le type d'appel.

• call_type utilise l'ancien vocabulaire enum (par exemple, Voice Inbound (App), Voice Outbound ou Voice Internal).

• session_type renvoie toujours la même chaîne que call_type. UJET fournit ce champ pour assurer la rétrocompatibilité avec les intégrations qui utilisent ce champ comme clé. Traitez-le comme un alias obsolète de call_type. Consultez Gestion des versions et obsolescences.

• session_type_v2 utilise le vocabulaire d'énumération actuel. Ce vocabulaire étend le vocabulaire call_type avec des distinctions plus précises pour les flux entrants, par exemple Voice Inbound (Mobile) et Voice Inbound (IVR using Mobile) au lieu des termes plus généraux Voice Inbound (App) et Voice Inbound (IVR using App). Pour les types d'appel qui n'ont pas de valeur spécifique à la version 2, session_type_v2 renvoie la même chaîne que call_type. Les nouvelles intégrations doivent analyser session_type_v2.

Pour connaître les valeurs de chaque champ, consultez Informations de base.

Informations essentielles

Ces propriétés capturent les informations de base de l'appel :

• id (entier) : identifiant unique pour chaque session d'appel. Il s'agit de la clé primaire qui distingue un appel d'un autre.

• call_uuid (chaîne ou null) : identifiant unique qui met en corrélation un appel entre les locataires d'origine et de réception dans les interactions de routage dynamique des appels (DCR). Les deux parties d'un appel DCR partagent la même valeur call_uuid, ce qui permet aux clients de faire le pont entre les données de différents environnements. Le champ est nul ou vide pour tout appel qui n'est pas une interaction DCR, et pour les appels qui ont eu lieu avant que UJET n'ajoute le champ.

• lang (chaîne) : code de langue ISO 639 pour l'appel (par exemple, "en" pour l'anglais ou "es" pour l'espagnol). Ce code vous aide à effectuer des analyses et à générer des rapports spécifiques à une langue.

• call_type (chaîne) : type d'appel, à l'aide de l'ancien vocabulaire de type. Les valeurs incluent "Appel entrant vocal (application)", "Appel entrant vocal (Web)", "Appel entrant vocal (SVI)", "Appel entrant vocal (SVI via l'application)", "Appel entrant vocal (API)", "Appel entrant vocal (direct)", "Appel entrant vocal (extension)", "Appel programmé vocal (application)", "Appel programmé vocal (Web)", "Appel programmé vocal (API)", "Rappel vocal", "Rappel vocal (Web)", "Appel sortant vocal", "Appel sortant vocal (API)", "Appel sortant vocal (direct)", "Appel sortant vocal (UCaaS)", "Appel interne vocal", "Campagne vocale (Acqueon)", "Campagne vocale (<nom de votre marque>)" et "Appel programmé par l'agent".

• session_type (chaîne) : doublon de call_type (mêmes valeurs) que UJET conserve pour assurer la rétrocompatibilité. Consultez Gestion des versions et obsolescence : doublons hérités.

• session_type_v2 (chaîne) : type d'appel, à l'aide du vocabulaire de type actuel. Elle affine les valeurs call_type en distinguant plus précisément les appels entrants (par exemple, "Entrant vocal (mobile)" et "Entrant vocal (SVI via mobile)" au lieu de "Entrant vocal (application)" et "Entrant vocal (SVI via application)"). Les valeurs incluent "Appel vocal entrant (mobile)", "Appel vocal entrant (Web)", "Appel vocal entrant (SVI)", "Appel vocal entrant (SVI via mobile)", "Appel vocal entrant (API)", "Appel vocal entrant (direct)", "Appel vocal entrant (extension)", "Appel vocal planifié (mobile)", "Appel vocal planifié (Web)", "Appel vocal planifié (API)", "Rappel vocal", "Rappel vocal (Web)", "Appel vocal sortant", "Appel vocal sortant (API)", "Appel vocal sortant (direct)", "Appel vocal sortant (UCaaS)", "Appel vocal interne", "Campagne vocale (Acqueon)", "Campagne vocale (<nom de votre marque>)" et "Appel planifié par l'agent".

• status (chaîne) : état actuel de l'appel. Les valeurs possibles sont "scheduled", "queued", "connected", "finished", "failed" et "deflected". Cela permet de suivre la progression de l'appel tout au long de son cycle de vie.

• created_at (chaîne, date et heure) : horodatage précis de la création de l'enregistrement d'appel par UJET.

• queued_at (chaîne, date/heure ou null) : code temporel indiquant le moment où l'appel a été placé dans la file d'attente, ou null si l'appel n'a pas été placé dans la file d'attente.

• assigned_at (chaîne, date/heure ou null) : code temporel indiquant le moment où UJET a attribué l'appel à un agent, ou null si UJET n'a pas attribué l'appel.

• connected_at (chaîne, date/heure ou null) : code temporel de la connexion de l'appel.

• ends_at (chaîne, date et heure ou null) : code temporel de la fin de l'appel.

• scheduled_at (chaîne, date et heure ou null) : code temporel indiquant quand UJET a planifié l'appel, ou null si l'appel était immédiat.

• updated_at (chaîne, date et heure) : code temporel de la dernière mise à jour des données d'appel par UJET.

• wait_duration (entier ou null) : durée totale passée par le client dans la file d'attente pendant l'appel, en secondes, ou null si UJET n'a enregistré aucune durée d'attente. Pour connaître le temps d'attente réparti par segment individuel, consultez le tableau queue_durations (Durées de file d'attente). Consultez Gestion des versions et obsolescences : nomenclature du champ "Temps d'attente".

• call_duration (entier ou null) : durée totale de l'appel, en secondes.

• hold_duration (entier ou null) : durée totale pendant laquelle le consommateur a été mis en attente, en secondes, ou null si aucune durée d'attente n'a été enregistrée.

• rating (entier ou null) : note de satisfaction client (CSAT) envoyée par le consommateur, ou "null" si le consommateur n'a pas envoyé de note.

• has_feedback (booléen) : indicateur indiquant si le consommateur a fourni des commentaires après l'appel.

• voip_provider (chaîne) : fournisseur VoIP de l'appel. (Remarque : Ce champ est obsolète et renvoie toujours "deprecated".)

• out_ticket_id (chaîne ou null) : ID de la demande créée par UJET dans le système CRM externe.

• out_ticket_url (chaîne, URI ou null) : URL de la demande CRM.

• is_out_ticket_account (booléen ou null) : indique si la demande CRM représente un client (true) ou une interaction téléphonique (false).

• verified (booléen) : indique si l'action intelligente de validation a validé l'interaction.

• recording_url (chaîne, uri ou null) : URL de l'enregistrement de l'appel ou valeur nulle si aucun enregistrement n'est disponible.

• recording_permission (chaîne ou valeur nulle) : état de l'autorisation d'enregistrement du consommateur. Les valeurs possibles sont "not_asked", "granted" et "denied".

• voicemail_reason (chaîne) : motif du message vocal, le cas échéant. Les options incluent "not_voicemail", "temporary_redirection" et "after_hour_deflection".

• disconnected_by (chaîne ou null) : indique quelle partie a mis fin à l'appel. Valeurs possibles : disconnected_by_unknown, disconnected_by_agent, disconnected_by_end_user, disconnected_by_virtual_agent, disconnected_by_system.

• fail_reason (chaîne ou valeur nulle) : raison de l'échec d'un appel ou "rien" pour les appels qui n'ont pas échoué. Les valeurs possibles sont nothing, unknown, expired, eu_canceled, eu_rejected, eu_abandoned, eu_in_menu_abandoned, eu_busy, eu_wrong_number, eu_no_answer, eu_noti_failed, ag_canceled, ag_ignored, ag_mic_no_device, ag_mic_denied, voip_twilio_error, voip_tokbox_error, voip_invalid_token, voip_conn_general, voip_conn_timeout et voip_conn_signal.

• fail_details (chaîne ou null) : informations supplémentaires lisibles par l'utilisateur accompagnant fail_reason, le cas échéant.

• adapter_fail_code (entier ou null) : code numérique correspondant à fail_reason au niveau de l'appel. Null lorsque l'appel n'a pas échoué. La même énumération est utilisée pour adapter_fail_code par participant dans la section 17.

• adapter_fail_message (chaîne ou null) : message lisible par l'utilisateur correspondant à adapter_fail_code. Null lorsque l'appel n'a pas échoué.

• support_number (chaîne ou null) : numéro de téléphone composé par le consommateur pour joindre le centre de contact, au format E.164. Renseigné pour les appels provenant d'un SVI. Peut être nul pour les autres canaux.

• queue_priority_level (entier ; présent uniquement lorsque la priorité de file d'attente est activée dans votre compte) : priorité de file d'attente attribuée à l'appel.

Informations sur les agents et les agents virtuels

Ces sections expliquent qui ou quoi a géré l'appel :

• agent_info (objet) : ce champ peut contenir des informations sur un agent humain ou un agent virtuel. Il utilise le mot clé oneOf pour spécifier qu'il peut s'agir de l'un des deux types.

  • agent (objet) : informations sur l'agent humain :

    • id (entier) : ID unique de l'agent.

    • agent_number (chaîne ou null) : identifiant attribué à l'agent.

    • email (chaîne, adresse e-mail) : adresse e-mail de l'agent.

    • name (chaîne) : nom complet de l'agent.

    • last_name (chaîne) : nom de famille de l'agent.

    • first_name (chaîne) : prénom de l'agent.

    • avatar_url (chaîne, uri) : URL de l'image de l'avatar de l'agent.

  • virtual_agent (objet) : informations sur l'agent virtuel :

    • id (entier) : identifiant unique de l'agent virtuel.

    • name (chaîne) : nom de l'agent virtuel.

    • avatar_url (chaîne, URI ou null) : URL de l'image de l'avatar de l'agent virtuel.

    • va_alias (chaîne ou null) : alias à afficher pour l'agent virtuel, si vous en avez défini un. Toujours présent dans la charge utile ; valeur nulle si aucun alias n'est défini.

Navigation au sein du menu

• selected_menu (objet ou null) : informations sur le menu que le consommateur a sélectionné lors de l'appel.

  • id (entier) : ID unique du menu.

  • name (chaîne) : nom du menu.

  • parent_id (entier ou null) : ID du menu parent, le cas échéant.

  • position (entier) : position du menu par rapport aux autres menus du même niveau.

  • deleted (booléen) : indique si le menu a été supprimé.

  • menu_type (chaîne) : type de menu (par exemple, ivr_menu ou sms_menu).

  • hidden (booléen) : indique si le menu est visible et disponible.

• menu_path (objet ou null) : décrit le chemin hiérarchique des menus dans lesquels le consommateur a navigué.

  • items_count (entier) : nombre de menus dans le chemin d'accès.

  • name (chaîne) : chaîne de noms de menu séparés par une barre oblique (par exemple, "Support/Facturation").

  • materialized_path (chaîne) : chaîne d'ID de menu séparés par une barre oblique.

• automation_redirection (objet ; présent uniquement lorsque le premier journal de redirection de l'appel est associé à un groupe de redirection) : détails sur la redirection de file d'attente basée sur un pourcentage qui a affecté le routage de cet appel.

  • percent_redirection (booléen) : indique si vous avez activé la redirection basée sur un pourcentage dans le menu source.

  • redirection_group (tableau) : tableau à un élément contenant les détails du groupe de redirection :

    • group_label (string) : libellé lisible du groupe de redirection (par exemple, "Groupe de redirection 1").

    • destination (objet ou null) : destination de redirection que vous avez configurée dans le groupe.

    • after_hours (booléen ou null) : indique si vous avez activé les options de déviation hors des heures de travail pour le groupe.

    • ah_destination (objet ou null) : destination de redirection en dehors des heures d'ouverture que vous avez configurée pour le groupe.

Informations sur l'utilisateur final

• end_user (objet ou null) : informations sur le consommateur :

  • id (entier ou null) : ID interne du consommateur.

  • identifier (chaîne ou null) : identifiant externe du consommateur.

  • out_contact_id (chaîne ou null) : ID du consommateur dans le CRM.

Données personnalisées et fournies par le SDK

• customer_flag (objet ; présent uniquement lorsque le site Web a transmis des données d'authentification personnalisées) : attributs de données personnalisées liés à l'authentification que l'application ou le site Web du consommateur ont transmis au début de la session. La charge utile n'inclut que le sous-ensemble que vous désignez comme paramètres d'authentification.

• api_dap_request (objet ; présent uniquement lorsque vous activez les paramètres de données et que vous les configurez pour qu'ils soient inclus dans les métadonnées de session) : instantané des valeurs des paramètres de données de l'appel, telles que vous les configurez dans les paramètres de l'API externe de votre compte. Les types de clés et de valeurs dépendent de la configuration de vos paramètres de données.

• form_responses (tableau ; présent uniquement lorsque le consommateur a envoyé au moins une réponse à un formulaire) : réponses collectées par les formulaires du SDK pendant l'appel. Chaque entrée contient les éléments suivants :

  • id (chaîne ou entier) : identifiant de la réponse à un formulaire.

  • title (chaîne) : titre du formulaire présenté au consommateur.

  • smart_action_id (nombre entier ou null) : identifiant de l'action intelligente qui a déclenché le formulaire, le cas échéant.

  • questions (tableau) : paires de questions et réponses collectées.

Pièces jointes

• photos (tableau) : photos que le consommateur a mises en ligne pendant l'appel.

  • id (entier) : identifiant unique de la photo.

  • photo_type (chaîne) : type ou source de la photo (par exemple, "photo").

  • url (chaîne, uri) : URL de la photo stockée.

  • smart_action_type (chaîne ou null) : action intelligente qui a produit la photo, le cas échéant.

  • transfer_id (entier ou null) : ID de l'événement de transfert pour la photo, si l'utilisateur l'a importée après un transfert.

• videos (tableau) : vidéos que le consommateur a mises en ligne pendant l'appel.

  • id (entier) : identifiant unique de la vidéo.

  • url (string, uri) : URL de la vidéo stockée.

  • smart_action_type (chaîne ou null) : action intelligente ayant produit la vidéo, le cas échéant.

  • transfer_id (entier ou nul) : ID de l'événement de transfert pour la vidéo, si le consommateur l'a mise en ligne après un transfert.

Redirection d'appel

• deflection (chaîne) : indique si l'appel a été redirigé et comment (par exemple, "no_deflection", "over_cap_phone" ou "after_hours_voicemail").

• deflection_details (tableau) : fournit un journal détaillé des déviations pendant l'appel. Le champ de déviation de chaque entrée utilise l'énumération définie dans Définitions : déviation. Chaque entrée inclut :

  • id (entier) : identifiant unique de l'enregistrement du journal de déviation.

  • call_id (entier) : identifiant unique de l'appel.

  • transfer_id (entier ou null) : identifiant unique du transfert associé à la déviation, le cas échéant.

  • deflection (chaîne ; consultez Définitions : déviation pour connaître les valeurs autorisées) : type de déviation.

  • created_at (chaîne, date et heure) : code temporel de l'événement d'évitement.

  • from_menu_path (objet ou null) : chemin de menu à partir duquel la déviation a commencé.

  • to_menu_path (objet ou null) : chemin de menu vers lequel UJET a redirigé l'appel.

  • to_sip_uri (chaîne ; présent uniquement lorsque UJET a redirigé l'appel vers une destination SIP) : URI SIP vers lequel UJET a redirigé l'appel, le cas échéant.

  • to_sip_headers (objet ; présent uniquement lorsque UJET a redirigé l'appel vers une destination SIP) : en-têtes SIP avec lesquels UJET a redirigé l'appel, le cas échéant.

Transferts

• transfers (tableau) : une entrée par événement de transfert pendant l'appel. Enregistre les transferts à chaud et à froid entre les agents, les agents virtuels et les menus.

  • id (entier) : identifiant unique du transfert.

  • status (chaîne) : état actuel du transfert (par exemple, "en cours", "connecté" ou "échec").

  • fail_reason (chaîne) : raison de l'échec du transfert ou "rien" s'il n'a pas échoué.

  • created_at (chaîne, date et heure) : date et heure de début du transfert.

  • assigned_at (chaîne, date et heure ou null) : date et heure auxquelles UJET a attribué le transfert au destinataire.

  • connected_at (chaîne, date et heure ou null) : lorsque le transfert est connecté.

  • updated_at (chaîne, date et heure) : date et heure de la dernière mise à jour de l'enregistrement du transfert par UJET.

  • call_duration (entier) : durée de l'appel du segment transféré, en secondes.

  • wait_duration (entier) : temps d'attente du consommateur pendant le transfert, en secondes.

  • deflection (chaîne) : type de déviation associé au transfert, le cas échéant.

  • answer_type_path (chaîne ou null) : chemin décrivant la manière dont l'appel transféré a été résolu.

  • from_menu_path / to_menu_path (objet ou null) : chemin d'accès au menu avant et après le transfert. Même forme que menu_path dans Définitions.

  • from_agent / to_agent (objet ou null) : agent humain de chaque côté du transfert. Même forme que l'objet agent dans Définitions.

  • from_virtual_agent / to_virtual_agent (objet ou null) : agent virtuel de chaque côté du transfert. Même forme que l'objet virtual_agent dans Definitions.

  • from_queue_priority_level / to_queue_priority_level (entier ou null) : priorité de la file d'attente avant et après le transfert. Présent uniquement lorsque vous activez la priorité de file d'attente dans votre compte.

Durées de gestion des appels

• handle_durations (tableau) : tableau d'objets, chacun représentant un segment de l'appel géré par un agent. Cela permet d'analyser le temps de traitement des agents.

  • id (entier) : identifiant unique de la durée du délai de traitement.

  • agent_id (entier) : ID de l'agent.

  • acw_duration (entier) : durée du travail après appel.

  • bcw_duration (entier) : durée du travail avant l'appel.

  • call_duration (entier) : durée de l'appel au cours de ce segment.

  • menu_path_id (entier ou null) : ID du chemin de menu.

  • menu_path (chaîne) : nom du chemin de menu.

  • lang (chaîne) : langue utilisée.

  • barged (booléen) : indique si le superviseur a fait irruption dans l'appel.

  • transfer (valeur booléenne) : indique si un transfert a eu lieu.

  • transfer_id (entier ou null) : ID du transfert.

  • transfer_cold (booléen ou null) : indique si le transfert était non annoncé.

  • started_at (chaîne, date et heure) : code temporel de début.

  • ended_at (chaîne, date et heure ou null) : code temporel de fin.

  • scheduled_at (chaîne, date et heure ou null) : horodatage planifié.

  • hold_duration (entier ou null) : durée de la mise en attente pendant ce segment.

  • assigned_connection_duration (entier) : durée pendant laquelle le client a attendu que l'agent se connecte au cours de cette phase.

  • session_breakthrough (objet ; présent uniquement lorsque l'appel a été attribué à un agent malgré son état "Indisponible") : détails sur l'attribution de l'appel à un agent malgré son état "Indisponible", le cas échéant.

Durées des files d'attente

• queue_durations (tableau) : tableau d'objets, chacun représentant un segment de l'appel où le consommateur était dans une file d'attente. Cela permet d'analyser les temps d'attente et les niveaux de service.

  • id (entier) : identifiant unique de la durée de la file d'attente.

  • agent_id (entier) : ID de l'agent.

  • ended_at (chaîne, date et heure) : code temporel de fin.

  • lang (chaîne) : langue utilisée.

  • menu_path_id (entier) : ID du chemin de menu.

  • menu_path (chaîne) : nom du chemin de menu.

  • queue_duration (entier) : durée du segment de file d'attente.

  • started_at (chaîne, date et heure) : code temporel de début.

  • transfer_cold (valeur booléenne) : indique si l'appel a été transféré à froid.

  • transfer (valeur booléenne) : indique si un transfert a eu lieu.

  • transfer_id (entier ou null) : ID du transfert.

  • service_level_abandon_time_threshold (entier) : seuil de temps pour l'abandon du niveau de service.

  • service_level_event (chaîne) : état de l'événement au niveau du service ("excluded", "in_sla", "not_in_sla").

  • service_level_target_percent (entier) : pourcentage cible de conformité au niveau de service.

  • service_level_target_time (entier) : délai cible pour la conformité au niveau de service.

Escalades d'un agent virtuel vers un agent humain

• escalations (tableau) : chaque entrée représente une escalade d'un agent virtuel vers un agent humain.

  • id (entier) : identifiant unique de l'escalade.

  • status (chaîne) : état actuel (par exemple, "escalade", "escaladé" ou "échec").

  • reason (chaîne) : motif de l'escalade de la session.

  • created_at (chaîne, date et heure) : date et heure du début de l'escalade.

  • escalated_at (chaîne, date/heure ou null) : date et heure de fin de l'escalade.

  • from_virtual_agent (objet ou null) : agent virtuel qui a transféré l'appel. Même forme que l'objet virtual_agent dans Definitions.

  • to_agent (objet ou null) : agent humain auquel l'appel a été transféré. Même forme que l'objet agent dans Definitions.

  • from_menu_path / to_menu_path (objet ou null) : chemin du menu avant et après l'escalade.

Escalades d'agents virtuels

• virtual_agent_deflected_escalations (tableau) : détails des escalades évitées par les agents virtuels.

  • id (entier) : identifiant unique.

  • deflection (chaîne) : type de déviation.

  • escalation_id (entier) : identifiant de l'événement d'escalade.

  • escalation_reason (chaîne) : motif de la transmission.

  • escalated_at (chaîne, date et heure) : code temporel de l'escalade.

  • menu_path_id (entier) : ID du chemin de menu.

  • menu_path (chaîne) : chemin d'accès au menu.

  • lang (chaîne) : langue.

  • virtual_agent (objet) : informations sur l'agent virtuel. Consultez Définitions.

Durées de traitement des agents virtuels

• virtual_agent_handle_durations (tableau) : segments temporels pendant lesquels un agent virtuel a géré l'appel.

  • id (entier) : identifiant unique.

  • virtual_agent (objet) : informations sur l'agent virtuel. Consultez Définitions.

  • call_duration (entier) : durée du segment.

  • escalation_reason (chaîne) : motif de la transmission.

  • finish_reason (chaîne) : raison pour laquelle l'interaction s'est terminée.

  • sentiment (entier) : sentiment du consommateur.

  • response_count (entier) : nombre de réponses de l'agent virtuel.

  • fallback_response_count (entier) : nombre de réponses de remplacement.

  • initiated_by (chaîne) : mode de démarrage de la session d'agent virtuel.

  • menu_path_id (entier) : ID du chemin de menu.

  • menu_path (chaîne) : chemin d'accès au menu.

  • lang (chaîne) : langue.

  • transfer (valeur booléenne) : indique si l'appel a été transféré.

  • transfer_id (entier ou null) : identifiant de l'événement de transfert.

  • started_at (chaîne, date et heure) : code temporel de début.

  • ended_at (chaîne, date et heure ou null) : code temporel de fin.

Durées de traitement des demandes des consommateurs

• consumer_handle_durations (tableau) : durées pendant lesquelles le consommateur était en ligne.

  • id (entier) : identifiant unique.

  • call_duration (entier) : durée du segment de consommateur.

  • hold_duration (entier ou null) : durée de la conservation pour le consommateur.

  • started_at (chaîne, date et heure) : code temporel de début.

  • ended_at (chaîne, date et heure) : code temporel de fin.

Durées des événements de consommation

• consumer_event_durations (tableau) : détails des événements d'appel des consommateurs (comme la CSAT ou le paiement).

  • id (entier) : identifiant unique.

  • duration (entier) : durée de l'événement.

  • type (chaîne) : type d'événement.

  • event (chaîne) : résultat de l'événement.

  • menu_path_id (entier) : ID du chemin de menu.

  • menu_path (chaîne) : chemin d'accès au menu.

  • lang (chaîne) : langue.

  • started_at (chaîne, date et heure) : code temporel de début.

  • ended_at (chaîne, date et heure) : code temporel de fin.

Durées dans le menu consommateur

• consumer_in_menu_durations (tableau) : durées des interactions des consommateurs dans les menus.

  • id (entier) : identifiant unique.

  • duration (entier) : durée dans le menu.

  • event (chaîne) : résultat de l'interaction avec le menu.

  • menu_path_id (entier) : ID du chemin de menu.

  • menu_path (chaîne) : chemin d'accès au menu.

  • lang (chaîne) : langue.

  • started_at (chaîne, date et heure) : code temporel de début.

  • ended_at (chaîne, date et heure) : code temporel de fin.

Nombre de participants

• participants (tableau) : informations sur chaque participant à l'appel (par exemple, le consommateur, l'agent ou l'agent virtuel).

  • id (entier) : identifiant unique du participant.

  • type (string) : type de participant ("end_user", "agent", "virtual_agent", etc.).

  • entry_type (chaîne) : méthode utilisée par le participant pour rejoindre l'appel.

  • user_id (entier ou null) : ID utilisateur si le participant est un agent.

  • end_user_id (entier ou null) : identifiant du consommateur si le participant est le consommateur.

  • virtual_agent_id (entier ou null) : ID de l'agent virtuel si le participant est un agent virtuel.

  • virtual_agent_params (objet ; présent uniquement lorsque vous configurez des métadonnées personnalisées de l'agent virtuel pour l'inclusion) : métadonnées personnalisées utilisées par l'agent virtuel.

  • status (chaîne) : état du participant ("waiting", "connected", "finished", etc.).

  • fail_reason (chaîne) : motif de l'échec, le cas échéant.

  • connected_at (chaîne, date et heure ou null) : code temporel indiquant quand le participant s'est connecté.

  • phone_number (chaîne ; présent uniquement pour les participants consommateurs) : numéro de téléphone du participant.

  • call_id (entier) : identifiant de l'appel.

  • call_duration (entier ou null) : durée de l'appel pour le participant.

  • hold_duration (entier ou nul) : durée de la mise en attente pour le participant.

  • ended_at (chaîne, date et heure ou null) : code temporel indiquant la fin de la participation.

  • adapter_fail_code (entier ou null) : code numérique correspondant au motif de l'échec.

  • adapter_fail_message (chaîne ou null) : description lisible de fail_reason, le cas échéant.

  • agent_assist (objet ; présent uniquement sur les participants agents lorsque vous configurez Agent Assist) : paramètres Agent Assist actifs pour ce participant.

  • virtual_agent (objet ; présent uniquement pour les participants de l'agent virtuel) : détails de l'agent virtuel qui sert de participant, distincts de agent_info de premier niveau et de virtual_agent_params.

  • caller_id (chaîne ; présent uniquement lorsque vous activez l'affichage du numéro de l'appelant dans l'en-tête SIP sur votre compte, et uniquement pour les participants consommateurs) : affichage du numéro de l'appelant que UJET extrait des en-têtes SIP entrants pour ce participant consommateur.

  • sip_headers (objet ou null) : en-têtes SIP associés à ce participant. Toujours présent dans la charge utile ; null lorsque UJET ne capture pas les en-têtes.

  • location (chaîne ou null ; présent uniquement pour les participants agents) : emplacement de l'agent.

  • location_id (entier ou null ; présent uniquement pour les participants agents) : ID du lieu.

  • email (chaîne, e-mail ; présent uniquement pour les participants agents) : adresse e-mail de l'agent.

  • first_name (chaîne ou null ; présent uniquement pour les participants agents) : prénom de l'agent.

  • last_name (chaîne ou null ; présent uniquement pour les participants agents) : nom de famille de l'agent.

  • middle_name (chaîne ou null ; présent uniquement pour les participants agents) : deuxième prénom de l'agent.

  • teams (tableau ; présent uniquement pour les participants agents) : tableau d'objets { id, name } pour les équipes de l'agent.

Enregistrements

• recordings (tableau) : informations sur l'enregistrement de l'audio de l'appel.

  • id (entier) : identifiant unique de l'enregistrement.

  • call_id (entier) : identifiant de l'appel.

  • conference_sid (chaîne ou null) : identifiant d'appel du fournisseur VoIP.

  • duration (entier ou nul) : durée de l'enregistrement.

  • recording_type (chaîne) : type d'enregistrement.

  • redaction_times (tableau) : segments temporels masqués.

    • start (chaîne, date et heure) : date et heure de début de l'intervalle de masquage.

    • end (chaîne, date et heure) : date et heure de fin de l'intervalle de masquage.

    • duration (entier) : durée de la censure, en secondes.

    • start_agent_id (entier ou null) : agent ayant lancé la rédaction.

    • end_agent_id (entier ou null) : agent qui a mis fin à la rédaction.

  • started_at (chaîne, date et heure) : code temporel du début de l'enregistrement.

• post_processed_recordings (tableau ; présent uniquement lorsque vous activez l'enregistrement post-traité dans votre compte) : enregistrements audio produits par le post-traitement (comme la conversion de format ou la rédaction).

  • id (entier) : identifiant unique de l'enregistrement post-traité.

  • call_id (entier) : identifiant de l'appel.

  • duration (entier) : durée de l'enregistrement, en secondes.

  • started_at (chaîne, date et heure) : code temporel du début de l'enregistrement.

  • recording_file_name (chaîne) : nom de fichier du composant audio post-traité.

  • recording_url (chaîne, uri) : URL du fichier audio post-traité.

  • agent_id (entier ou chaîne) : identifiant de l'agent associé au segment.

  • virtual_agent_id (entier ou chaîne) : identifiant de l'agent virtuel associé au segment, le cas échéant.

  • conversation_id (chaîne) : identifiant qui met en corrélation cet enregistrement avec son enregistrement de conversation.

• segments (tableau ; présent uniquement lorsque vous activez les enregistrements d'insights post-traités dans votre compte) : segments audio (et éventuellement d'enregistrement d'écran) par participant que le système produit pour les pipelines d'insights en aval.

  • id (entier) : identifiant unique du segment.

  • call_id (entier) : identifiant de l'appel.

  • duration (entier) : durée du segment, en secondes.

  • started_at (chaîne, date et heure) : code temporel de début du segment.

  • audio_file_name (chaîne) : nom de fichier de l'asset audio du segment.

  • audio_url (chaîne, uri) : URL du fichier audio de la séquence.

  • agent_id (entier ou chaîne) : identifiant de l'agent associé au segment.

  • virtual_agent_id (entier ou chaîne) : identifiant de l'agent virtuel associé au segment, le cas échéant.

  • participant_id (entier ou chaîne) : identifiant du participant auquel appartient le segment.

  • conversation_id (chaîne) : identifiant associant ce segment à son enregistrement de conversation.

  • screen_recording_url (chaîne, URI ou null) : URL de l'élément d'enregistrement d'écran correspondant. Disponible uniquement lorsque vous activez l'enregistrement d'écran dans votre compte.

  • screen_recording_file_name (chaîne ou null) : nom de fichier de l'enregistrement d'écran. Présenter dans les mêmes conditions que screen_recording_url.

Proposer des événements

• offer_type (chaîne ou null) : méthode utilisée par UJET pour proposer l'appel à l'agent.

• offer_events (tableau) : événements où UJET a proposé l'appel aux agents.

  • casting_time (chaîne, date et heure) : heure à laquelle UJET a proposé l'appel.

  • group (chaîne) : groupe auquel UJET a proposé l'appel.

Autres informations

• answer_type (chaîne ou null) : indique comment l'appel a été résolu ("manual" ou "auto").

• outbound_number (chaîne ou null) : numéro de téléphone sortant utilisé.

• wait_time_sms (tableau ; présent uniquement lorsque des interactions par SMS sur le temps d'attente ont eu lieu lors de cet appel) : interactions par SMS envoyées par UJET au client concernant le temps d'attente prévu. Chaque entrée contient les éléments suivants :

  • transfer_id (entier ou null) : identifiant de l'événement de transfert, s'il est associé à un transfert.

  • status (chaîne) : état du SMS. Valeurs possibles : not_triggered, triggered, triggered_allowed, triggered_denied, triggered_no_selection, triggered_sent, triggered_failed.

  • received (valeur booléenne) : indique si le consommateur a reçu le SMS.

• in_call_sms (tableau ; présent uniquement si des interactions par SMS ont eu lieu pendant cet appel) : interactions par SMS pendant l'appel. Chaque entrée contient les éléments suivants :

  • transfer_id (entier ou null) : identifiant de l'événement de transfert, s'il est associé à un transfert.

  • preset_sent (booléen) : indique si UJET a envoyé un message prédéfini.

  • custom_sent (booléen) : indique si l'agent a envoyé un message personnalisé (en texte libre).

  • received (booléen) : indique si UJET a reçu un SMS du consommateur.

• dispositions (tableau ; présent uniquement lorsque vous activez les codes ou les notes de finalisation dans votre compte) : codes et notes de finalisation enregistrés par les agents. Chaque entrée inclut des champs affichés de manière dynamique en fonction de votre configuration de finalisation :

  • user_id (entier) : identifiant de l'agent.

  • transfer_id (entier ou null) : identifiant de l'événement de transfert, s'il a été enregistré après un transfert.

  • participant_id (entier) : identifiant du participant.

  • note (chaîne) : note de l'agent en texte libre.

  • original_note (chaîne) : version d'origine (avant modification) de la note.

  • code (chaîne) : nom de code de disposition.

  • ujet_code_id (entier ou chaîne vide) : ID UJET du code de disposition, qui est une clé stable pour le code (le nom à afficher du code peut changer). Chaîne vide lorsque la valeur n'est pas disponible.

  • list (chaîne) : nom de la liste à laquelle appartient le code.

  • list_path (chaîne) : chemin d'accès à la liste des codes, séparé par des barres obliques.

  • ujet_list_id (entier ou chaîne vide) : ID UJET de la liste à laquelle appartient le code de disposition (clé stable pour la liste). Chaîne vide en cas d'indisponibilité.

  • custom_list_id (chaîne ou entier) : identifiant de la liste définie par le client, le cas échéant.

  • custom_code_id (chaîne ou entier) : identifiant de code défini par le client, s'il est mappé.

• email (chaîne, adresse e-mail ou null) : adresse e-mail du consommateur.

• feedback (chaîne ou null) : commentaires des consommateurs.

• smart_action_text (chaîne ou null) : texte de toute action intelligente effectuée.

• custom_data_secured (objet ou null) : données personnalisées et signées de manière sécurisée.

• custom_data_not_secured (objet ou null) : données personnalisées non signées de manière sécurisée.

• in_queue_wait_time_va (tableau ; présent uniquement lorsque vous activez le suivi du temps d'attente dans la file d'attente pour les agents virtuels de votre compte, et uniquement lorsqu'au moins une escalade d'agent virtuel préservé s'est produite) : intervalles de temps pendant lesquels le consommateur a attendu dans la file d'attente tandis qu'UJET lui réservait un agent virtuel après l'escalade. Chaque entrée contient les éléments suivants :

  • start (chaîne, date et heure) : date et heure du début de l'attente dans la file d'attente.

  • end (chaîne, date et heure ou null) : date et heure de fin de l'attente dans la file d'attente. La valeur est "null" si l'attente n'a pas abouti.

  • duration (entier ou nul) : durée d'attente en secondes. Nul lorsque end est nul.

• auto_session_summaries (tableau ; présent uniquement lorsque vous activez la synthèse des conversations dans votre compte et que UJET a généré une synthèse) : Synthèses de sessions générées par IA que UJET enregistre dans la fiche CRM. Chaque entrée contient les éléments suivants :

  • user_id (entier) : identifiant de l'agent participant auquel le résumé est associé.

  • participant_id (entier) : identifiant du participant.

  • session_summary (chaîne) : texte du résumé.

  • session_summary_sections (tableau ou objet) : résumé structuré en sections, le cas échéant.

• sip_headers (objet ; présent uniquement lorsque vous activez la capture des en-têtes SIP dans votre compte et que vous la configurez pour l'inclure dans les métadonnées de session) : en-têtes SIP entrants capturés par UJET pour l'appel. Les clés et les valeurs reflètent les en-têtes SIP reçus du fournisseur de téléphonie en amont.

Définitions

Cette section définit chaque sous-schéma une seule fois. Les groupes de propriétés qui font référence aux sous-schémas renvoient à ces définitions au lieu de redéfinir leurs formes en ligne.

menu_path (objet)

Décrit un chemin de menu hiérarchique emprunté par l'appel. Pour obtenir la liste complète de ses champs, consultez Navigation dans le menu.

Référence : champ menu_path de premier niveau ; chaque transfers[].from_menu_path et transfers[].to_menu_path ; chaque escalations[].from_menu_path et escalations[].to_menu_path ; chaque deflection_details[].from_menu_path et deflection_details[].to_menu_path.

agent (objet)

Décrit un agent humain. Cet objet est l'une des deux variantes du discriminateur agent_info de premier niveau (voir Racine du schéma). Pour obtenir la liste complète des champs, consultez Informations sur l'agent et l'agent virtuel.

Référence : champ agent_info lorsqu'un agent humain a traité l'appel en dernier ; chaque transfers[].from_agent et transfers[].to_agent ; chaque escalations[].to_agent.

virtual_agent (objet)

Décrit un agent virtuel. Cet objet est l'une des deux variantes du discriminateur agent_info de premier niveau (voir Racine du schéma). Pour obtenir la liste complète des champs, consultez Informations sur l'agent et l'agent virtuel.

Référence : champ agent_info lorsqu'un agent virtuel a traité l'appel en dernier ; chaque transfers[].from_virtual_agent et transfers[].to_virtual_agent ; chaque escalations[].from_virtual_agent ; chaque virtual_agent_handle_durations[].virtual_agent ; chaque virtual_agent_deflected_escalations[].virtual_agent.

deflection (chaîne, énumération)

État de la déviation d'un appel ou d'un segment d'appel. Les valeurs suivent un modèle de dénomination <trigger>_<destination>, où le préfixe identifie la condition qui a déclenché la déviation (par exemple, capacité dépassée, hors heures d'ouverture ou redirection temporaire) et le suffixe identifie la destination ou le traitement (par exemple, messagerie vocale, file d'attente, téléphone ou message).

Suffixes de destination courants :

• _phone : redirige l'appel vers un numéro de téléphone externe.

• _voicemail : redirige l'appel vers la messagerie vocale.

• _message : lit un message d'information.

• _message_only : lit un message et met fin à l'appel sans le transférer.

• _callback : propose un rappel programmé.

• _wait : l'appelant reste en attente.

• _queue : place l'appel dans une autre file d'attente.

• _sip : route l'appel vers une destination SIP.

• _extension : redirige l'appel vers un poste.

• _phone_with_extension : permet de transférer l'appel vers une destination téléphonique avec un poste.

Valeurs autorisées, regroupées par famille de déclencheurs :

• Aucune déviation : no_deflection, deflecting.

• Capacité dépassée : lorsque la file d'attente a dépassé son seuil de capacité : over_cap_phone, over_cap_voicemail, over_cap_callback, over_cap_wait, over_cap_queue, over_cap_message, over_cap_sip, over_cap_extension, over_cap_phone_with_extension.

• Hors horaires d'ouverture : l'appel a été reçu en dehors des horaires d'ouverture configurés dans le menu : after_hours_voicemail, after_hours_phone, after_hours_message_only, after_hours_queue, after_hours_message, after_hours_sip, after_hours_extension, after_hours_phone_with_extension.

• Redirection temporaire : lorsque vous configurez une redirection temporaire dans le menu : temp_redirection_phone, temp_redirection_message, temp_redirection_voicemail, temp_redirection_queue, temp_redirection_sip, temp_redirection_extension, temp_redirection_phone_with_extension.

• Pré-session RVI : ivr_presession_deflection.

• Initié par un agent virtuel : lorsqu'un agent virtuel a redirigé ou transféré l'appel : va_redirection_phone, va_redirection_sip, va_third_party_phone, va_third_party_sip.

• Appel interne en dehors des heures de bureau : internal_call_after_hours_message, internal_call_after_hours_queue, internal_call_after_hours_phone, internal_call_after_hours_extension, internal_call_after_hours_sip, internal_call_after_hours_voicemail.

• Capacité de l'appel interne dépassée : internal_call_over_capacity_message, internal_call_over_capacity_queue, internal_call_over_capacity_phone, internal_call_over_capacity_extension, internal_call_over_capacity_sip, internal_call_over_capacity_voicemail, internal_call_over_capacity_wait.

• Redirection automatique des appels internes : internal_call_automatic_redirection_message, internal_call_automatic_redirection_queue, internal_call_automatic_redirection_phone, internal_call_automatic_redirection_extension, internal_call_automatic_redirection_sip, internal_call_automatic_redirection_voicemail.

• Transfert d'appel en dehors des heures d'ouverture : call_transfer_after_hours_message, call_transfer_after_hours_queue, call_transfer_after_hours_phone, call_transfer_after_hours_extension, call_transfer_after_hours_sip, call_transfer_after_hours_voicemail.

• Capacité de transfert d'appel dépassée : call_transfer_over_capacity_message, call_transfer_over_capacity_queue, call_transfer_over_capacity_phone, call_transfer_over_capacity_extension, call_transfer_over_capacity_sip, call_transfer_over_capacity_voicemail, call_transfer_over_capacity_wait.

• Redirection automatique des transferts d'appels : call_transfer_automatic_redirection_message, call_transfer_automatic_redirection_queue, call_transfer_automatic_redirection_phone, call_transfer_automatic_redirection_extension, call_transfer_automatic_redirection_sip, call_transfer_automatic_redirection_voicemail.

• Arrêt d'urgence : lorsqu'un administrateur a déclenché un arrêt d'urgence : emergency_shutdown, emergency_shutdown_message, emergency_shutdown_after_hours, emergency_shutdown_over_capacity.

• Routage dynamique des appels (RDA) : dcr_transferred, dcr_missed, dcr_redirected, dcr_finished.

Référence : champ deflection de premier niveau ; chaque deflection_details[].deflection ; chaque transfers[].deflection.

Gestion des versions et obsolescence

Le schéma de métadonnées de session d'appel est compatible avec l'évolution. UJET peut ajouter de nouveaux champs et tableaux à tout moment. Les intégrations doivent ignorer les clés non reconnues pour assurer la continuité des fonctionnalités. Les champs de cette section sont obsolètes, anciens ou ont été remplacés. Ils restent dans la charge utile pour assurer la rétrocompatibilité, mais les nouvelles intégrations doivent suivre les consignes pour chaque champ.

Champs obsolètes

• voip_provider (chaîne) : obsolète. Renvoie toujours la chaîne littérale "deprecated". UJET ne fournit plus d'informations sur les fournisseurs aux intégrations via ce document. Il n'existe pas de champ de remplacement. Si votre intégration doit identifier le fournisseur de téléphonie en amont, contactez votre équipe chargée du compte.

Anciens doublons

• session_type (chaîne) : ancien alias de call_type. Renvoie toujours la même valeur que call_type et utilise le même vocabulaire d'énumération hérité. UJET conserve ce champ pour assurer la rétrocompatibilité avec les intégrations qui utilisent session_type comme clé. Les nouvelles intégrations doivent analyser call_type directement ou, pour des distinctions entrantes plus précises, session_type_v2 (voir Évolution du vocabulaire ci-dessous).

Évolution du vocabulaire

call_type et session_type_v2 décrivent le même type d'appel sous-jacent à l'aide de deux vocabulaires différents. UJET émet les deux champs dans chaque enregistrement. Ils ne sont pas identiques :

• call_type utilise l'ancien vocabulaire d'énumération. Les valeurs telles que Voice Inbound (App) et Voice Inbound (IVR using App) couvrent toutes les origines de SDK mobiles et intégrés aux applications sous un seul libellé. call_type n'est pas obsolète. UJET continuera d'émettre ce champ, mais son vocabulaire ne gagnera pas de nouvelles valeurs précises.

• session_type_v2 utilise le vocabulaire d'énumération actuel. Il introduit des distinctions plus précises pour les appels entrants (par exemple, Voice Inbound (Mobile) et Voice Inbound (IVR using Mobile)) pour les types d'appels qui ont des valeurs spécifiques à la version 2. Pour les types d'appel qui n'ont pas de valeur spécifique à la version 2, session_type_v2 renvoie la même chaîne que call_type.

Les nouvelles intégrations doivent analyser session_type_v2. Les valeurs de chaque champ sont listées dans Informations de base.

Nomenclature des champs de temps d'attente

Le document de métadonnées de la session d'appel indique le temps d'attente dans la file d'attente à deux niveaux, sous deux noms de champs :

• "Temps total d'appel" : le champ wait_duration de premier niveau indique le temps total passé par le consommateur en file d'attente pendant l'appel.

• Par segment : chaque entrée du tableau queue_durations de premier niveau (Durées des files d'attente) possède son propre champ queue_duration, qui contient la durée de la file d'attente pour ce segment spécifique.

Les deux noms font référence au même type de mesure (le temps passé dans la file d'attente), mais à des niveaux différents. Le total des appels wait_duration reflète le temps d'attente global du consommateur, tandis que les valeurs queue_duration par segment décrivent chaque segment de file d'attente. Ce document n'émet pas de champ queue_duration de premier niveau distinct. Les valeurs par segment ne sont disponibles que dans queue_durations.