Metadaten von Chatsitzungen

In diesem Dokument wird das JSON-Schema beschrieben, das zum Strukturieren von Metadaten für Chatinteraktionen mit dem Kundensupport verwendet wird. Dieses Schema trägt zur Datenkonsistenz bei und erleichtert die effektive Verwaltung und Analyse von Chatdaten.

Schema für Metadaten von Chatsitzungen

Dieses Schema beschreibt die Informationen, die wir zu jeder Kundensupport-Chatsitzung erheben. Die wichtigsten Komponenten werden in den folgenden Abschnitten beschrieben.

Wichtige Informationen

Diese Eigenschaften enthalten die wichtigsten Informationen zu einer Chatsitzung:

• id (Ganzzahl). Eine eindeutige Kennung für jede Chatsitzung. Dies ist der Primärschlüssel.

• lang (String): Der im Chat verwendete ISO 689-Sprachcode. Beispiele: en für Englisch, es für Spanisch.

• chat_type (String). Der Typ des Chats, der einen Legacy-Satz von Typen verwendet. Beispiele sind „Messaging Inbound (App Chat)“, „Messaging (SMS)“ und „Messaging (WhatsApp)“.

• session_type (String): ein Duplikat von chat_type

• session_type_v2 (String). Der Typ des Chats, basierend auf den aktuellen Typen. Dazu können auch Verfeinerungen wie „Eingehende Nachrichten (mobiler Chat)“ gehören.

• status (String). Der aktuelle Status des Chats. Mögliche Werte sind queued, assigned, finished, no_response, canceled und failed.

• sub_status (String). Bietet einen detaillierteren Status des Anrufs. Mögliche Werte sind waiting_for_agent, in_queue und connected_with_agent.

• created_at (string, date-time): Der Zeitstempel, zu dem die Chatsitzung erstellt wurde.

• assigned_at (String, Datum/Uhrzeit oder null): Der Zeitstempel, wann der Chat einem Kundenservicemitarbeiter zugewiesen wurde, oder null, wenn er nicht zugewiesen wurde.

• ends_at (String, Datum/Uhrzeit oder null): Der Zeitstempel für das Ende der Chatsitzung.

• `updated_at` (string, date-time): Der Zeitstempel, der angibt, wann die Chatdaten zuletzt aktualisiert wurden.

• first_msg_sent_at (string, date-time): Zeitstempel für den Versand der ersten Nachricht im Chat

• last_msg_sent_at (string, date-time): Der Zeitstempel für den Versand der letzten Nachricht im Chat

• wait_duration (Ganzzahl): Die Gesamtzeit, die der Kunde gewartet hat, in Sekunden.

• chat_duration (Ganzzahl): Gesamtdauer des Chats in Sekunden

• verified (boolesch): Gibt an, ob die Interaktion über die Smart Action zur Bestätigung bestätigt wurde.

• rating (Ganzzahl oder „null“): Die vom Kunden angegebene Bewertung der Kundenzufriedenheit (CSAT) oder „null“, wenn keine Bewertung abgegeben wurde

• has_feedback (boolesch): Gibt an, ob der Kunde nach dem Chat Feedback gegeben hat.

• out_ticket_id (String): Die Kennung des im externen CRM-System erstellten Tickets.

• out_ticket_url (string, uri): die URL des CRM-Tickets

• is_out_ticket_account (boolesch): Gibt an, ob das CRM-Ticket einen Kunden (wahr) oder eine Chat-Interaktion (falsch) darstellt.

• fail_reason (String): Der Grund für einen Fehler während des Chats. Beispiele sind no_response, expired und end_user_opt_out.

• provider_type (String): Der verwendete Chatanbietertyp. Beispiele: unknown, messaging, twilio_conversations.

• message_count (Ganzzahl): die Gesamtzahl der im Chat ausgetauschten Nachrichten

• average_response_time (Ganzzahl): Die durchschnittliche Zeit, die Kundenservicemitarbeiter während des Chats für die Antwort benötigt haben, in Sekunden

• longest_response_time (String): Die längste Zeit, die ein Kundenservicemitarbeiter während des Chats für eine Antwort benötigt hat, in Sekunden.

