Metadaten der Anrufsitzung

In diesem Dokument wird das JSON-Schema erläutert, das zum Strukturieren von Metadaten für Anrufsitzungen verwendet wird. Dieses Schema ist entscheidend für die genaue Darstellung und Verarbeitung von Anrufsitzungen.

Schema für Metadaten von Anrufsitzungen

Dieses Schema beschreibt die Struktur von Daten, die sich auf Metadaten von Anrufsitzungen beziehen. Die wichtigsten Komponenten werden in den folgenden Abschnitten beschrieben.

Wichtige Informationen

Diese Properties enthalten die wichtigsten Informationen zum Anruf:

• id (Ganzzahl). Die Kennung für jede Anrufsitzung. Dies ist der Primärschlüssel, der einen Anruf von einem anderen unterscheidet.

• lang (String). Der während des Anrufs verwendete ISO 689-Sprachcode, z. B. en für Englisch oder es für Spanisch. Das ist für sprachspezifische Analysen und Berichte unerlässlich.

• call_type (String). Der Typ des Anrufs, der eine Legacy-Gruppe von Typen verwendet. Beispiele sind „Voice Inbound (App)“, „Voice Outbound“ und „Voice Internal“. So lassen sich Anrufe nach Herkunft und Zweck kategorisieren.

• session_type (String): ein Duplikat von „call_type“

• session_type_v2 (String). Der Typ des Anrufs, der mit dem aktuellen Satz von Typen verwendet wird. Ähnlich wie „call_type“, aber mit detaillierteren Unterscheidungen, z. B. „Voice Inbound (Mobile)“ oder „Voice Inbound (IVR using Mobile)“.

• status (String). Der aktuelle Status des Anrufs. Mögliche Werte sind scheduled, queued, connected, finished, failed und deflected. So wird der Fortschritt des Anrufs im Laufe seines Lebenszyklus verfolgt.

