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 que la plate-forme CCAI émet à la fin de chaque appel vocal. CCAI Platform 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 en tant que fichier metadata.json. Chaque appel produit exactement un enregistrement. Le 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 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 instance. Il existe un enregistrement par appel. Tous les autres champs, tableaux et objets imbriqués de premier niveau décrivent les attributs de l'appel identifié par ce id.

Discriminateur de gestionnaire — agent_info (objet, oneOf)

Objet unique dont la forme varie en fonction du dernier gestionnaire de l'appel. Les deux variantes s'excluent mutuellement, et la clé peut également être complètement absente. Un enregistrement ne comporte donc au plus qu'un des trois cas suivants :

  • Variante d'agent humain : présente lorsque l'appel a été traité par un agent humain et non par un agent virtuel. 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 lorsque l'appel a été géré par un agent virtuel et non par un agent humain. Transmet va_alias et omet email, first_name, last_name et agent_number.

  • Clé absente : la clé agent_info est omise dans deux cas : lorsque l'appel n'avait ni agent humain ni agent virtuel, et lorsqu'il avait les deux. Un appel comporte les deux lorsqu'un agent virtuel est conservé lors d'une escalade vers un agent humain. Un appel entièrement géré peut donc arriver sans la clé.

Pour détecter la variante d'un enregistrement, vérifiez d'abord si la clé agent_info est présente, puis recherchez 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). Ne déduisez pas le gestionnaire uniquement à partir de agent_info. Pour un appel qui comporte les deux, lisez l'agent humain à partir de participants[] et l'agent virtuel à partir de virtual_agent_handle_durations[] ou des champs from_virtual_agent et to_virtual_agent sur transfers[] et escalations[]. Pour connaître la forme complète de chaque variante, consultez agent et virtual_agent.