Informationen zu Agenten und virtuellen Kundenservicemitarbeitern

Diese Attribute geben an, wer oder was den Chat bearbeitet hat:

• agent_info (Objekt): Dieses Feld kann Informationen zu einem Kundenservicemitarbeiter oder einem virtuellen Kundenservicemitarbeiter enthalten. Mit dem Keyword „one of“ wird angegeben, dass es sich um einen von zwei Typen handeln kann.

  • agent (Objekt): Informationen zum menschlichen Kundenservicemitarbeiter:

    • id (Ganzzahl): die eindeutige ID des Agenten

    • agent_number (String oder null): Eine dem Agenten zugewiesene Kennung.

    • email (string, email): die E-Mail-Adresse des KI-Agenten

    • name (String): Der vollständige Name des Kundenservicemitarbeiters

    • last_name (String): Der Nachname des Kundenservicemitarbeiters

    • first_name (String): Der Vorname des Kundenservicemitarbeiters

    • avatar_url (String, URI): Die URL des Avatarbilds des Agenten.

  • virtual_agent (Objekt): Informationen zum virtuellen Kundenservicemitarbeiter:

    • id (Ganzzahl): die eindeutige ID des virtuellen Agenten.

    • name (String): Der Name des virtuellen Agenten.

    • avatar_url (string, uri): Die URL des Avatarbilds des virtuellen Agenten.

Menünavigation

• selected_menu (Objekt oder Null): Informationen zum Menü, das der Kunde während des Chats ausgewählt hat.

  • id (Ganzzahl): die ID des Menüs

  • name (String): Der Name des Menüs

  • parent_id (Ganzzahl oder null): Die ID des übergeordneten Menüs, sofern vorhanden

  • position (Ganzzahl): Die Menüposition relativ zu anderen Menüs auf derselben Ebene.

  • deleted (boolesch): Gibt an, ob das Menü gelöscht wurde.

  • menu_type (String): Der Menütyp. Beispiel: sms_menu oder web_menu"

  • hidden (boolesch): Gibt an, ob das Menü sichtbar und verfügbar ist.

• menu_path (Objekt oder Null): Beschreibt den hierarchischen Pfad der Menüs, die der Kunde aufgerufen hat.

  • items_count (Ganzzahl): Die Anzahl der Menüs im Pfad.

  • name (String): Ein durch Schrägstriche getrennter String mit Menünamen. Beispiel: „Support/Abrechnung“.

  • materialized_path (String): ein durch Schrägstriche getrennter String mit Menü-IDs

• queue_priority_level (Ganzzahl): Eine Ganzzahl, die die Prioritätsstufe der ausgewählten Warteschlange des Chats darstellt.

Endnutzerdetails

• end_user (Objekt): Informationen zum Kunden

  • id (Ganzzahl): die interne ID des Kunden

  • identifier (String oder Null): Eine externe Kennung für den Kunden

  • out_contact_id (String oder null): Die ID des Kunden im CRM

Kunden-Flags

• customer_flag (Objekt oder null): Flags, die wichtige Attribute des Kunden kennzeichnen

  • verified_customer (boolesch): Gibt an, ob der Kunde extern als bestätigt gekennzeichnet wurde.

  • bad_actor (boolesch): Gibt an, ob der Kunde extern als böswilliger Akteur gekennzeichnet wurde.

  • repeat_customer (boolesch): Gibt an, ob der Kunde extern als Bestandskunde gekennzeichnet wurde.

Medienanhänge

• photos (Array): Liste der Fotos, die mit dem Chat verknüpft sind

  • id (Ganzzahl): Eindeutige Kennung für das Foto

  • photo_type (String): Der Fototyp („photo“ oder „screenshot“)

  • url (Ganzzahl): Die Speicher-URL des Fotos.

  • smart_action_type (Array): Der Typ der mit dem Foto verknüpften Smart Action.

  • transfer_id (Ganzzahl oder null): die ID der mit dem Foto verknüpften Kommunikationsübertragung, falls zutreffend

