Metadati della trascrizione della chat

Questo documento spiega lo schema JSON utilizzato per strutturare i metadati delle trascrizioni delle chat. Questo schema è necessario per rappresentare ed elaborare con precisione le conversazioni di chat.

Schema dei metadati della trascrizione della chat

Questo schema descrive la struttura dei dati delle trascrizioni delle chat. I componenti principali sono descritti nelle sezioni seguenti:

Informazioni principali sulla trascrizione

Le seguenti proprietà forniscono le informazioni fondamentali sulla trascrizione stessa:

  • comm_type (stringa). Il tipo di comunicazione a cui appartiene questa trascrizione. Può essere una chat o una chiamata per le chiamate con funzionalità SMS combinate.

  • comm_id (numero intero). Un identificatore della comunicazione, ad esempio — la chat o la chiamata a cui si riferisce questa trascrizione.

  • transcript_version (stringa). La versione del formato della trascrizione. Questo è necessario per la compatibilità con le versioni precedenti durante l'analisi delle trascrizioni.

  • assigned_at (stringa, data e ora). Il timestamp di assegnazione della chat.

  • timezone (stringa). Il fuso orario in cui si è svolta la chat.

Definizioni dei messaggi

La sezione definitions contiene componenti dello schema riutilizzabili che definiscono la struttura di diversi tipi di messaggi all'interno della trascrizione. Ciò offre flessibilità nella gestione di vari formati di contenuti:

  • text (oggetto): rappresenta un messaggio

    • type (stringa): deve essere "text"

    • content (stringa): il contenuto di testo effettivo del messaggio

    • lang (stringa): la lingua dei contenuti di testo.

  • text_template (oggetto): rappresenta un messaggio di testo basato su un modello

    • type (stringa): deve essere text_template

    • content (stringa): il contenuto del modello di testo, che potrebbe includere segnaposto

  • markdown (oggetto): rappresenta un messaggio utilizzando la formattazione Markdown

    • type (stringa): deve essere Markdown

    • content (stringa): i contenuti del modello Markdown

  • markdown_template (oggetto): rappresenta un messaggio Markdown basato su un modello

    • type (stringa): deve essere markdown_template.

    • content (stringa): i contenuti del modello Markdown, possibilmente con segnaposto

  • photo (oggetto): rappresenta un messaggio contenente una foto

    • type (stringa): deve essere photo

    • media_id (integer): l'ID del file multimediale per la foto

  • video (oggetto): rappresenta un messaggio contenente un video

    • title (stringa): titolo del video

    • video (oggetto): dettagli sul video

      • url (stringa): URL del video

      • text (stringa): testo alternativo all'URL del video

    • media_id (numero intero): ID multimediale per recuperare l'URL del video se non fornito direttamente

  • image (oggetto): rappresenta un messaggio contenente un'immagine

    • title (stringa): titolo dell'immagine

    • image (oggetto): dettagli sull'immagine

      • url (stringa): URL dell'immagine

      • text (stringa): testo alternativo all'URL dell'immagine

  • document (oggetto): rappresenta un messaggio contenente un documento

    • title (stringa): titolo del documento

    • document (oggetto): dettagli sul documento

      • url (stringa): l'URL del documento.

      • text (stringa): testo alternativo all'URL del documento

  • inline_button (oggetto): rappresenta un insieme di pulsanti in linea

    • title (stringa): titolo del set di pulsanti in linea.

    • buttons (array): array di oggetti pulsante

      • title (stringa): titolo del pulsante

      • action (stringa): nome dell'azione indicata dal pulsante

      • link (stringa): URL del link per le azioni dei link di risposta rapida

  • sticky_button (oggetto): rappresenta un insieme di pulsanti fissi

    • title (stringa): titolo del set di pulsanti fissi

    • buttons (array): array di oggetti pulsante

      • title (stringa): titolo del pulsante

      • action (stringa): nome dell'azione indicata dal pulsante

      • link (stringa): URL del link per le azioni dei link di risposta rapida

  • content_card (oggetto): rappresenta una scheda di contenuti

    • cards (array): array di oggetti scheda dei contenuti

      • title (stringa): titolo della scheda dei contenuti

      • body (stringa): corpo del testo della scheda di contenuti

  • server_message (oggetto): rappresenta un messaggio recuperato dal server

    • message_id (integer): ID del messaggio del server archiviato

    • content (stringa): contenuti del messaggio recuperati dal server.

  • action (oggetto): rappresenta un'azione intrapresa durante la chat. Può essere uno dei seguenti:

    • action_escalation (oggetto): rappresenta un'azione di riassegnazione

      • action (stringa): deve essere "escalation"

      • escalation_reason (stringa): il motivo della riassegnazione.

      • menu_id (integer): l'ID a cui deve essere riassegnata la comunicazione

      • language (stringa): codice lingua ISO 689 della coda a cui riassegnare la richiesta

    • action_deflection (oggetto): rappresenta un'azione di deviazione

      • action (stringa): deve essere deflection

      • deflection_type (stringa): il tipo di deviazione

      • sip_parameters (oggetto o null): parametri SIP da inoltrare nell'ambito del trasferimento, se presenti

    • action_end (oggetto): rappresenta un'azione di fine

      • action (stringa): deve essere end

  • noti (oggetto): rappresenta un messaggio di notifica. Può essere uno dei vari tipi di notifiche:

    • noti_transfer_started (oggetto): notifica per l'avvio di un trasferimento.

      • type (stringa): deve essere noti

      • event (stringa): deve essere "transferStarted"

      • target (stringa): la destinazione di destinazione del trasferimento, ad esempio — menu o agente.

      • agent (oggetto): l'agente che ha avviato il trasferimento

        • id (integer): ID dell'agente

        • email (stringa): email dell'agente

        • name (stringa): nome dell'agente

    • noti_verification_requested (oggetto): notifica per una richiesta di verifica

    • type (stringa): deve essere noti

    • event (stringa): deve essere verificationRequested

    • agent (oggetto): l'agente che richiede la verifica

      • id (numero intero): ID dell'agente che richiede la verifica

      • email (stringa): email dell'agente che richiede la verifica

      • name (stringa): nome dell'agente che richiede la verifica

    • noti_end_user_verified (oggetto): notifica per quando un utente finale viene verificato

      • type (stringa): deve essere noti

      • event (stringa): deve essere endUserVerified

    • Altri tipi di noti_\* definiscono le notifiche per vari eventi, come richieste di foto, richieste di video, eventi di cobrowsing, eventi di agenti virtuali di attività, ingresso di agenti e modifiche dello stato di trasferimento o riassegnazione.

    • noti_custom (oggetto): rappresenta una notifica personalizzata.

      • type (stringa): deve essere noti

      • event (stringa): deve essere custom

      • detail (oggetto): dettagli evento personalizzato

      • key (stringa): chiave che rappresenta il dettaglio dell'evento personalizzato

      • data (oggetto): payload dell'evento definito personalizzato

Voci della trascrizione

  • entries (array): un array di oggetti, dove ogni oggetto rappresenta un singolo messaggio inviato nella chat.

    • timestamp (stringa): il timestamp di invio del messaggio

    • type (stringa): il tipo di messaggio, che fa riferimento a una delle definizioni descritte in precedenza, ad esempio text, photo, noti.

    • body (oggetto): il contenuto del messaggio, conforme alla struttura definita dal tipo di messaggio. Utilizza oneOf per consentire diversi tipi di corpo.

    • role (stringa): il ruolo del partecipante che ha inviato il messaggio. I valori possibili includono end_user, agent, manager, virtual_agent, external_agent, task_virtual_agent, system.

    • user_data (oggetto): dati dell'utente che ha inviato il messaggio, a meno che non si tratti di un messaggio di sistema o dell'utente finale.

      • name (stringa): il nome dell'utente

      • id (numero intero): l'ID univoco dell'utente

    • avatar_url (stringa): URL di archiviazione dell'avatar dell'utente