Discriminateurs 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. Ils ne sont jamais en désaccord sur le type d'appel représenté par un enregistrement. Ils ne diffèrent que par le vocabulaire qu'ils utilisent pour nommer le type d'appel.

  • call_type utilise l'ancien vocabulaire d'énumération (par exemple, Voice Inbound (App), Voice Outbound ou Voice Internal).

  • session_type renvoie toujours la même chaîne que call_type. CCAI Platform fournit ce champ pour assurer la rétrocompatibilité avec les intégrations qui s'appuient sur ce champ. Considérez-le comme un alias obsolète de call_type. Consultez Gestion des versions et abandons.

  • session_type_v2 utilise le vocabulaire d'énumération actuel. Ce vocabulaire étend le vocabulaire call_type avec des distinctions entrantes plus précises, par exemple Voice Inbound (Mobile) et Voice Inbound (IVR via Mobile) au lieu des termes plus larges Voice Inbound (App) et Voice Inbound (IVR via App). Pour les types d'appels qui n'ont pas de valeur spécifique à la v2, 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 principales de l'appel :

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

  • call_uuid (chaîne ou valeur nulle) : identifiant unique qui met en corrélation un appel entre les instances d'origine et de réception dans les interactions de routage d'appel dynamique (DCR). Les deux segments d'un appel DCR partagent la même valeur call_uuid, ce qui permet aux clients de transférer des données entre les environnements. Le champ est nul ou vide pour tout appel qui n'est pas une interaction DCR, ainsi que pour les appels qui ont eu lieu avant que CCAI Platform 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 des rapports spécifiques à une langue.

  • call_type (chaîne) : type d'appel, à l'aide de l'ancien vocabulaire de type. Les valeurs incluent "Voice Inbound (App)", "Voice Inbound (Web)", "Voice Inbound (IVR)", "Voice Inbound (IVR via App)", "Voice Inbound (API)", "Voice Inbound (Direct)", "Voice Inbound (Extension)", "Voice Scheduled (App)", "Voice Scheduled (Web)", "Voice Scheduled (API)", "Voice Callback", "Voice Callback (Web)", "Voice Outbound", "Voice Outbound (API)", "Voice Outbound (Direct)", "Voice Outbound (UCaaS)", "Voice Internal", "Voice Campaign (Acqueon)", "Voice Campaign (<nom de votre marque>)" et "Agent Scheduled Call".

  • session_type (chaîne) : double de call_type (mêmes valeurs) que CCAI Platform conserve pour assurer la rétrocompatibilité. Consultez Gestion des versions et abandons : anciens doublons.

  • session_type_v2 (chaîne) : type d'appel, en utilisant le vocabulaire de type actuel. Il affine les valeurs call_type avec des distinctions entrantes plus précises (par exemple, "Voice Inbound (Mobile)" et "Voice Inbound (IVR via Mobile)" au lieu de "Voice Inbound (App)" et "Voice Inbound (IVR via App)"). Les valeurs incluent "Voice Inbound (Mobile)", "Voice Inbound (Web)", "Voice Inbound (IVR)", "Voice Inbound (IVR via Mobile)", "Voice Inbound (API)", "Voice Inbound (Direct)", "Voice Inbound (Extension)", "Voice Scheduled (Mobile)", "Voice Scheduled (Web)", "Voice Scheduled (API)", "Voice Callback", "Voice Callback (Web)", "Voice Outbound", "Voice Outbound (API)", "Voice Outbound (Direct)", "Voice Outbound (UCaaS)", "Voice Internal", "Voice Campaign (Acqueon)", "Voice Campaign (<nom de votre marque>)" et "Agent Scheduled Call".

  • status (chaîne) : état de l'appel, qui suit sa progression tout au long de son cycle de vie. Valeurs possibles, regroupées par phase du cycle de vie :

    • Préconnexion : "scheduled", "selecting", "queued", "assigned", "connecting", "switching", "requeued", "requeued_detection_missed".

    • Connecté : "connected".

    • Agent virtuel : "va_assigned", "va_connected".

    • Campagne : "preview_pending", "preview_ready", "preview_waiting", "predictive_waiting", "progressive_waiting", "campaign_dialing", "campaign_connecting", "campaign_connected".

    • Action uniquement : "action_only", "action_only_finished".

    • Messagerie vocale : "voicemail", "voicemail_received", "voicemail_read", "voicemail_forwarded".

    • Terminal : "finished", "failed", "recovered", "deflected".

  • created_at (chaîne, date-heure) : code temporel précis de la création de l'enregistrement d'appel par CCAI Platform.

  • queued_at (chaîne, date-heure ou valeur nulle) : code temporel de l'entrée de l'appel dans la file d'attente, ou valeur nulle si l'appel n'est pas entré dans la file d'attente.

  • assigned_at (chaîne, date-heure ou valeur nulle) : code temporel indiquant quand CCAI Platform a attribué l'appel à un agent, ou valeur nulle si CCAI Platform n'a pas attribué l'appel.

  • connected_at (chaîne, date-heure ou valeur nulle) : code temporel de l'établissement de l'appel.

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

  • scheduled_at (chaîne, date-heure ou valeur nulle) : code temporel indiquant quand CCAI Platform a planifié l'appel, ou valeur nulle si l'appel était immédiat.

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

  • wait_duration (entier ou valeur nulle) : temps total passé par le client dans la file d'attente pendant l'appel, en secondes, ou valeur nulle si CCAI Platform n'a enregistré aucun temps d'attente. Pour connaître le temps d'attente par segment, consultez le tableau queue_durations (Durées d'attente). Consultez Gestion des versions et abandons : nomenclature du champ de temps d'attente.

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

  • hold_duration (entier ou valeur nulle) : durée totale pendant laquelle le client a été mis en attente, en secondes, ou valeur nulle s'il n'y a pas eu de temps d'attente.

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

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

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

  • out_ticket_id (chaîne ou valeur nulle) : ID de la demande d'assistance créée par la plate-forme CCAI dans le système CRM externe.

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

  • is_out_ticket_account (booléen ou nul) : indique si la demande CRM représente un client (true) ou une interaction d'appel (false).

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

  • recording_url (chaîne, URI ou valeur nulle) : 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. Valeurs possibles : "not_asked", "granted", "denied".

  • voicemail_reason (chaîne) : raison pour laquelle un message vocal a été laissé, ou "not_voicemail" lorsque l'appel n'a pas été redirigé vers la messagerie vocale. Valeurs possibles : "not_voicemail", "temporary_redirection", "after_hour_deflection", "over_capacity_deflection", "no_input" et "no_agent".

  • disconnected_by (chaîne ou valeur nulle) : 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 "nothing" pour les appels qui n'ont pas échoué. Valeurs possibles, regroupées par partie ou sous-système auquel l'échec est attribué :

    • Aucun échec : nothing

    • Général : unknown, expired, transfer_expired, canceled_outside_fulfillment_hours

    • Utilisateur final : eu_canceled, eu_rejected, eu_abandoned, eu_in_menu_abandoned, eu_repeated_voicemail, eu_repeated_callback, eu_dcr_abandoned_on_receiving, eu_busy, eu_wrong_number, eu_no_answer, eu_noti_failed, eu_phone_denied

    • Agent : ag_canceled, ag_ignored, ag_declined, ag_mic_no_device, ag_mic_denied, ag_invalid_outbound_num, ag_called_blocked_num

    • Connexion : conn_decline

    • VoIP : voip_twilio_error, voip_tokbox_error, voip_invalid_token, voip_conn_general, voip_conn_timeout, voip_conn_signal, voip_conn_codec, voip_nexmo_error, voip_telnyx_error

    • Audio : audio_not_received_by_carrier, audio_device_unable_to_start

    • État bloqué ou impossible à résoudre : stuck_due_to_api_error, group_deleted_no_substitute, menu_deleted, direct_pstn_call_to_fallback_number

    • Campagne : campaign_paused, campaign_queue_reassigned, campaign_no_incoming_contacts, campaign_call_canceled

    • Arrêt forcé : force_ended, force_failed_call_stuck

  • fail_details (chaîne ou valeur nulle) : détails supplémentaires lisibles par l'humain accompagnant fail_reason, lorsqu'ils sont disponibles.

  • adapter_fail_code (entier ou nul) : code numérique correspondant à fail_reason au niveau de l'appel. Valeur nulle 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 valeur nulle) : message lisible par l'humain correspondant à adapter_fail_code. Valeur nulle lorsque l'appel n'a pas échoué.

  • support_number (chaîne ou valeur nulle) : numéro de téléphone composé par le client pour joindre le centre de contact, au format E.164. Renseigné pour les appels provenant d'un système de réponse vocale interactive ; peut être nul pour les autres canaux.

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