• videos (Array): Liste der Videos, die mit dem Chat verknüpft sind

  • id (Ganzzahl): Eindeutige Kennung für das Video

  • url (Ganzzahl): Die Speicher-URL des Videos.

  • smart_action_type (Array): Der Typ der Smart Action, die mit dem Video verknüpft ist.

  • transfer_id (Ganzzahl oder Null): die Kennung der mit dem Video verknüpften Kommunikationsübertragung, falls zutreffend

Chatübertragungen

• transfers (Array): Liste der Übertragungen, die während des Chats stattgefunden haben.

  • id (Ganzzahl): die ID des Transfers

  • status (String): Status der Übertragung („transferring“, „transferred“, „failed“, „deflected“)

  • fail_reason (String): Grund für den Übertragungsfehler, falls zutreffend

  • created_at (string, date-time): Zeitstempel für die Erstellung der Übertragung

  • assigned_at (string, date-time oder null): Zeitstempel für die Zuweisung des Transfers

  • connected_at (String, Datum/Uhrzeit oder Null): Zeitstempel für den Zeitpunkt, zu dem die Übertragung verbunden wurde.

  • updated_at (String, Datum/Uhrzeit oder Null): Zeitstempel der letzten Aktualisierung des Transfers

  • wait_duration (Ganzzahl): Wartezeit während der Übertragung

  • answer_type_path (String): Der Typ der Antworten für die Chats „from“ und „to“

  • from_menu_path (Objekt oder null): Menüpfad des Menüs, aus dem die Übertragung stammt

  • to_menu_path (Objekt oder null): Menüpfad des Zielmenüs der Übertragung, falls zutreffend

  • from_agent (Objekt oder Null): Der Kundenservicemitarbeiter, der die Übertragung initiiert hat.

  • to_agent (Objekt oder null): Agent, der die Übertragung erhalten hat

  • from_queue_priority_level (Ganzzahl): Prioritätsstufe der ursprünglichen Warteschlange

  • to_queue_priority_level (Ganzzahl): Prioritätsstufe der Zielwarteschlange

Dauer der Chatbearbeitung

• handle_durations (Array): Protokolldaten zu jedem Segment des Chats, das von einem Kundenservicemitarbeiter bearbeitet wurde.

  • id (Ganzzahl): Die Kennzeichnung für die Dauer des Vorgangs

  • agent_id (Ganzzahl): Kennung des Agenten

  • acw_duration (Ganzzahl): Dauer der Nachbereitung des Chats

  • chat_duration (Ganzzahl): Dauer des Chats in dieser Phase

  • menu_path_id (String oder null): Menüpfad-ID

  • menu_path (String): Menüpfad

  • lang (String): verwendete Sprache

  • transfer (boolesch): Gibt an, ob eine Übertragung stattgefunden hat.

  • transfer_id (String oder null): Transfer-ID

  • started_at (String, Datum/Uhrzeit): Start-Zeitstempel

  • ended_at (String, Datum/Uhrzeit): End-Timestamp

  • response_count (Ganzzahl): Anzahl der Antworten des KI-Agenten

  • response_time_total (Ganzzahl): Gesamte Antwortzeit des KI-Agenten

  • response_time_max (Ganzzahl): längste Antwortzeit des KI-Agenten

  • response_time_avg (Ganzzahl): durchschnittliche Antwortzeit des Kundenservicemitarbeiters

  • assigned_connection_duration (Ganzzahl): Dauer, die der Endnutzer gewartet hat, während der zugewiesene Kundenservicemitarbeiter in dieser Phase verbunden war

Warteschlangendauer

