Métadonnées de la transcription du chat

Ce document explique le schéma JSON utilisé pour structurer les métadonnées des transcriptions de chat. Ce schéma est nécessaire pour représenter et traiter précisément les conversations par chat.

Schéma des métadonnées de transcription de chat

Ce schéma décrit la structure des données des transcriptions de chat. Les composants principaux sont décrits dans les sections suivantes :

Informations essentielles sur la transcription

Les propriétés suivantes fournissent les informations de base sur la transcription elle-même :

• comm_type (chaîne). Type de communication auquel appartient cette transcription. Il peut s'agir d'un chat ou d'un appel pour les appels avec fonctionnalité SMS combinée.

• comm_id (entier). Identifiant de la communication (par exemple, chat ou appel) à laquelle cette transcription est associée.

• transcript_version (chaîne). Version du format de transcription. Cette opération est nécessaire pour la rétrocompatibilité lors de l'analyse des transcriptions.

• assigned_at (chaîne, date et heure). Horodatage de l'attribution du chat.

• timezone (chaîne). Fuseau horaire dans lequel la discussion a eu lieu.

Définitions des messages

La section definitions contient des composants de schéma réutilisables qui définissent la structure des différents types de messages dans la transcription. Cela permet de gérer différents formats de contenu de manière flexible :

• text (objet) : représente un message texte

  • type (chaîne) : doit être "text"

  • content (chaîne) : contenu textuel du message

  • lang (chaîne) : langue du contenu textuel

• text_template (objet) : représente un message texte basé sur un modèle

  • type (chaîne) : doit être text_template

  • content (chaîne) : contenu du modèle de texte, qui peut inclure des espaces réservés

• markdown (objet) : représente un message utilisant la mise en forme Markdown.

  • type (chaîne) : doit être Markdown

  • content (chaîne) : contenu du modèle Markdown

• markdown_template (objet) : représente un message Markdown basé sur un modèle

  • type (chaîne) : doit être markdown_template.

  • content (chaîne) : contenu du modèle Markdown, éventuellement avec des espaces réservés

• photo (objet) : représente un message contenant une photo.

  • type (chaîne) : doit être photo

  • media_id (entier) : ID du fichier multimédia de la photo

• video (objet) : représente un message contenant une vidéo.

  • title (chaîne) : titre de la vidéo

  • video (objet) : informations sur la vidéo

    • url (string) : URL de la vidéo

    • text (chaîne) : texte alternatif à l'URL de la vidéo

  • media_id (entier) : ID du contenu multimédia permettant de récupérer l'URL de la vidéo si elle n'est pas fournie directement

• image (objet) : représente un message contenant une image.

  • title (chaîne) : titre de l'image

  • image (objet) : détails sur l'image

    • url (chaîne) : URL de l'image

    • text (chaîne) : texte alternatif à l'URL de l'image

• document (objet) : représente un message contenant un document.

  • title (chaîne) : titre du document

  • document (objet) : détails sur le document

    • url (chaîne) : URL du document.

    • text (chaîne) : texte alternatif à l'URL du document

• inline_button (objet) : représente un ensemble de boutons intégrés.

  • title (chaîne) : titre de l'ensemble de boutons intégrés

  • buttons (tableau) : tableau d'objets bouton

    • title (chaîne) : titre du bouton

    • action (chaîne) : nom de l'action indiquée par le bouton

    • link (chaîne) : lien URL pour les actions de lien de réponse rapide

• sticky_button (objet) : représente un ensemble de boutons fixes.

  • title (chaîne) : titre de l'ensemble de boutons fixes

  • buttons (tableau) : tableau d'objets bouton

    • title (chaîne) : titre du bouton

    • action (chaîne) : nom de l'action indiquée par le bouton

    • link (chaîne) : lien URL pour les actions de lien de réponse rapide

• content_card (objet) : représente une fiche de contenu.

  • cards (tableau) : tableau d'objets de carte de contenu

    • title (chaîne) : titre de la fiche de contenu

    • body (chaîne) : corps de texte de la fiche de contenu

• server_message (objet) : représente un message récupéré depuis le serveur

  • message_id (entier) : ID du message serveur stocké

  • content (chaîne) : contenu du message récupéré depuis le serveur

• action (objet) : représente une action effectuée pendant le chat. Il peut s'agir de l'un des éléments suivants :

  • action_escalation (objet) : représente une action d'escalade

    • action (chaîne) : doit être "escalation"

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

    • menu_id (entier) : ID auquel la communication doit être escaladée.

    • language (chaîne) : code de langue ISO 689 de la file d'attente vers laquelle transférer la demande

  • action_deflection (objet) : représente une action de déviation.

    • action (chaîne) : doit être deflection

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

    • sip_parameters (objet ou null) : paramètres SIP à transférer dans le cadre de la redirection, le cas échéant

  • action_end (objet) : représente une action de fin

    • action (chaîne) : doit être end

• noti (objet) : représente un message de notification. Il peut s'agir de différents types de notifications :

  • noti_transfer_started (objet) : notification de début d'un transfert.

    • type (chaîne) : doit être noti

    • event (chaîne) : doit être "transferStarted"

    • target (chaîne) : destination cible du transfert, par exemple un menu ou un agent.

    • agent (objet) : agent ayant lancé le transfert

      • id (entier) : ID de l'agent

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

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

  • noti_verification_requested (objet) : notification pour une demande de validation

  • type (chaîne) : doit être noti

  • event (chaîne) : doit être verificationRequested

  • agent (objet) : agent demandant la validation

    • id (entier) : ID de l'agent demandant la validation

    • email (chaîne) : adresse e-mail de l'agent demandant la validation

    • name (chaîne) : nom de l'agent qui demande la validation

  • noti_end_user_verified (objet) : notification lorsqu'un utilisateur final est validé

    • type (chaîne) : doit être noti

    • event (chaîne) : doit être endUserVerified

  • Les autres types noti_\* définissent les notifications pour divers événements tels que les demandes de photos, les demandes de vidéos, les événements de navigation conjointe, les événements d'agent virtuel de tâches, l'arrivée d'un agent, ainsi que les changements d'état de transfert ou d'escalade.

  • noti_custom (objet) : représente une notification personnalisée.

    • type (chaîne) : doit être noti

    • event (chaîne) : doit être custom

    • detail (objet) : détails de l'événement personnalisé

    • key (chaîne) : clé représentant le détail de l'événement personnalisé

    • data (objet) : charge utile d'événement définie sur mesure

Entrées de transcription

• entries (tableau) : tableau d'objets, où chaque objet représente un message individuel envoyé dans le chat.

  • timestamp (chaîne) : code temporel de l'envoi du message

  • type (chaîne) : type de message, faisant référence à l'une des définitions décrites précédemment, par exemple text, photo ou noti.

  • body (objet) : contenu du message, conforme à la structure définie par le type de message. Il utilise oneOf pour s'adapter à différentes morphologies.

  • role (chaîne) : rôle du participant qui a envoyé le message. Les valeurs possibles sont end_user, agent, manager, virtual_agent, external_agent, task_virtual_agent et system.

  • user_data (objet) : données de l'utilisateur qui a envoyé le message, sauf s'il s'agit d'un message système ou d'un message destiné à l'utilisateur final.

    • name (chaîne) : nom de l'utilisateur

    • id (entier) : ID unique de l'utilisateur

  • avatar_url (chaîne) : URL de stockage de l'avatar de l'utilisateur