• subStatus(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 genaue Zeitstempel, zu dem der Anrufdatensatz erstellt wurde.

• queued_at (String, Datum/Uhrzeit oder Null): Der Zeitstempel, zu dem der Anruf in die Warteschlange eingegangen ist, oder Null, wenn er nie in die Warteschlange eingereiht wurde.

• assigned_at (String, Datums-/Zeitangabe oder Null): Der Zeitstempel, als der Anruf einem Kundenservicemitarbeiter zugewiesen wurde, oder Null, wenn er nicht zugewiesen wurde.

• connected_at (String, Datum/Uhrzeit oder Null): Der Zeitstempel, zu dem die Verbindung erfolgreich hergestellt wurde.

• ends_at (String, Datum/Uhrzeit oder null): Der Zeitstempel, zu dem der Anruf beendet wurde.

• scheduled_at (String, Datum/Uhrzeit oder null): Der Zeitstempel, an dem der Anruf geplant wurde, oder null, wenn es sich um einen sofortigen Anruf handelte.

• updated_at (string, date-time): Der Zeitstempel der letzten Änderung der Anrufdaten.

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

• call_duration (Ganzzahl): die Gesamtdauer des Anrufs in Sekunden

• hold_duration (Ganzzahl): Die Gesamtzeit, die der Kunde in der Warteschleife verbracht hat, in Sekunden, oder „null“, wenn es keine Wartezeit gab.

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

• has_feedback (boolesch): Ein Flag, das angibt, ob der Kunde nach dem Anruf Feedback gegeben hat.

• voip_provider (String): Der für den Anruf verwendete VoIP-Anbieter. Dieses Feld ist veraltet und gibt immer deprecated zurück.

• 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 (true) oder eine Anrufinteraktion (false) darstellt.

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

• recording_url (String, URI oder Null): Die URL der Anrufaufzeichnung oder Null, wenn keine Aufzeichnung verfügbar ist.

• recording_permission (String). Der Status der Aufzeichnungsberechtigung des Kunden. Mögliche Werte sind not_asked, granted oder denied.

• voicemail_reason (String). Der Grund, warum eine Mailboxnachricht hinterlassen wurde (falls zutreffend). Zu den Optionen gehören not_voicemail, temporary_redirection und after_hour_deflection.

Informationen zu Agenten und virtuellen Kundenservicemitarbeitern

In diesen Abschnitten wird erläutert, wer oder was den Anruf bearbeitet hat:

• agent_info (Objekt). Dieses Feld kann Informationen zu einem menschlichen oder 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 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 ID des virtuellen Agenten

    • name (String): Der Name des virtuellen Kundenservicemitarbeiters

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

Menünavigation

• selected_menu (Objekt oder Null): Informationen zum Menü, das der Kunde während des Anrufs 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: ivr_menu oder sms_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: dupport oder billing.

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

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

Anrufumleitung

• deflection (String): Gibt an, ob und wie der Anruf umgeleitet wurde. Beispiele: no_deflection, over_cap_phone, after_hours_voicemail.

• deflection_details (Array): Enthält ein detailliertes Protokoll der Umleitungen, die während des Anrufs aufgetreten sind. Jeder Eintrag enthält:

  • id (Ganzzahl): die ID des Datensatzes für die Ablenkungsprotokollierung

  • call_id (Ganzzahl): die ID des Anrufs

  • transfer_id (Ganzzahl oder null): Die ID des Transfers, der mit der Weiterleitung verknüpft ist, falls zutreffend.

  • deflection (String): Der Typ der Ablenkung

  • created_at (string, date-time): Zeitstempel für den Zeitpunkt, zu dem die Ablenkung aufgetreten ist

  • from_menu_path (object oder null): Menüpfad, von dem der Anruf abgeleitet wurde

  • to_menu_path (Objekt oder Null): Menüpfad, zu dem der Anruf umgeleitet wurde

  • to_sip_uri (String oder null): SIP-URI, an die der Anruf weitergeleitet wurde, falls zutreffend

  • to_sip_headers (Objekt): SIP-Header, mit denen der Anruf weitergeleitet wurde, falls zutreffend

Dauer der Anrufbehandlung

• handle_durations (Array): Ein Array von Objekten, die jeweils ein Segment des Anrufs darstellen, das von einem Kundenservicemitarbeiter bearbeitet wurde. Das ist nützlich, um die Bearbeitungszeit von Kundenservicemitarbeitern zu analysieren.

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

  • agent_id (Ganzzahl): ID des Agenten

  • acw_duration (Ganzzahl): Dauer der Anrufnachbereitung

  • bcw_duration (Ganzzahl): Dauer der Arbeit vor dem Anruf

  • call_duration (Ganzzahl): Anrufdauer während dieses Segments

  • menu_path_id (String oder null): ID des Menüpfads

  • menu_path (String): Name des Menüpfads

  • lang (String): verwendete Sprache

  • barged (boolesch): Gibt an, ob in den Anruf eingegriffen wurde.

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

  • transfer_id (String oder null): ID der Übertragung

  • transfer_cold (boolesch oder null): Gibt an, ob die Weiterleitung ohne Rücksprache erfolgte.

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

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

  • scheduled_at (string, date-time oder null): geplanter Zeitstempel

  • hold_duration (Ganzzahl oder null): Dauer der Hold-Phase während dieses Segments

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

  • session_breakthrough (Objekt): Details zur Zuweisung des Anrufs, der den Status „Nicht verfügbar“ eines Kundenservicemitarbeiters durchbricht, sofern zutreffend

Warteschlangendauer

• queue_durations (Array): Ein Array von Objekten, die jeweils ein Segment des Anrufs darstellen, in dem sich der Kunde in einer Warteschleife befand. Das ist entscheidend für die Analyse von Wartezeiten und Servicelevels.

  • id (Ganzzahl): Die Kennzeichnung für die Warteschlangendauer

  • agent_id (Ganzzahl): ID des Agenten

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

  • lang (String): verwendete Sprache

  • menu_path_id (Ganzzahl): ID des Menüpfads

  • menu_path (String): Name des Menüpfads

  • queue_duration (Ganzzahl): Dauer des Warteschlangensegments

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

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

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

  • transfer_id (Ganzzahl): ID des Transfers

  • service_level_abandon_time_threshold (Ganzzahl): Zeitgrenzwert für das Verlassen des Servicelevels

  • service_level_event (String): Der Status des Ereignisses auf Serviceebene. Beispiele: — excluded, in_sla, not_in_sla.

  • service_level_target_percent (Ganzzahl): Zielprozentsatz für die Einhaltung des Service-Levels

  • service_level_target_time (Ganzzahl): Zielzeit für die Einhaltung des Servicelevels

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 Anruf von einem virtuellen Kundenservicemitarbeiter bearbeitet wurde

  • id (Ganzzahl): die ID

  • virtual_agent (Objekt): Details zum virtuellen Kundenservicemitarbeiter

  • call_duration (Ganzzahl): Dauer des Segments

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

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

  • sentiment (Ganzzahl): Stimmung des Endnutzers

  • response_count (Ganzzahl): Anzahl der Antworten 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 Anruf weitergeleitet wurde.

  • transfer_id (Ganzzahl): Kennung des Übertragungsereignisses

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

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

Bearbeitungszeiten für Endnutzer

• consumer_handle_durations (Array): Dauer des Anrufs für den Endnutzer

  • id (Ganzzahl): die ID

  • call_duration (Ganzzahl): Dauer des Endnutzersegments

  • hold_duration (Ganzzahl): Dauer des Holds für den Endnutzer

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

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

Dauer von Endnutzerereignissen

• consumer_event_durations (Array): Details zu Anrufereignissen von Endnutzern. Zum Beispiel CSAT oder Zahlung.

  • id (Ganzzahl): die ID

  • 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

Dauer der Menüaufrufe durch Endnutzer

• consumer_in_menu_durations (Array): Dauer der Endnutzerinteraktionen in Menüs

  • id (Ganzzahl): die ID

  • duration (Ganzzahl): Dauer im Menü

  • event (String): Ergebnis der Menüinteraktion

  • 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

• participants (Array): Informationen zu jedem Teilnehmer des Anrufs. Beispiele: Kunde, Kundenservicemitarbeiter, virtueller Kundenservicemitarbeiter.

  • id (Ganzzahl): Die Kennzeichnung für den Teilnehmer

  • type (String): Typ des Teilnehmers. Beispiel: end_user, agent, virtual_agent usw.

  • entry_type (String): Wie der Teilnehmer dem Anruf 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. Zum Beispiel „Warten“, „Verbunden“, „Abgeschlossen“ usw.

  • 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

  • call_id (Ganzzahl): Kennung für den Anruf

  • call_duration (Ganzzahl): Anrufdauer für den Teilnehmer

  • hold_duration (Ganzzahl oder null): Dauer der Holdout-Gruppe für den Teilnehmer

  • ended_at (string, date-time): Zeitstempel für das Ende der Teilnahme des Teilnehmers

  • adapter_fail_code (Ganzzahl oder null): Numerischer Code, der dem Grund für den Fehler entspricht

  • adapter_fail_message (String oder null): menschenlesbare Beschreibung von fail_reason, falls verfügbar.

Aufzeichnungen

• recordings (Array): Informationen zu Anrufaufzeichnungen

  • id (Ganzzahl): die Kennung für die Aufzeichnung

  • call_id (Ganzzahl): Anrufer-ID

  • conference_sid (String): Anrufer-ID des VoIP-Anbieters

  • duration (Ganzzahl): Aufnahmedauer

  • recording_type (String): Aufzeichnungstyp

  • redaction_times (Array): Zeitsegmente, die entfernt wurden

  • started_at (string, date-time): Zeitstempel für den Beginn der Aufzeichnung

Events anbieten

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

• offer_events (Array): Ereignisse, bei denen der Anruf an Kundenservicemitarbeiter weitergeleitet wurde

  • casting_time (date-time): Zeitpunkt, zu dem der Anruf angeboten wurde

  • group (String): Gruppe, an die der Anruf weitergeleitet wurde

Sonstige Details

• answer_type (String oder Null): Gibt an, wie der Anruf entgegengenommen wurde. Zum Beispiel manuell oder automatisch.

• outbound_number (String): verwendete abgehende Telefonnummer

• wait_time_sms (Array): SMS-Interaktionen zur Wartezeit

• in_call_sms (Array): SMS-Interaktionen während des Anrufs

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

• 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, in dem wiederverwendbare Schemakomponenten definiert werden:

• menu_path: ein hierarchischer Menüpfad

• agent: ein menschlicher Kundenservicemitarbeiter

• virtual_agent: ein virtueller Kundenservicemitarbeiter

• deflection: Definiert die möglichen Status für die Ablenkung.