• queue_durations (Array): Protokolldaten zu jedem Segment des Chats, in dem der Kunde in einer Warteschlange gewartet hat.

  • id (Ganzzahl): die ID

  • agent_id (Ganzzahl): Agent-ID

  • ended_at (String, Datum/Uhrzeit): End-Timestamp

  • lang (String): Sprache

  • menu_path_id (Ganzzahl): Kennung des Menüpfads

  • menu_path (String): Menüpfad

  • queue_duration (Ganzzahl): Dauer der Warteschlange

  • started_at (String, Datum/Uhrzeit): Start-Zeitstempel

  • transfer_cold (boolesch): Gibt an, ob der Chat ohne Rücksprache weitergeleitet wurde.

  • transfer (boolesch): Gibt an, ob eine Übertragung stattgefunden hat.

  • transfer_id (Ganzzahl): Übertragungs-ID

  • service_level_abandon_time_threshold (Ganzzahl): Abbruchgrenzwert für das Servicelevel

  • service_level_event (String): Status des Ereignisses auf Serviceebene

  • service_level_target_percent (Ganzzahl): Prozentsatz des Service-Level-Ziels

  • service_level_target_time (Ganzzahl): Zielzeit für das Serviceniveau

Eskalierungen durch virtuelle Kundenservicemitarbeiter

• virtual_agent_deflected_escalations (Array): Details zu Eskalierungen von virtuellen Kundenservicemitarbeitern, die abgewiesen wurden

  • id (Ganzzahl): die ID

  • deflection (String): Ablenkungstyp

  • escalation_id (Ganzzahl): ID des Eskalierungsereignisses

  • escalation_reason (String): Grund für die Eskalation

  • escalated_at (string, date-time): Eskalierungs-Zeitstempel

  • menu_path_id (Ganzzahl): Menüpfad-ID

  • menu_path (String): Menüpfad

  • lang (String): Sprache

  • virtual_agent (Objekt): Details zum virtuellen Kundenservicemitarbeiter

Dauer der Verarbeitung durch virtuelle Kundenservicemitarbeiter

• virtual_agent_handle_durations (Array): Zeitsegmente, in denen der Chat von einem virtuellen Kundenservicemitarbeiter bearbeitet wurde

  • id (Ganzzahl): die ID

  • virtual_agent (Objekt): Details zum virtuellen Kundenservicemitarbeiter

  • chat_duration (Ganzzahl): Dauer des Segments

  • escalation_reason (String): Grund für die Eskalation

  • finish_reason (String): Grund für das Ende der Interaktion

  • response_count (Ganzzahl): Anzahl der Antworten des virtuellen Kundenservicemitarbeiters

  • response_time_total (Ganzzahl): Gesamte Antwortzeit des virtuellen Kundenservicemitarbeiters

  • response_time_max (Ganzzahl): längste Antwortzeit des virtuellen Kundenservicemitarbeiters

  • response_time_avg (String): durchschnittliche Antwortzeit des virtuellen Kundenservicemitarbeiters

  • fallback_response_count (Ganzzahl): Anzahl der Fallback-Antworten

  • initiated_by (String): Gibt an, wie die Sitzung mit dem virtuellen Kundenservicemitarbeiter initiiert wurde.

  • menu_path_id (Ganzzahl): Menüpfad-ID

  • menu_path (String): Menüpfad

  • lang (String): Sprache

  • transfer (boolesch): Gibt an, ob der Chat übertragen wurde.

  • transfer_id (Ganzzahl): Kennung des Übertragungsereignisses

  • started_at (String, Datum/Uhrzeit): Start-Zeitstempel

  • ended_at (String, Datum/Uhrzeit): End-Timestamp

Bearbeitungszeiten für Verbraucheranfragen

• consumer_handle_durations (Array): Dauer der Chat-Teilnahme des Kunden

  • id (Ganzzahl): Kennung

  • chat_duration (Ganzzahl): Dauer des Verbrauchersegments

  • started_at (String, Datum/Uhrzeit): Start-Zeitstempel

  • ended_at (String, Datum/Uhrzeit): End-Timestamp

  • message_count (Ganzzahl): Anzahl der Verbrauchernachrichten

  • response_count (Ganzzahl): Anzahl der Antworten von Verbrauchern

  • response_time_total (Ganzzahl): Gesamtreaktionszeit der Nutzer

  • response_time_max (Ganzzahl): längste Reaktionszeit der Nutzer

  • response_time_avg (Ganzzahl): durchschnittliche Reaktionszeit der Verbraucher

Dauer von Verbraucherereignissen