Informations sur l'agent et l'agent virtuel

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) : identifiant unique de l'agent.

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

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

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

      • last_name (chaîne) : nom 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 valeur nulle) : URL de l'image de l'avatar de l'agent virtuel.

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

  • selected_menu (objet ou valeur nulle) : informations sur le menu sélectionné par le client pendant l'appel.

    • id (entier) : identifiant unique du menu.

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

    • parent_id (entier ou nul) : 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 valeur nulle) : décrit le chemin hiérarchique des menus parcourus par le client.

    • 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, "Assistance/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 déviation 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 (chaîne) : libellé lisible par l'humain pour le groupe de redirection (par exemple, "Groupe de redirection 1").

      • destination (objet ou valeur nulle) : destination de la redirection que vous avez configurée sur le groupe.

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

      • ah_destination (objet ou valeur nulle) : 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 valeur nulle) : informations sur le consommateur :

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

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

    • out_contact_id (chaîne ou valeur nulle) : ID du client 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 client a 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 les incluez dans les métadonnées) : instantané des valeurs des paramètres de données de l'appel. 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 client a envoyé au moins une réponse à un formulaire) : réponses collectées par les formulaires du SDK pendant l'appel au cours de la session. 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 (entier ou nul) : 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 client a importées 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 valeur nulle) : action intelligente qui a produit la photo, le cas échéant.

    • transfer_id (entier ou valeur nulle) : ID de l'événement de transfert de la photo, si le client l'a importée après un transfert.

  • videos (tableau) : vidéos que le client a importées pendant l'appel.

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

    • url (chaîne, URI) : URL de la vidéo stockée.

    • smart_action_type (chaîne ou valeur nulle) : action intelligente qui a produit la vidéo, le cas échéant.

    • transfer_id (entier ou valeur nulle) : ID de l'événement de transfert de la vidéo, si le consommateur l'a importée après un transfert.

