Metadati della sessione di chat

Questo documento spiega lo schema JSON utilizzato per strutturare i metadati per le interazioni di chat di assistenza clienti. Questo schema contribuisce a garantire la coerenza dei dati e facilita la gestione e l'analisi efficaci dei dati della chat.

Schema dei metadati della sessione di chat

Questo schema descrive le informazioni che raccogliamo su ogni sessione di chat con l'assistenza clienti. I componenti chiave sono descritti nelle sezioni seguenti.

Informazioni principali

Queste proprietà acquisiscono le informazioni principali di una sessione di chat:

  • id (numero intero). Un identificatore univoco per ogni sessione di chat. Questa è la chiave primaria.

  • lang (stringa): il codice lingua ISO 689 utilizzato nella chat. Ad esempio, — en per l'inglese, es per lo spagnolo.

  • chat_type (stringa). Il tipo di chat, utilizzando un insieme legacy di tipi. Esempi includono "Messaggistica in entrata (chat app)", "Messaggistica (SMS)" e "Messaggistica (WhatsApp)".

  • session_type (stringa): un duplicato di chat_type

  • session_type_v2 (stringa). Il tipo di chat, utilizzando l'insieme corrente di tipi. Potrebbero essere inclusi perfezionamenti come "Messaggistica in entrata (chat mobile)".

  • status (stringa). Lo stato attuale della chat. I valori possibili includono queued, assigned, finished, no_response, canceled e failed.

  • sub_status (stringa). Fornisce uno stato più dettagliato della chiamata. I valori possibili includono waiting_for_agent, in_queue e connected_with_agent.

  • created_at (stringa, data e ora): il timestamp di creazione della sessione di chat

  • assigned_at (stringa, data/ora o null): il timestamp in cui la chat è stata assegnata a un agente o null se non è stata assegnata

  • ends_at (stringa, data/ora o null): il timestamp di fine della sessione di chat

  • `updated_at (stringa, data e ora): il timestamp dell'ultimo aggiornamento dei dati della chat

  • first_msg_sent_at (stringa, data e ora): il timestamp di invio del primo messaggio nella chat

  • last_msg_sent_at (stringa, data e ora): il timestamp di invio dell'ultimo messaggio nella chat

  • wait_duration (integer): il tempo totale trascorso dal cliente in attesa, in secondi

  • chat_duration (numero intero): la durata totale della chat, in secondi

  • verified (booleano): indica se l'interazione è stata verificata tramite l'azione smart di verifica

  • rating (numero intero o null): la valutazione della soddisfazione del cliente (CSAT) fornita dal cliente o null se non è stata fornita alcuna valutazione

  • has_feedback (booleano): indica se il cliente ha fornito un feedback dopo la chat

  • out_ticket_id (stringa): l'identificatore del ticket creato nel sistema CRM esterno

  • out_ticket_url (stringa, uri): l'URL del ticket CRM

  • is_out_ticket_account (booleano): indica se il ticket CRM rappresenta un cliente (true) o un'interazione di chat (false)

  • fail_reason (stringa): il motivo di eventuali errori durante la chat. Esempi includono no_response, expired e end_user_opt_out.

  • provider_type (stringa): il tipo di fornitore di chat utilizzato. Ad esempio, unknown, messaging, twilio_conversations.

  • message_count (integer): il numero totale di messaggi scambiati nella chat

  • average_response_time (numero intero): il tempo medio impiegato dagli agenti per rispondere durante la chat, in secondi

  • longest_response_time (stringa): il tempo più lungo impiegato da un agente per rispondere durante la chat, in secondi

Informazioni sull'agente e sull'agente virtuale

Queste proprietà spiegano chi o cosa ha gestito la chat:

  • agent_info (oggetto): questo campo può contenere informazioni su un operatore umano o un operatore virtuale. Utilizza la parola chiave one of per specificare che può essere uno dei due tipi.

    • agent (oggetto): informazioni sull'agente umano:

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

      • agent_number (stringa o valore null): un identificatore assegnato all'agente

      • email (stringa, email): l'indirizzo email dell'agente

      • name (stringa): il nome completo dell'agente

      • last_name (stringa): il cognome dell'agente

      • first_name (stringa): il nome dell'agente

      • avatar_url (stringa, uri): l'URL dell'immagine dell'avatar dell'agente

    • virtual_agent (oggetto): informazioni sull'agente virtuale:

      • id (numero intero): l'ID univoco dell'agente virtuale.

      • name (stringa): il nome dell'agente virtuale.

      • avatar_url (stringa, uri): l'URL dell'immagine dell'avatar dell'agente virtuale.

  • selected_menu (oggetto o null): informazioni sul menu selezionato dal cliente durante la chat.

    • id (integer): l'ID del menu

    • name (stringa): il nome del menu

    • parent_id (numero intero o null): l'ID del menu principale, se presente

    • position (integer): la posizione del menu rispetto agli altri menu dello stesso livello

    • deleted (booleano): indica se il menu è stato eliminato

    • menu_type (stringa): il tipo di menu. Ad esempio, sms_menu o web_menu"

    • hidden (booleano): indica se il menu è visibile e disponibile per l'uso

  • menu_path (oggetto o null): descrive il percorso gerarchico dei menu in cui il cliente ha navigato.

    • items_count (integer): il numero di menu nel percorso

    • name (stringa): una stringa di nomi di menu separati da una barra. Ad esempio, "Assistenza/Fatturazione".

    • materialized_path (stringa): una stringa di ID menu separati da una barra

  • queue_priority_level (numero intero): un numero intero che rappresenta il livello di priorità della coda selezionata della chat

Dettagli utente finale

  • end_user (oggetto): informazioni sul cliente

    • id (numero intero): l'ID interno del cliente

    • identifier (stringa o null): un identificatore esterno per il cliente

    • out_contact_id (stringa o valore null): l'ID del cliente nel CRM

Flag cliente

  • customer_flag (oggetto o null): flag che contrassegnano gli attributi importanti del cliente

    • verified_customer (booleano): indica se il cliente è stato segnalato esternamente come verificato

    • bad_actor (booleano): indica se il cliente è stato segnalato esternamente come attore malintenzionato

    • repeat_customer (booleano): indica se il cliente è stato segnalato esternamente come cliente abituale

Allegati multimediali

  • photos (array): elenco di foto associate alla chat

    • id (integer): identificatore univoco della foto

    • photo_type (stringa): il tipo di foto ("photo" o "screenshot")

    • url (integer): l'URL di archiviazione della foto

    • smart_action_type (array): il tipo di azione rapida associata alla foto

    • transfer_id (numero intero o null): l'identificatore del trasferimento della comunicazione associato alla foto, se applicabile

  • videos (array): elenco di video associati alla chat

    • id (numero intero): identificatore univoco del video

    • url (numero intero): l'URL di archiviazione del video

    • smart_action_type (array): il tipo di azione intelligente associata al video

    • transfer_id (numero intero o null): l'identificatore del trasferimento della comunicazione associato al video, se applicabile

Trasferimenti della chat

  • transfers (array): elenco dei trasferimenti avvenuti durante la chat

    • id (integer): l'identificatore del trasferimento

    • status (stringa): stato del trasferimento ("transferring", "transferred", "failed", "deflected")

    • fail_reason (stringa): motivo dell'errore di trasferimento, se applicabile

    • created_at (stringa, data e ora): timestamp della creazione del trasferimento

    • assigned_at (stringa, data/ora o null): timestamp dell'assegnazione del trasferimento

    • connected_at (stringa, data/ora o null): timestamp della connessione del trasferimento

    • updated_at (stringa, data/ora o null): timestamp dell'ultimo aggiornamento del trasferimento

    • wait_duration (integer): la durata dell'attesa durante il trasferimento

    • answer_type_path (stringa): il tipo di risposte per le chat "da" e "a", rispettivamente

    • from_menu_path (oggetto o null): percorso del menu da cui ha avuto origine il trasferimento

    • to_menu_path (oggetto o null): percorso del menu di destinazione del trasferimento, se applicabile

    • from_agent (oggetto o null): l'agente che ha avviato il trasferimento

    • to_agent (oggetto o null): agente che ha ricevuto il trasferimento

    • from_queue_priority_level (integer): livello di priorità della coda di origine

    • to_queue_priority_level (integer): livello di priorità della coda di destinazione

Durate di gestione della chat

  • handle_durations (array): dati di log su ogni segmento della chat gestita da un agente

    • id (integer): l'identificatore della durata dell'handle

    • agent_id (integer): identificatore dell'agente

    • acw_duration (integer): durata dell'attività successiva alla chat

    • chat_duration (integer): durata della chat durante questa fase

    • menu_path_id (stringa o valore null): ID percorso menu

    • menu_path (stringa): percorso del menu

    • lang (stringa): lingua utilizzata.

    • transfer (booleano): indica se è stato effettuato un trasferimento

    • transfer_id (stringa o null): identificatore del trasferimento

    • started_at (stringa, data e ora): timestamp di inizio

    • ended_at (stringa, data e ora): timestamp di fine

    • response_count (integer): numero di risposte dell'agente

    • response_time_total (integer): tempo di risposta totale dell'agente

    • response_time_max (integer): il tempo di risposta più lungo dell'agente

    • response_time_avg (integer): tempo medio di risposta dell'agente

    • assigned_connection_duration (numero intero): durata dell'attesa dell'utente finale mentre l'agente assegnato era connesso durante questa fase

Durate delle code

  • queue_durations (array): dati di log su ogni segmento della chat in cui il cliente era in attesa in una coda

    • id (integer): l'identificatore

    • agent_id (numero intero): identificatore dell'agente

    • ended_at (stringa, data e ora): timestamp di fine

    • lang (stringa): lingua

    • menu_path_id (integer): identificatore del percorso del menu

    • menu_path (stringa): percorso del menu

    • queue_duration (integer): durata della coda

    • started_at (stringa, data e ora): timestamp di inizio

    • transfer_cold (booleano): indica se la chat è stata trasferita a freddo

    • transfer (booleano): indica se è stato effettuato un trasferimento

    • transfer_id (numero intero): identificatore del trasferimento

    • service_level_abandon_time_threshold (integer): service level abandonment threshold

    • service_level_event (stringa): stato dell'evento a livello di servizio

    • service_level_target_percent (integer): percentuale target del livello di servizio

    • service_level_target_time (integer): tempo target del livello di servizio

Riassegnazioni dell'agente virtuale

  • virtual_agent_deflected_escalations (array): dettagli delle riassegnazioni dagli agenti virtuali che sono state deviate

    • id (integer): l'identificatore

    • deflection (stringa): tipo di deviazione

    • escalation_id (integer): identificatore evento di riassegnazione

    • escalation_reason (stringa): motivo della riassegnazione

    • escalated_at (stringa, data e ora): timestamp di riassegnazione

    • menu_path_id (numero intero): ID percorso menu

    • menu_path (stringa): percorso del menu

    • lang (stringa): lingua

    • virtual_agent (oggetto): dettagli dell'agente virtuale

Durate di gestione dell'agente virtuale

  • virtual_agent_handle_durations (array): segmenti di tempo in cui la chat è stata gestita da un agente virtuale

    • id (integer): l'identificatore

    • virtual_agent (oggetto): dettagli dell'agente virtuale

    • chat_duration (integer): durata del segmento

    • escalation_reason (stringa): motivo della riassegnazione

    • finish_reason (stringa): motivo per cui l'interazione è terminata

    • response_count (numero intero): numero di risposte dell'agente virtuale

    • response_time_total (integer): tempo di risposta totale dell'agente virtuale

    • response_time_max (integer): tempo di risposta più lungo dell'agente virtuale

    • response_time_avg (stringa): tempo medio di risposta dell'agente virtuale

    • fallback_response_count (integer): conteggio delle risposte di riserva

    • initiated_by (stringa): come è stata avviata la sessione dell'agente virtuale

    • menu_path_id (numero intero): ID percorso menu

    • menu_path (stringa): percorso del menu

    • lang (stringa): lingua

    • transfer (booleano): indica se la chat è stata trasferita

    • transfer_id (numero intero): identificatore dell'evento di trasferimento

    • started_at (stringa, data e ora): timestamp di inizio

    • ended_at (stringa, data e ora): timestamp di fine

Durate di gestione dei consumatori

  • consumer_handle_durations (array): durate della chat del consumatore

    • id (intero): identificatore

    • chat_duration (integer): durata del segmento di consumatori

    • started_at (stringa, data e ora): timestamp di inizio

    • ended_at (stringa, data e ora): timestamp di fine

    • message_count (integer): numero di messaggi dei consumatori

    • response_count (integer): numero di risposte dei consumatori

    • response_time_total (integer): tempo di risposta totale del consumatore

    • response_time_max (integer): il tempo di risposta più lungo dei consumatori

    • response_time_avg (integer): tempo medio di risposta del consumatore

Durate degli eventi dei consumatori

  • consumer_event_durations (array): dettagli degli eventi di chat dei consumatori. Ad esempio, CSAT, pagamento

    • id (intero): identificatore

    • duration (integer): durata dell'evento

    • type (stringa): tipo di evento

    • event (stringa): risultato dell'evento

    • menu_path_id (numero intero): ID percorso menu

    • menu_path (stringa): percorso del menu

    • lang (stringa): lingua

    • started_at (stringa, data e ora): timestamp di inizio

    • ended_at (stringa, data e ora): timestamp di fine

Partecipanti

  • partecipanti (array): informazioni su ciascun partecipante alla chat. Ad esempio: cliente, agente, agente virtuale

    • id (integer): identificatore univoco del partecipante

    • type (stringa): tipo di partecipante, ad esempio end_user, agent, virtual_agent e così via.

    • entry_type (stringa): come il partecipante è entrato nella chat

    • user_id (numero intero o null): ID utente se il partecipante è un agente

    • end_user_id (numero intero o null): ID utente finale se il partecipante è il cliente

    • virtual_agent_id (numero intero o null): ID dell'agente virtuale se il partecipante è un agente virtuale

    • virtual_agent_params (oggetto): metadati personalizzati utilizzati dall'agente virtuale

    • status (stringa): lo stato del partecipante

    • fail_reason (stringa): motivo dell'errore, se presente

    • connected_at (stringa, data e ora): timestamp della connessione del partecipante

    • phone_number (stringa): numero di telefono del partecipante

    • chat_id (integer): identificatore della chat

    • chat_duration (integer): durata della chat per il partecipante

    • finished_at (stringa, data e ora): timestamp della fine del coinvolgimento del partecipante

Eventi offerta

  • offer_type (stringa o valore null): modalità di offerta della chat all'agente

  • offer_events (array): eventi in cui la chat è stata offerta agli agenti.

    • casting_time (data e ora): ora in cui è stata offerta la chat

    • group (stringa): gruppo a cui è stata offerta la chat

Altri dettagli

  • dismiss_duration (integer): durata della chat nello stato "Ignorato"

  • answer_type (stringa o null): come è stata risposto alla chat ("manual" o "auto")

  • inbound_number (stringa): numero di telefono in entrata

  • outbound_number (stringa): numero di telefono in uscita

  • after_hours (booleano): indica se la chat è stata condotta al di fuori dell'orario di lavoro

  • dispositions (array): disposizioni registrate durante la chat

  • auto_session_summaries (array): riepiloghi della sessione generati automaticamente

  • transfer_limit (object): transfer limit data for the chat

  • email (stringa, email o null): indirizzo email del cliente

  • feedback (stringa o valore null): feedback del cliente

  • smart_action_text (stringa o null): testo di qualsiasi azione intelligente intrapresa

  • custom_data_secured (oggetto o null): dati personalizzati firmati in modo sicuro

  • custom_data_not_secured (oggetto o null): dati personalizzati non firmati in modo sicuro

Definizioni chiave

Lo schema include anche una sezione delle definizioni per definire i componenti riutilizzabili:

  • menu_path: descrive un percorso di menu gerarchico

  • agent: descrive un agente umano

  • virtual_agent: descrive un agente virtuale