• consumer_event_durations (Array): Details zu Chat-Ereignissen von Verbrauchern. Beispiel: CSAT, Zahlung

  • id (Ganzzahl): Kennung

  • duration (Ganzzahl): Ereignisdauer

  • type (String): Ereignistyp

  • event (String): Ereignisergebnis

  • menu_path_id (Ganzzahl): Menüpfad-ID

  • menu_path (String): Menüpfad

  • lang (String): Sprache

  • started_at (String, Datum/Uhrzeit): Start-Zeitstempel

  • ended_at (String, Datum/Uhrzeit): End-Timestamp

Teilnehmer*innen

• Teilnehmer (Array): Informationen zu jedem Teilnehmer im Chat. Beispiel: Kunde, Kundenservicemitarbeiter, virtueller Kundenservicemitarbeiter

  • id (Ganzzahl): Eindeutige Kennung für den Teilnehmer

  • type (String): Art des Teilnehmers, z. B. end_user, agent, virtual_agent usw.

  • entry_type (String): Wie der Teilnehmer dem Chat beigetreten ist.

  • user_id (Ganzzahl oder null): Nutzer-ID, wenn der Teilnehmer ein Kundenservicemitarbeiter ist

  • end_user_id (Ganzzahl oder null): Endnutzer-ID, wenn der Teilnehmer der Kunde ist

  • virtual_agent_id (Ganzzahl oder null): ID des virtuellen Kundenservicemitarbeiters, wenn der Teilnehmer ein virtueller Kundenservicemitarbeiter ist

  • virtual_agent_params (Objekt): benutzerdefinierte Metadaten, die vom virtuellen Kundenservicemitarbeiter verwendet werden

  • status (String): Status des Teilnehmers

  • fail_reason (String): Grund für den Fehler, falls vorhanden

  • connected_at (string, date-time): Zeitstempel, zu dem der Teilnehmer eine Verbindung hergestellt hat

  • phone_number (String): Telefonnummer des Teilnehmers

  • chat_id (Ganzzahl): Kennung für den Chat

  • chat_duration (Ganzzahl): Chatdauer für den Teilnehmer

  • finished_at (String, Datum/Uhrzeit): Zeitstempel für das Ende der Teilnahme des Teilnehmers

Events anbieten

• offer_type (String oder null): Art und Weise, wie der Chat dem Kundenservicemitarbeiter angeboten wurde

• offer_events (Array): Ereignisse, bei denen der Chat Kundenservicemitarbeitern angeboten wurde.

  • casting_time (date-time): Uhrzeit, zu der der Chat angeboten wurde

  • group (String): Gruppe, der der Chat angeboten wurde

Sonstige Details

• dismiss_duration (Ganzzahl): Dauer des Chats im Status „Abgelehnt“

• answer_type (String oder null): Gibt an, wie auf den Chat geantwortet wurde („manual“ oder „auto“).

• inbound_number (String): Eingehende Telefonnummer

• outbound_number (String): abgehende Telefonnummer

• after_hours (boolesch): Gibt an, ob der Chat außerhalb der Geschäftszeiten stattgefunden hat.

• dispositions (Array): während des Chats aufgezeichnete Dispositionen

• auto_session_summaries (Array): automatisch generierte Zusammenfassungen der Sitzung

• transfer_limit (object): Daten zum Übertragungslimit für den Chat

• email (String, E-Mail oder Null): E-Mail-Adresse des Kunden

• feedback (String oder null): Kundenfeedback

• smart_action_text (String oder Null): Text einer beliebigen ausgeführten Smart Action

• custom_data_secured (object oder null): benutzerdefinierte, sicher signierte Daten

• custom_data_not_secured (Objekt oder Null): benutzerdefinierte, nicht sicher signierte Daten

Wichtige Definitionen

Das Schema enthält auch einen Definitionsabschnitt zum Definieren wiederverwendbarer Komponenten:

• menu_path: beschreibt einen hierarchischen Menüpfad

• agent: Beschreibt einen menschlichen Kundenservicemitarbeiter

• virtual_agent: Beschreibt einen virtuellen Kundenservicemitarbeiter