Déviation des appels

  • deflection (chaîne) : indique si l'appel a été dévié 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 valeur nulle) : 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-heure) : code temporel de la déviation.

    • from_menu_path (objet ou valeur nulle) : chemin du menu à partir duquel la déviation a commencé.

    • to_menu_path (objet ou valeur nulle) : chemin d'accès au menu vers lequel CCAI Platform a dévié l'appel.

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

    • to_sip_headers (objet ; présent uniquement lorsque CCAI Platform a redirigé l'appel vers une destination SIP) : en-têtes SIP avec lesquels CCAI Platform 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 annoncés et non annoncés 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 de transfert, connecté ou échec).

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

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

    • assigned_at (chaîne, date-heure ou valeur nulle) : date et heure auxquelles CCAI Platform a attribué le transfert au destinataire.

    • connected_at (chaîne, date-heure ou valeur nulle) : date et heure de connexion du transfert.

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

    • call_duration (entier) : durée d'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 valeur nulle) : chemin décrivant la résolution de l'appel transféré.

    • from_menu_path / to_menu_path (objet ou valeur nulle) : 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 valeur nulle) : 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 valeur nulle) : agent virtuel de chaque côté du transfert ; même forme que l'objet virtual_agent dans Définitions.

    • from_queue_priority_level / to_queue_priority_level (entier ou nul) : priorité de la file d'attente avant et après le transfert. Cette colonne n'est présente que si vous activez la priorité de la 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 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 pendant ce segment.

    • menu_path_id (entier ou nul) : ID du chemin d'accès au menu.

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

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

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

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

    • transfer_id (entier ou valeur nulle) : ID du transfert.

    • transfer_cold (booléen ou nul) : indique si le transfert était à froid.

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

    • ended_at (chaîne, date-heure ou valeur nulle) : code temporel de fin.

    • scheduled_at (chaîne, date-heure ou valeur nulle) : code temporel planifié.

    • hold_duration (entier ou valeur nulle) : 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é transmis à un agent indisponible) : détails sur l'attribution de l'appel transmis à un agent indisponible, le cas échéant.

Durées de la file d'attente

  • queue_durations (tableau) : tableau d'objets, chacun représentant un segment de l'appel où le client é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-heure) : code temporel de fin.

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

    • menu_path_id (entier) : ID du chemin d'accès au menu.

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

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

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

    • transfer_cold (booléen) : indique si l'appel a été transféré sans annonce.

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

    • transfer_id (entier ou valeur nulle) : 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 de niveau de service ("excluded", "in_sla", "not_in_sla").

    • service_level_target_percent (entier) : pourcentage cible pour la 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 de l'escalade. Valeurs possibles : escalating, "escalated", "canceled", "deflecting" et "deflected".

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

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

    • escalated_at (chaîne, date-heure ou valeur nulle) : date et heure de fin de l'escalade.

    • from_virtual_agent (objet ou valeur nulle) : agent virtuel qui a escaladé l'appel. Même forme que l'objet virtual_agent dans Définitions.

    • to_agent (objet ou valeur nulle) : agent humain vers lequel l'appel a été escaladé. Même forme que l'objet agent dans Définitions.

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

Escalades évitées par l'agent virtuel

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

    • id (entier) : identifiant unique.

    • deflection (chaîne) : type de déviation enregistré pour l'escalade déviée. Ce vocabulaire est plus restreint que celui du champ de déviation au niveau de l'appel décrit dans Définitions : déviation. Il ne couvre que les résultats qu'une escalade d'agent virtuel peut enregistrer. Valeurs possibles :

      • Surcapacité : over_cap, over_cap_phone, over_cap_voicemail, over_cap_callback, over_cap_message, over_cap_queue, over_cap_sip, over_cap_extension, over_cap_phone_with_extension

      • En dehors des heures d'ouverture : after_hours, after_hours_phone, after_hours_voicemail, after_hours_message, after_hours_message_only, after_hours_queue, after_hours_sip, after_hours_extension, after_hours_phone_with_extension

      • Redirection temporaire : temp_redirection, temp_redirection_phone, temp_redirection_voicemail, temp_redirection_message, temp_redirection_queue, temp_redirection_sip, temp_redirection_extension, temp_redirection_phone_with_extension

      • Pré-session IVR : ivr_presession_deflection

      • Lancé par un agent virtuel : va_redirection_phone, va_redirection_sip, va_third_party_phone, va_third_party_sip

      Les valeurs sans suffixe over_cap, after_hours et temp_redirection sont enregistrées lorsque l'appel s'est terminé avant qu'un résultat de déviation ne soit atteint.

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

    • escalation_reason (chaîne) : motif de l'escalade.

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

    • menu_path_id (entier) : ID du chemin d'accès au menu.

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

    • lang (chaîne) : langue.

    • virtual_agent (objet) : détails de l'agent virtuel. Consultez la section Définitions.

Durées de traitement des agents virtuels

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

    • id (entier) : identifiant unique.

    • virtual_agent (objet) : détails de l'agent virtuel. Consultez la section Définitions.

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

    • escalation_reason (chaîne) : motif de l'escalade.

    • 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) : comment la session de l'agent virtuel a démarré.

    • menu_path_id (entier) : ID du chemin d'accès au menu.

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

    • lang (chaîne) : langue.

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

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

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

    • ended_at (chaîne, date-heure ou valeur nulle) : code temporel de fin.

Durées de traitement des consommateurs

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

    • id (entier) : identifiant unique.

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

    • hold_duration (entier ou valeur nulle) : durée de conservation du consommateur.

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

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

Durées des événements de consommation

  • consumer_event_durations (tableau) : détails des événements d'appel du client (par exemple, CSAT ou 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 d'accès au menu.

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

    • lang (chaîne) : langue.

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

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

Durées de consultation du menu par les consommateurs

  • 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 d'accès au menu.

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

    • lang (chaîne) : langue.

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

    • ended_at (chaîne, date-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 (chaîne) : type de participant ("end_user", "agent", "virtual_agent", etc.).

    • entry_type (chaîne) : mode de participation à l'appel.

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

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

    • virtual_agent_id (entier ou valeur nulle) : 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 d'agent virtuel à inclure) : 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-heure ou valeur nulle) : code temporel de la connexion du participant.

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

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

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

    • hold_duration (entier ou valeur nulle) : durée de mise en attente du participant.

    • ended_at (chaîne, date-heure ou valeur nulle) : code temporel de la fin de la participation du participant.

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

    • adapter_fail_message (chaîne ou valeur nulle) : description lisible par l'humain de fail_reason, le cas échéant.

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

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

    • caller_id (chaîne ; présent uniquement lorsque vous activez l'ID d'appelant de l'en-tête SIP sur votre compte, et uniquement sur les participants consommateurs) : ID d'appelant que la plate-forme CCAI extrait des en-têtes SIP entrants pour ce participant consommateur.

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

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

    • location_id (entier ou valeur nulle ; présent uniquement pour les participants de type agent) : ID de l'emplacement.

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

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

    • last_name (chaîne ou valeur nulle ; présent uniquement pour les participants de type agent) : nom de l'agent.

    • middle_name (chaîne ou valeur nulle ; présent uniquement pour les 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 audio de l'appel.

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

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

    • conference_sid (chaîne ou valeur nulle) : 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 de temps masqués.

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

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

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

      • start_agent_id (entier ou valeur nulle) : agent qui a lancé le masquage.

      • end_agent_id (entier ou valeur nulle) : agent qui a mis fin au masquage.

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

  • post_processed_recordings (tableau ; présent uniquement lorsque vous activez l'enregistrement post-traité sur votre compte) : enregistrements audio produits par le post-traitement (par exemple, conversion de format ou occultation).

    • 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-heure) : code temporel du début de l'enregistrement.

    • recording_file_name (chaîne) : nom de fichier de l'élément 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 sur votre compte) : segments audio (et enregistrement d'écran facultatif) 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-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 du segment.

    • 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 le segment appartient.

    • conversation_id (chaîne) : identifiant mettant en corrélation ce segment avec son enregistrement de conversation.

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

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

Proposer des événements

  • offer_type (chaîne ou valeur nulle) : comment CCAI Platform a proposé l'appel à l'agent.

  • offer_events (tableau) : événements lorsque CCAI Platform a proposé l'appel aux agents.

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

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

Autres informations

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

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

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

    • transfer_id (entier ou valeur nulle) : 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 (booléen) : indique si le client a reçu le SMS.

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

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

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

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

    • received (booléen) : indique si CCAI Platform a reçu un SMS du client.

  • dispositions (tableau ; présent uniquement lorsque vous activez les codes ou les notes de finalisation sur 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 valeur nulle) : identifiant de l'événement de transfert, s'il est 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 de plate-forme CCAI du code de disposition, une clé stable pour le code (le nom à afficher du code peut changer). Chaîne vide si non disponible.

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

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

    • ujet_list_id (entier ou chaîne vide) : ID CCAI Platform de la liste à laquelle appartient le code de disposition (clé stable pour la liste). Chaîne vide lorsqu'elle n'est pas disponible.

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

    • 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 valeur nulle) : adresse e-mail du client.

  • feedback (chaîne ou valeur nulle) : commentaires des clients.

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

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

  • custom_data_not_secured (objet ou valeur nulle) : données personnalisées signées de manière non 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 sur votre compte, et uniquement lorsqu'au moins une escalade d'agent virtuel préservé s'est produite) : intervalles de temps pendant lesquels le client a attendu dans la file d'attente pendant que CCAI Platform lui réservait un agent virtuel après l'escalade. Chaque entrée contient les éléments suivants :

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

    • end (chaîne, date-heure ou valeur nulle) : date et heure de fin de l'attente dans la file d'attente ; valeur nulle si l'attente n'est pas terminée.

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

  • auto_session_summaries (tableau ; présent uniquement lorsque vous activez la synthèse des conversations sur votre compte et que CCAI Platform a généré un résumé) : résumés de session générés par l'IA que CCAI Platform enregistre dans l'enregistrement CRM. Chaque entrée contient les éléments suivants :

    • user_id (entier) : identifiant du participant agent 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é dans des sections structurées, si disponible.

  • sip_headers (objet ; présent uniquement lorsque vous activez la capture d'en-têtes SIP sur votre compte et que vous la configurez pour qu'elle soit incluse dans les métadonnées de session) : en-têtes SIP entrants capturés par la plate-forme CCAI 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 plutôt que de redéfinir leurs formes de manière intégrée.

Décrit un chemin de menu hiérarchique que l'appel a parcouru. Consultez Navigation dans le menu pour obtenir la liste complète de ses champs.

Référencé depuis : le 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 de ses champs, consultez Informations sur l'agent et l'agent virtuel.

Référencé depuis : le champ agent_info lorsqu'un agent humain a géré 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). Consultez Informations sur l'agent et l'agent virtuel pour obtenir la liste complète de ses champs.

Référencé depuis : le champ agent_info lorsqu'un agent virtuel a géré 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 déviation d'un appel ou d'un segment d'appel. Les valeurs suivent un modèle de dénomination &lt;trigger&gt;_&lt;destination&gt;, où le préfixe identifie la condition qui a déclenché la déviation (par exemple, surcapacité, heures de fermeture 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 : l'appel est acheminé vers un numéro de téléphone externe.

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

  • _message : diffuse un message d'information.

  • _message_only : diffuse un message et met fin à l'appel sans autre routage.

  • _callback : propose un rappel programmé.

  • _wait : met l'appelant en attente.

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

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

  • _extension : redirige l'appel vers une extension.

  • _phone_with_extension : achemine l'appel vers une destination téléphonique avec une extension.

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

  • Aucune déviation : no_deflection, deflecting.

  • Surcapacité : 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_ewt_only, over_cap_sip, over_cap_extension, over_cap_phone_with_extension.

  • Déviation abandonnée : lorsqu'un transfert ou un appel s'est terminé avant que la déviation en attente ne soit résolue : deflection_abandoned.

  • En dehors des horaires d'ouverture : lorsque l'appel est arrivé en dehors des horaires d'ouverture configurés du 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 IVR : ivr_presession_deflection.

  • Initiée 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 d'ouverture : 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.

  • Surcapacité des appels internes : 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 horaires 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.

  • Surcapacité de transfert d'appel : 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 (DCR) : dcr_transferred, dcr_missed, dcr_redirected, dcr_finished.

Référencé depuis : chaque deflection_details[].deflection, qui utilise l'intégralité de ce vocabulaire. Deux autres champs s'appuient chacun sur un sous-ensemble de ces données :

  • Le champ deflection de premier niveau utilise toutes les valeurs, à l'exception de over_cap_ewt_only et temp_redirection_url.

  • Chaque transfers[].deflection utilise un sous-ensemble plus petit limité au transfert : no_deflection, deflecting, deflection_abandoned, les dix valeurs over_cap_*, les huit valeurs after_hours_*, les sept valeurs temp_redirection_* autres que temp_redirection_url, ivr_presession_deflection, va_redirection_phone et va_redirection_sip. Les familles internal_call_*, call_transfer_*, emergency_shutdown_*, dcr_* et va_third_party_* n'apparaissent jamais lors d'un transfert.

Gestion des versions et abandons

Le schéma des métadonnées de session d'appel est rétrocompatible. CCAI Platform 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 remplacés de manière non stricte. Ils restent dans la charge utile pour assurer la rétrocompatibilité, mais les nouvelles intégrations doivent suivre les instructions pour chaque champ.

Champs obsolètes

  • voip_provider (chaîne) : obsolète. Renvoie toujours la chaîne littérale "deprecated". CCAI Platform ne transmet plus les informations sur le fournisseur 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 l'équipe chargée de votre 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é. CCAI Platform conserve ce champ pour assurer la rétrocompatibilité avec les intégrations qui utilisent session_type. 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. CCAI Platform émet les deux champs sur chaque enregistrement. Ils ne sont pas des doublons l'un de l'autre :

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

  • session_type_v2 utilise le vocabulaire d'énumération actuel. Il introduit des distinctions entrantes plus précises (par exemple, Voice Inbound (Mobile) et Voice Inbound (IVR via Mobile)) pour les types d'appels ayant des valeurs spécifiques à la v2. Pour les types d'appels qui n'ont pas de valeur spécifique à la v2, 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 du champ "Temps d'attente"

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

  • Total de l'appel : le champ wait_duration de premier niveau contient le temps total passé par le client dans la file d'attente pendant l'intégralité de l'appel.

  • Par segment : chaque entrée du tableau queue_durations de premier niveau (Durées de file d'attente) comporte son propre champ queue_duration, qui contient le temps d'attente pour ce segment de file d'attente individuel.

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 client, tandis que les valeurs queue_duration par segment décrivent chaque segment de la file d'attente. Ce document n'émet pas de champ queue_duration distinct de premier niveau. Les valeurs par segment ne sont disponibles que dans queue_durations.