Metadaten der Anrufsitzung

In diesem Dokument finden Sie das Schema des Datensatzes Sitzungsmetadaten, also des JSON-Dokuments, das die CCAI Platform am Ende jedes Sprachanrufs ausgibt. Die CCAI Platform liefert den Datensatz als Text des Befehls zum Beenden der Sitzung an Ihre CRM-Integration und schreibt den Datensatz als metadata.json-Datei in Ihre Konfiguration für externen Speicher. Bei jedem Aufruf wird genau ein Datensatz erzeugt. Die id auf oberster Ebene identifiziert jeden Eintrag eindeutig. Mit diesem Schema können Sie Datensätze in nachgelagerte Systeme aufnehmen, empfangene Nutzlasten validieren oder Felder auf Data-Warehouse-Spalten abbilden.

Schemastamm

Der Metadatensatz der Anrufsitzung ist ein einzelnes JSON-Objekt, das eine Sprachanrufsitzung darstellt. Drei Konzepte auf der obersten Ebene bestimmen die Identität und Form des Datensatzes.

Primärschlüssel – id (Ganzzahl)

Die oberste Ebene id identifiziert die Anrufsitzung innerhalb Ihrer Instanz eindeutig. Pro Anruf gibt es einen Datensatz. Alle anderen Felder, Arrays und verschachtelten Objekte auf oberster Ebene beschreiben Attribute des Aufrufs, der durch diese id identifiziert wird.

Handler-Diskriminator – agent_info (Objekt, oneOf)

Ein einzelnes Objekt, dessen Form je nach dem letzten Handler des Aufrufs variiert. Die beiden Varianten schließen sich gegenseitig aus und der Schlüssel kann auch ganz fehlen. Ein Eintrag enthält also höchstens einen von drei Fällen:

• Variante mit menschlichem Kundenservicemitarbeiter: Vorhanden, wenn der Anruf von einem menschlichen Kundenservicemitarbeiter und nicht von einem virtuellen Kundenservicemitarbeiter entgegengenommen wurde. Enthält zusätzlich zu den freigegebenen Feldern id, name und avatar_url die Felder email, first_name, last_name und agent_number.

• Variante des virtuellen Kundenservicemitarbeiters: Vorhanden, wenn der Anruf von einem virtuellen Kundenservicemitarbeiter und nicht von einem menschlichen Kundenservicemitarbeiter entgegengenommen wurde. Überträgt va_alias und lässt email, first_name, last_name und agent_number aus.

• Schlüssel fehlt: Der Schlüssel agent_info wird in zwei Fällen weggelassen: wenn der Anruf weder einen menschlichen noch einen virtuellen Kundenservicemitarbeiter hatte und wenn er beide hatte. Ein Anruf enthält beide, wenn ein virtueller Kundenservicemitarbeiter bei einer Eskalation an einen menschlichen Kundenservicemitarbeiter beibehalten wird. Ein vollständig bearbeiteter Anruf kann also ohne den Schlüssel eingehen.

Wenn Sie herausfinden möchten, welche Variante ein Eintrag enthält, prüfen Sie zuerst, ob der Schlüssel agent_info überhaupt vorhanden ist. Suchen Sie dann nach einem variantenspezifischen Feld – in der Regel agent_info.email für die Variante mit menschlichem Kundenservicemitarbeiter oder agent_info.va_alias für die Variante mit virtuellem Kundenservicemitarbeiter. Leiten Sie den Bearbeiter nicht allein aus agent_info ab. Lesen Sie bei einem Anruf, der beides hatte, den menschlichen Kundenservicemitarbeiter aus participants[] und den virtuellen Kundenservicemitarbeiter aus virtual_agent_handle_durations[] oder den Feldern from_virtual_agent und to_virtual_agent in transfers[] und escalations[]. Die vollständige Form der einzelnen Varianten finden Sie unter agent und virtual_agent.

Call-Shape-Diskriminatoren – call_type, session_type, session_type_v2 (String)

Drei parallele Ansichten desselben zugrunde liegenden Aufruftyps. Sie sind sich immer einig, welchen Aufruftyp ein Eintrag darstellt. Sie unterscheiden sich nur im Vokabular, das sie zur Benennung des Aufruftyps verwenden.

• call_type verwendet das Legacy-Enum-Vokabular (z. B. Voice Inbound (App), Voice Outbound oder Voice Internal).

• session_type gibt immer denselben String wie call_type zurück. Die CCAI Platform stellt dieses Feld für die Abwärtskompatibilität mit Integrationen bereit, die auf diesem Feld basieren. Behandeln Sie es als veralteten Alias von call_type. Weitere Informationen finden Sie unter Versionsverwaltung und Einstellungen.

• session_type_v2 verwendet das aktuelle Enum-Vokabular. Dieses Vokabular erweitert das call_type-Vokabular um detailliertere eingehende Unterscheidungen, z. B. Voice Inbound (Mobile) und Voice Inbound (IVR via Mobile) anstelle der allgemeineren Begriffe Voice Inbound (App) und Voice Inbound (IVR via App). Für Aufruftypen, die keinen v2-spezifischen Wert haben, gibt session_type_v2 denselben String wie call_type zurück. Neue Integrationen sollten session_type_v2 parsen.

Die Werte für die einzelnen Felder finden Sie unter Wichtige Informationen.

Wichtige Informationen

Diese Properties erfassen die wichtigsten Informationen des Anrufs:

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

• call_uuid (String oder null): Eine eindeutige Kennung, die einen Aufruf über Ursprungs- und Empfangsinstanzen in Interaktionen mit dynamischem Aufrufrouting (DCR) hinweg korreliert. Beide Teile eines DCR-Aufrufs haben denselben call_uuid-Wert, sodass Kunden Daten zwischen Umgebungen übertragen können. Das Feld ist null oder leer für alle Anrufe, die keine DCR-Interaktionen sind, und für Anrufe, die vor dem Hinzufügen des Felds durch die CCAI Platform stattgefunden haben.

• lang (String): Der ISO 639-Sprachcode für den Anruf (z. B. „de“ für Deutsch oder „en“ für Englisch). Mit diesem Code können Sie sprachspezifische Analysen und Berichte erstellen.

• call_type (String): Der Typ des Aufrufs, wobei das Vokabular des alten Typs verwendet wird. Zu den Werten gehören „Voice Inbound (App)“, „Voice Inbound (Web)“, „Voice Inbound (IVR)“, „Voice Inbound (IVR via App)“, „Voice Inbound (API)“, „Voice Inbound (Direct)“, „Voice Inbound (Extension)“, „Voice Scheduled (App)“, „Voice Scheduled (Web)“, „Voice Scheduled (API)“, „Voice Callback“, „Voice Callback (Web)“, „Voice Outbound“, „Voice Outbound (API)“, „Voice Outbound (Direct)“, „Voice Outbound (UCaaS)“, „Voice Internal“, „Voice Campaign (Acqueon)“, „Voice Campaign (<Ihr Markenname>)“ und „Agent Scheduled Call“.

• session_type (String): Ein Duplikat von call_type (gleiche Werte), das die CCAI Platform aus Gründen der Abwärtskompatibilität beibehält. Siehe Versionsverwaltung und Einstellungen: Legacy-Duplikate.

• session_type_v2 (String): Der Typ des Anrufs, wobei das aktuelle Typvokabular verwendet wird. Die call_type-Werte werden durch detailliertere Unterscheidungen für eingehende Anrufe verfeinert (z. B. „Voice Inbound (Mobile)“ und „Voice Inbound (IVR via Mobile)“ anstelle von „Voice Inbound (App)“ und „Voice Inbound (IVR via App)“). Zu den Werten gehören „Voice Inbound (Mobile)“, „Voice Inbound (Web)“, „Voice Inbound (IVR)“, „Voice Inbound (IVR via Mobile)“, „Voice Inbound (API)“, „Voice Inbound (Direct)“, „Voice Inbound (Extension)“, „Voice Scheduled (Mobile)“, „Voice Scheduled (Web)“, „Voice Scheduled (API)“, „Voice Callback“, „Voice Callback (Web)“, „Voice Outbound“, „Voice Outbound (API)“, „Voice Outbound (Direct)“, „Voice Outbound (UCaaS)“, „Voice Internal“, „Voice Campaign (Acqueon)“, „Voice Campaign (<your brand name>)“ und „Agent Scheduled Call“.

• status (String): Der Status des Anrufs, der den Fortschritt im Lebenszyklus des Anrufs verfolgt. Mögliche Werte, gruppiert nach Lebenszyklusphase:

  • Vor der Verbindung: "scheduled", "selecting", "queued", "assigned", "connecting", "switching", "requeued", "requeued_detection_missed".

  • Verbunden: "connected".

  • Virtueller Agent: "va_assigned", "va_connected".

  • Kampagne: "preview_pending", "preview_ready", "preview_waiting", "predictive_waiting", "progressive_waiting", "campaign_dialing", "campaign_connecting", "campaign_connected".

  • Nur Aktion: "action_only", "action_only_finished".

  • Mailbox: "voicemail", "voicemail_received", "voicemail_read", "voicemail_forwarded".

  • Terminal: "finished", "failed", "recovered", "deflected".

    Hinweis: "recovered" bedeutet, dass ein zuvor fehlgeschlagener Aufruf wiederholt und erfolgreich abgeschlossen wurde.

• created_at (String, Datum/Uhrzeit): Der genaue Zeitstempel, zu dem die CCAI Platform den Anrufdatensatz erstellt hat.

• queued_at (String, Datum/Uhrzeit oder Null): Der Zeitstempel, zu dem der Aufruf in die Warteschlange aufgenommen wurde, oder Null, wenn der Aufruf nicht in die Warteschlange aufgenommen wurde.

• assigned_at (String, Datum/Uhrzeit oder null): Der Zeitstempel, zu dem die CCAI Platform den Anruf einem Kundenservicemitarbeiter zugewiesen hat, oder null, wenn die CCAI Platform den Anruf nicht zugewiesen hat.

• connected_at (String, Datum/Uhrzeit oder Null): Der Zeitstempel, zu dem der Anruf verbunden 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, zu dem die CCAI Platform den Anruf geplant hat, oder null, wenn der Anruf sofort erfolgte.

• updated_at (String, Datum/Uhrzeit): Der Zeitstempel, der angibt, wann die CCAI Platform die Anrufdaten zuletzt aktualisiert hat.

• wait_duration (Ganzzahl oder null): Die Gesamtzeit, die der Kunde während des gesamten Anrufs in der Warteschlange verbracht hat, in Sekunden, oder null, wenn die CCAI Platform keine Warteschlangenzeit aufgezeichnet hat. Die nach einzelnen Segmenten aufgeschlüsselte Warteschlangenzeit finden Sie im Array queue_durations (Warteschlangendauer). Weitere Informationen finden Sie unter Versionsverwaltung und Einstellungen: Nomenklatur des Felds „Wartezeit“.

• call_duration (Ganzzahl oder Null): Die Gesamtdauer des Anrufs in Sekunden.

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

• rating (Ganzzahl oder null): Die vom Kunden eingereichte Bewertung der Kundenzufriedenheit (CSAT) oder null, wenn der Kunde keine Bewertung eingereicht hat.

• has_feedback (boolescher Wert): Ein Flag, das angibt, ob der Nutzer nach dem Anruf Feedback gegeben hat.

• voip_provider (String): Der VoIP-Anbieter für den Anruf. (Hinweis: Dieses Feld wurde eingestellt und gibt immer „deprecated“ zurück.)

• out_ticket_id (String oder Null): Die ID des Tickets, das die CCAI Platform im externen CRM-System erstellt hat.

• out_ticket_url (String, URI oder Null): Die URL des CRM-Tickets.

• is_out_ticket_account (boolescher Wert oder null): Gibt an, ob das CRM-Ticket einen Kunden (true) oder eine Anrufinteraktion (false) darstellt.

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

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

• recording_permission (String oder Null): Der Status der Aufnahmeberechtigung des Nutzers. Mögliche Werte: „not_asked“, „granted“, „denied“.

• voicemail_reason (String): Der Grund, warum eine Mailboxnachricht hinterlassen wurde, oder "not_voicemail", wenn der Anruf nicht an die Mailbox weitergeleitet wurde. Mögliche Werte: "not_voicemail", "temporary_redirection", "after_hour_deflection", "over_capacity_deflection", "no_input" und "no_agent".

• disconnected_by (String oder Null): Gibt an, welche Partei den Anruf beendet hat. Mögliche Werte: disconnected_by_unknown, disconnected_by_agent, disconnected_by_end_user, disconnected_by_virtual_agent, disconnected_by_system.

• fail_reason (String oder Null): Der Grund für das Fehlschlagen eines Anrufs oder "nothing" für Anrufe, die nicht fehlgeschlagen sind. Mögliche Werte, gruppiert nach der Partei oder dem Subsystem, dem der Fehler zugeschrieben wird:

  • Kein Fehler: nothing

  • Allgemein: unknown, expired, transfer_expired, canceled_outside_fulfillment_hours

  • Endnutzer: eu_canceled, eu_rejected, eu_abandoned, eu_in_menu_abandoned, eu_repeated_voicemail, eu_repeated_callback, eu_dcr_abandoned_on_receiving, eu_busy, eu_wrong_number, eu_no_answer, eu_noti_failed, eu_phone_denied

  • Agent: ag_canceled, ag_ignored, ag_declined, ag_mic_no_device, ag_mic_denied, ag_invalid_outbound_num, ag_called_blocked_num

  • Verbindung: conn_decline

  • VoIP: voip_twilio_error, voip_tokbox_error, voip_invalid_token, voip_conn_general, voip_conn_timeout, voip_conn_signal, voip_conn_codec, voip_nexmo_error, voip_telnyx_error

  • Audio: audio_not_received_by_carrier, audio_device_unable_to_start

  • Blockierter oder nicht auflösbarer Zustand: stuck_due_to_api_error, group_deleted_no_substitute, menu_deleted, direct_pstn_call_to_fallback_number

  • Kampagne: campaign_paused, campaign_queue_reassigned, campaign_no_incoming_contacts, campaign_call_canceled

  • Erzwungen beendet: force_ended, force_failed_call_stuck

    Hinweis: voip_tokbox_error wird nur in historischen Datensätzen angezeigt.

• fail_details (String oder Null): Zusätzliche menschenlesbare Details zu fail_reason, falls verfügbar.

• adapter_fail_code (Ganzzahl oder null): Numerischer Code, der fail_reason auf Aufrufebene entspricht. Null, wenn der Aufruf nicht fehlgeschlagen ist. Dieselbe Aufzählung wird für die teilnehmerspezifischen adapter_fail_code in § 17 verwendet.

• adapter_fail_message (String oder null): menschenlesbare Nachricht, die adapter_fail_code entspricht. Null, wenn der Aufruf nicht fehlgeschlagen ist.

• support_number (String oder Null): Die Telefonnummer, die der Nutzer gewählt hat, um das Contact Center zu erreichen, im E.164-Format. Wird für IVR-Anrufe ausgefüllt; kann für andere Kanäle null sein.

• queue_priority_level (Ganzzahl; nur vorhanden, wenn die Warteschlangenpriorität für Ihr Konto aktiviert ist): Die dem Anruf zugewiesene Warteschlangenpriorität.

Informationen zu Agenten und virtuellen Agenten

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

• agent_info (Objekt): Dieses Feld kann Informationen zu einem menschlichen Kundenservicemitarbeiter oder einem virtuellen Agenten enthalten. Mit dem Schlüsselwort oneOf wird angegeben, dass es sich um einen von zwei Typen handeln kann.

  • agent (Objekt): Informationen zum menschlichen Kundenservicemitarbeiter:

    • id (Ganzzahl): Die eindeutige ID des KI-Agenten.

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

    • email (String, E‑Mail-Adresse): Die E‑Mail-Adresse des KI-Agenten.

    • name (String): Der vollständige Name des KI-Agenten.

    • last_name (String): Der Nachname des KI-Agenten.

    • first_name (String): Der Vorname des Kundenservicemitarbeiters.

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

  • virtual_agent (Objekt): Informationen zum virtuellen Agenten:

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

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

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

    • va_alias (String oder null): Der Anzeigename für den virtuellen Agenten, falls Sie einen festgelegt haben. Immer in der Nutzlast vorhanden; null, wenn kein Alias festgelegt ist.

Menünavigation

• selected_menu (Objekt oder null): Informationen zum Menü, das der Nutzer während des Anrufs ausgewählt hat.

  • id (Ganzzahl): Die eindeutige ID der Speisekarte.

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

  • parent_id (Ganzzahl oder null): Die ID des Elternmenüs, falls 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 Typ der Speisekarte (z. B. 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 Nutzer aufgerufen hat.

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

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

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

• automation_redirection (Objekt; nur vorhanden, wenn das erste Umleitungslog des Anrufs mit einer Umleitungsgruppe verknüpft ist): Details zur prozentualen Warteschlangenumleitung, die sich auf das Routing dieses Anrufs ausgewirkt hat.

  • percent_redirection (boolesch): Gibt an, ob Sie die prozentbasierte Weiterleitung im Quellmenü aktiviert haben.

  • redirection_group (Array): Array mit einem Element, das die Details der Weiterleitungsgruppe enthält:

    • group_label (String): Menschenlesbares Label für die Weiterleitungsgruppe (z. B. „Weiterleitungsgruppe 1“).

    • destination (Objekt oder null): Das Weiterleitungsziel, das Sie für die Gruppe konfiguriert haben.

    • after_hours (boolescher Wert oder null): Gibt an, ob Sie für die Gruppe Optionen für die Weiterleitung außerhalb der Geschäftszeiten aktiviert haben.

    • ah_destination (Objekt oder null): Das Weiterleitungsziel für Anrufe außerhalb der Geschäftszeiten, das Sie für die Gruppe konfiguriert haben.

Endnutzerdetails

• end_user (Objekt oder null): Informationen zum Verbraucher:

  • id (Ganzzahl oder null): Die interne ID des Nutzers.

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

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

Benutzerdefinierte und vom SDK bereitgestellte Daten

• customer_flag (Objekt; nur vorhanden, wenn die Website benutzerdefinierte Authentifizierungsdaten übergeben hat): Benutzerdefinierte Datenattribute im Zusammenhang mit der Authentifizierung, die die App oder Website des Nutzers zu Beginn der Sitzung übergeben hat. Die Nutzlast enthält nur die Teilmenge, die Sie als Authentifizierungsparameter festlegen.

• api_dap_request (Objekt; nur vorhanden, wenn Sie Datenparameter aktivieren und in Metadaten einbeziehen): Ein Snapshot der Datenparameterwerte des Aufrufs. Schlüssel und Werttypen hängen von der Konfiguration Ihrer Datenparameter ab.

• form_responses (Array; nur vorhanden, wenn der Nutzer mindestens eine Formularantwort gesendet hat): Antworten, die während der Sitzung über In-Call-SDK-Formulare erfasst wurden. Jeder Eintrag enthält Folgendes:

  • id (String oder Ganzzahl): Kennung der Formularantwort.

  • title (String): Formular-Titel, der dem Verbraucher angezeigt wird.

  • smart_action_id (Ganzzahl oder null): Kennung der Smart Action, die das Formular ausgelöst hat, falls vorhanden.

  • questions (Array): Die erfassten Frage-Antwort-Paare.

Anhänge

• photos (Array): Fotos, die der Nutzer während des Anrufs hochgeladen hat.

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

  • photo_type (String): Typ oder Quelle des Fotos (z. B. „photo“).

  • url (String, URI): URL zum gespeicherten Foto.

  • smart_action_type (String oder Null): Die Smart-Aktion, die das Foto erzeugt hat, falls vorhanden.

  • transfer_id (Ganzzahl oder null): Die Übertragungsereignis-ID für das Foto, wenn der Nutzer es nach einer Übertragung hochgeladen hat.

• videos (Array): Videos, die der Nutzer während des Anrufs hochgeladen hat.

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

  • url (String, URI): URL zum gespeicherten Video.

  • smart_action_type (String oder null): Die Smart Action, die das Video erzeugt hat, falls vorhanden.

  • transfer_id (Ganzzahl oder null): Die Übertragungsereignis-ID für das Video, wenn der Nutzer es nach einer Übertragung hochgeladen hat.

Anrufumleitung

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

• deflection_details (Array): Ein detailliertes Protokoll der Ablenkungen während des Anrufs. Das Feld „deflection“ in jedem Eintrag verwendet die Aufzählung, die unter Definitionen: deflection definiert ist. Jeder Eintrag enthält Folgendes:

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

  • call_id (Ganzzahl): Eindeutige Kennung des Anrufs.

  • transfer_id (Ganzzahl oder null): Eindeutige Kennung der Übertragung, die mit der Ablenkung verknüpft ist, falls zutreffend.

  • deflection (String; zulässige Werte siehe Definitionen: Ablenkung): Der Typ der Ablenkung.

  • created_at (String, Datum/Uhrzeit): Zeitstempel, zu dem die Ablenkung aufgetreten ist.

  • from_menu_path (Objekt oder null): Menüpfad, von dem aus die Ablenkung gestartet wurde.

  • to_menu_path (Objekt oder null): Menüpfad, zu dem die CCAI Platform den Anruf umgeleitet hat.

  • to_sip_uri (String; nur vorhanden, wenn die CCAI Platform den Anruf an ein SIP-Ziel weitergeleitet hat): SIP-URI, an den die CCAI Platform den Anruf gegebenenfalls weitergeleitet hat.

  • to_sip_headers (Objekt; nur vorhanden, wenn die CCAI Platform den Anruf an ein SIP-Ziel weitergeleitet hat): SIP-Header, mit denen die CCAI Platform den Anruf gegebenenfalls weitergeleitet hat.

Übertragungen

• transfers (Array): Ein Eintrag pro Übertragungsereignis während des Anrufs. Zeichnet sowohl Weiterleitungen mit als auch ohne Rücksprache zwischen Kundenservicemitarbeitern, virtuellen Kundenservicemitarbeitern und Menüs auf.

  • id (Ganzzahl): Eindeutige Kennung für die Übertragung.

  • status (String): Aktueller Status der Übertragung (z. B. „Übertragung läuft“, „Verbunden“ oder „Fehlgeschlagen“).

  • fail_reason (String): Grund für das Fehlschlagen der Übertragung oder „nothing“, wenn sie nicht fehlgeschlagen ist.

  • created_at (String, Datum/Uhrzeit): Zeitpunkt, zu dem die Übertragung gestartet wurde.

  • assigned_at (String, Datum/Uhrzeit oder Null): Wann die CCAI Platform die Übertragung dem Empfänger zugewiesen hat.

  • connected_at (String, Datum/Uhrzeit oder Null): Wann die Übertragung verbunden wurde.

  • updated_at (String, Datum/Uhrzeit): Wann die CCAI Platform den Übertragungseintrag zuletzt aktualisiert hat.

  • call_duration (Ganzzahl): Dauer des übertragenen Segments in Sekunden.

  • wait_duration (Ganzzahl): Zeit, die der Nutzer während der Übertragung gewartet hat, in Sekunden.

  • deflection (String): Ablenkungstyp, der mit der Übertragung verknüpft ist, falls vorhanden.

  • answer_type_path (String oder Null): Pfad, der beschreibt, wie der weitergeleitete Anruf aufgelöst wurde.

  • from_menu_path / to_menu_path (Objekt oder null): Menüpfad vor und nach der Übertragung; gleiche Form wie menu_path in Definitionen.

  • from_agent / to_agent (Objekt oder null): Menschlicher Kundenservicemitarbeiter auf jeder Seite der Übergabe; gleiche Form wie das agent-Objekt in Definitionen.

  • from_virtual_agent / to_virtual_agent (Objekt oder null): Virtueller Agent auf jeder Seite der Übertragung; gleiche Form wie das virtual_agent-Objekt in Definitionen.

  • from_queue_priority_level / to_queue_priority_level (Ganzzahl oder null): Warteschlangenpriorität vor und nach der Übertragung. Nur vorhanden, wenn Sie die Warteschlangenpriorität für Ihr Konto aktivieren.

Dauer der Anrufbearbeitung

• handle_durations (Array): Ein Array von Objekten, die jeweils ein Segment des Anrufs darstellen, das von einem Kundenservicemitarbeiter bearbeitet wurde. Dies unterstützt die Analyse der Bearbeitungszeit von KI-Agenten.

  • id (Ganzzahl): Eindeutige Kennung für die Bearbeitungsdauer.

  • agent_id (Ganzzahl): ID des KI-Agenten.

  • acw_duration (Ganzzahl): Dauer der Anrufnachbereitung.

  • bcw_duration (Ganzzahl): Dauer der Anrufvorbereitung.

  • call_duration (Ganzzahl): Dauer des Anrufs während dieses Segments.

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

  • menu_path (String): Name des Menüpfads.

  • lang (String): Verwendete Sprache.

  • barged (boolesch): Gibt an, ob sich der Supervisor in den Anruf eingeschaltet hat.

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

  • transfer_id (Ganzzahl oder null): ID der Übertragung.

  • transfer_cold (boolescher Wert oder null): Gibt an, ob die Übertragung kalt war.

  • started_at (String, Datum/Uhrzeit): Startzeitstempel.

  • ended_at (String, Datum/Uhrzeit oder Null): Endzeitstempel.

  • scheduled_at (String, Datum/Uhrzeit oder Null): Geplanter Zeitstempel.

  • hold_duration (Ganzzahl oder null): Dauer des Haltens während dieses Segments.

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

  • session_breakthrough (Objekt; nur vorhanden, wenn der Anruf den Status „Nicht verfügbar“ eines Agenten durchbrochen hat): Details zur Zuweisung des Anrufs, der den Status „Nicht verfügbar“ eines Agenten durchbrochen hat, falls zutreffend.

Warteschlangendauer

• queue_durations (Array): Ein Array von Objekten, die jeweils ein Segment des Anrufs darstellen, in dem sich der Kunde in einer Warteschlange befand. Dies unterstützt die Analyse von Wartezeiten und Service-Levels.

  • id (Ganzzahl): Eindeutige Kennung für die Warteschlangendauer.

  • agent_id (Ganzzahl): ID des KI-Agenten.

  • ended_at (String, Datum/Uhrzeit): Endzeitstempel.

  • 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): Startzeitstempel.

  • 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 oder null): ID der Übertragung.

  • service_level_abandon_time_threshold (Ganzzahl): Zeitschwellenwert für den Abbruch des Servicelevels.

  • service_level_event (String): Status des Service-Level-Ereignisses („excluded“, „in_sla“, „not_in_sla“).

  • service_level_target_percent (Ganzzahl): Zielprozentsatz für die Einhaltung des Servicelevels.

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

Eskalationen von virtuellen an menschliche Kundenservicemitarbeiter

• escalations (Array): Jeder Eintrag steht für eine Eskalation von einem virtuellen Kundenservicemitarbeiter zu einem menschlichen Kundenservicemitarbeiter.

  • id (Ganzzahl): Eindeutige Kennung für die Eskalation.

  • status (String): Aktueller Status der Eskalation. Mögliche Werte: escalating, "escalated", "canceled", "deflecting" und "deflected".

  • reason (String): Grund für die Eskalation der Sitzung.

  • created_at (String, Datum/Uhrzeit): Zeitpunkt, zu dem die Eskalation begonnen hat.

  • escalated_at (String, Datum/Uhrzeit oder Null): Zeitpunkt, zu dem die Eskalation abgeschlossen wurde.

  • from_virtual_agent (Objekt oder null): Virtueller Agent, der den Anruf eskaliert hat. Gleiche Form wie das virtual_agent-Objekt in Definitionen.

  • to_agent (Objekt oder null): Menschlicher Kundenservicemitarbeiter, an den der Anruf weitergeleitet wurde. Gleiche Form wie das agent-Objekt in Definitionen.

  • from_menu_path / to_menu_path (Objekt oder Null): Menüpfad vor und nach der Eskalation.

Vom virtuellen Kundenservicemitarbeiter abgewendete Eskalationen

• virtual_agent_deflected_escalations (Array): Details zu abgewiesenen Eskalationen von virtuellen Agenten.

  • id (Ganzzahl): Eindeutige Kennung.

  • deflection (String): Art der Ablenkung, die für die abgelenkte Eskalation aufgezeichnet wurde. Dieses Vokabular ist kleiner als das Feld für die Ablenkung auf Anrufebene, das unter Definitionen: Ablenkung beschrieben wird. Es deckt nur die Ergebnisse ab, die bei einer Eskalation durch einen virtuellen Kundenservicemitarbeiter aufgezeichnet werden können. Mögliche Werte:

    • Überkapazität: over_cap, over_cap_phone, over_cap_voicemail, over_cap_callback, over_cap_message, over_cap_queue, over_cap_sip, over_cap_extension, over_cap_phone_with_extension

    • Außerhalb der Geschäftszeiten: after_hours, after_hours_phone, after_hours_voicemail, after_hours_message, after_hours_message_only, after_hours_queue, after_hours_sip, after_hours_extension, after_hours_phone_with_extension

    • Temporäre Weiterleitung: temp_redirection, temp_redirection_phone, temp_redirection_voicemail, temp_redirection_message, temp_redirection_queue, temp_redirection_sip, temp_redirection_extension, temp_redirection_phone_with_extension

    • IVR-Vorsitzung: ivr_presession_deflection

    • Vom virtuellen Kundenservicemitarbeiter initiiert: va_redirection_phone, va_redirection_sip, va_third_party_phone, va_third_party_sip

    Die Werte over_cap, after_hours und temp_redirection ohne Suffix werden aufgezeichnet, wenn der Anruf beendet wurde, bevor ein Ergebnis für die Weiterleitung erreicht wurde.

  • escalation_id (Ganzzahl): Kennung des Eskalationsereignisses.

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

  • escalated_at (String, Datum/Uhrzeit): Zeitstempel der Eskalation.

  • menu_path_id (Ganzzahl): ID des Menüpfads.

  • menu_path (String): Menüpfad.

  • lang (String): Sprache.

  • virtual_agent (Objekt): Details zum virtuellen Agenten. Siehe Definitionen.

Bearbeitungsdauer durch virtuelle Kundenservicemitarbeiter

• virtual_agent_handle_durations (Array): Zeitsegmente, in denen ein virtueller Agent den Anruf bearbeitet hat.

  • id (Ganzzahl): Eindeutige Kennung.

  • virtual_agent (Objekt): Details zum virtuellen Agenten. Siehe Definitionen.

  • 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): Verbraucherstimmung.

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

  • fallback_response_count (Ganzzahl): Anzahl der Fallback-Antworten.

  • initiated_by (String): Wie die Sitzung des virtuellen Agenten gestartet wurde.

  • menu_path_id (Ganzzahl): ID des Menüpfads.

  • menu_path (String): Menüpfad.

  • lang (String): Sprache.

  • transfer (boolesch): Gibt an, ob der Anruf weitergeleitet wurde.

  • transfer_id (Ganzzahl oder null): Kennung des Übertragungsereignisses.

  • started_at (String, Datum/Uhrzeit): Startzeitstempel.

  • ended_at (String, Datum/Uhrzeit oder Null): Endzeitstempel.

Bearbeitungsdauer für Verbraucher

• consumer_handle_durations (Array): Dauer des Anrufs des Nutzers.

  • id (Ganzzahl): Eindeutige Kennung.

  • call_duration (Ganzzahl): Dauer des Verbrauchersegments.

  • hold_duration (Ganzzahl oder null): Dauer der festen Einstellung durch den Nutzer.

  • started_at (String, Datum/Uhrzeit): Startzeitstempel.

  • ended_at (String, Datum/Uhrzeit): Endzeitstempel.

Dauer von Verbraucherereignissen

• consumer_event_durations (Array): Details zu Ereignissen bei Anrufen von Nutzern (z. B. CSAT oder Zahlung).

  • id (Ganzzahl): Eindeutige Kennung.

  • duration (Ganzzahl): Ereignisdauer.

  • type (String): Ereignistyp.

  • event (String): Ereignisergebnis.

  • menu_path_id (Ganzzahl): ID des Menüpfads.

  • menu_path (String): Menüpfad.

  • lang (String): Sprache.

  • started_at (String, Datum/Uhrzeit): Startzeitstempel.

  • ended_at (String, Datum/Uhrzeit): Endzeitstempel.

Dauer der Menüanzeige für Verbraucher

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

  • id (Ganzzahl): Eindeutige Kennung.

  • duration (Ganzzahl): Dauer im Menü.

  • event (String): Ergebnis der Menüinteraktion.

  • menu_path_id (Ganzzahl): ID des Menüpfads.

  • menu_path (String): Menüpfad.

  • lang (String): Sprache.

  • started_at (String, Datum/Uhrzeit): Startzeitstempel.

  • ended_at (String, Datum/Uhrzeit): Endzeitstempel.

Teilnehmer*innen

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

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

  • type (String): Typ des Teilnehmers („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 Agent ist.

  • end_user_id (Ganzzahl oder null): Nutzer-ID, wenn der Teilnehmer der Nutzer ist.

  • virtual_agent_id (Ganzzahl oder null): ID des virtuellen Agenten, wenn der Teilnehmer ein virtueller Agent ist.

  • virtual_agent_params (Objekt; nur vorhanden, wenn Sie benutzerdefinierte Metadaten für den virtuellen Agenten konfigurieren): Benutzerdefinierte Metadaten, die der virtuelle Agent verwendet.

  • status (String): Status des Teilnehmers („waiting“, „connected“, „finished“ usw.).

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

  • connected_at (String, Datum/Uhrzeit oder Null): Zeitstempel, zu dem der Teilnehmer verbunden wurde.

  • phone_number (String; nur bei privaten Teilnehmern vorhanden): Telefonnummer des Teilnehmers.

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

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

  • hold_duration (Ganzzahl oder null): Dauer, die der Teilnehmer in der Warteschleife war.

  • ended_at (String, Datum/Uhrzeit oder Null): Zeitstempel, der angibt, wann die Beteiligung des Teilnehmers endete.

  • adapter_fail_code (Ganzzahl oder null): Numerischer Code, der dem Fehlergrund entspricht.

  • adapter_fail_message (String oder null): Menschenlesbare Beschreibung von fail_reason, falls vorhanden.

  • agent_assist (Objekt; nur bei Agent-Teilnehmern vorhanden, wenn Sie Agent Assist konfigurieren): Aktive Agent Assist-Einstellungen für diesen Teilnehmer.

  • virtual_agent (Objekt; nur bei Teilnehmern mit virtuellem Agent vorhanden): Details zum virtuellen Agent, der als dieser Teilnehmer fungiert – unterscheidet sich vom übergeordneten agent_info und von virtual_agent_params.

  • caller_id (String; nur vorhanden, wenn Sie die Anrufer-ID für SIP-Header in Ihrem Konto aktivieren, und nur für Nutzerteilnehmer): Anrufer-ID, die die CCAI Platform aus eingehenden SIP-Headern für diesen Nutzerteilnehmer extrahiert.

  • sip_headers (Objekt oder null): SIP-Header, die diesem Teilnehmer zugeordnet sind. Immer in der Nutzlast vorhanden; null, wenn die CCAI Platform keine Header erfasst.

  • location (String oder Null; nur bei Agent-Teilnehmern vorhanden): Der Standort des Agents.

  • location_id (Ganzzahl oder null; nur bei KI-Agenten vorhanden): Die Standort-ID.

  • email (String, E-Mail; nur bei KI-Agenten vorhanden): Die E-Mail-Adresse des KI-Agenten.

  • first_name (String oder Null; nur bei KI-Agenten vorhanden): Der Vorname des KI-Agenten.

  • last_name (String oder Null; nur bei Agenten-Teilnehmern vorhanden): Der Nachname des Agenten.

  • middle_name (String oder Null; nur bei Agenten vorhanden): Der zweite Vorname des Agenten.

  • teams (Array; nur bei Agent-Teilnehmern vorhanden): Array von { id, name }-Objekten für die Teams des Agents.

Aufzeichnungen

• recordings (Array): Informationen zu aufgezeichneten Anrufen.

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

  • call_id (Ganzzahl): Anrufkennung.

  • conference_sid (String oder Null): Anrufkennung des VoIP-Anbieters.

  • duration (Ganzzahl oder null): Aufnahmedauer.

  • recording_type (String): Art der Aufzeichnung.

  • redaction_times (Array): Entfernte Zeitsegmente.

    • start (String, Datum/Uhrzeit): Beginn des Redaktionsintervalls.

    • end (String, Datum/Uhrzeit): Zeitpunkt, zu dem das Redaktionsintervall endete.

    • duration (Ganzzahl): Dauer der Entfernung in Sekunden.

    • start_agent_id (Ganzzahl oder null): Der Agent, der die Entfernung gestartet hat.

    • end_agent_id (Ganzzahl oder null): Der Agent, der die Schwärzung beendet hat.

  • started_at (String, Datum/Uhrzeit): Zeitstempel für den Beginn der Aufzeichnung.

• post_processed_recordings (Array; nur vorhanden, wenn Sie die Nachbearbeitung von Aufzeichnungen in Ihrem Konto aktivieren): Audioaufzeichnungen, die durch die Nachbearbeitung entstehen (z. B. Formatkonvertierung oder Schwärzung).

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

  • call_id (Ganzzahl): Anrufkennung.

  • duration (Ganzzahl): Aufnahmedauer in Sekunden.

  • started_at (String, Datum/Uhrzeit): Zeitstempel für den Beginn der Aufzeichnung.

  • recording_file_name (String): Dateiname des nachbearbeiteten Audio-Assets.

  • recording_url (String, URI): URL zur nachbearbeiteten Audiodatei.

  • agent_id (Ganzzahl oder String): Kennung des KI-Agenten, der dem Segment zugeordnet ist.

  • virtual_agent_id (Ganzzahl oder String): Kennung des virtuellen Agenten, der dem Segment zugeordnet ist, falls vorhanden.

  • conversation_id (String): Kennung, die diese Aufzeichnung mit dem zugehörigen Unterhaltungseintrag verknüpft.

• segments (Array; nur vorhanden, wenn Sie in Ihrem Konto Aufzeichnungen für nachbearbeitete Statistiken aktivieren): Audiosegmente (und optionale Bildschirmaufzeichnungssegmente) pro Teilnehmer, die das System für nachgelagerte Statistikpipelines erstellt.

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

  • call_id (Ganzzahl): Anrufkennung.

  • duration (Ganzzahl): Segmentdauer in Sekunden.

  • started_at (String, Datum/Uhrzeit): Zeitstempel für den Beginn des Segments.

  • audio_file_name (String): Dateiname des Audio-Assets des Segments.

  • audio_url (String, URI): URL zur Audiodatei des Segments.

  • agent_id (Ganzzahl oder String): Kennung des KI-Agenten, der dem Segment zugeordnet ist.

  • virtual_agent_id (Ganzzahl oder String): Kennung des virtuellen Agenten, der dem Segment zugeordnet ist, falls vorhanden.

  • participant_id (Ganzzahl oder String): Kennung des Teilnehmers, zu dem das Segment gehört.

  • conversation_id (String): Kennung, die dieses Segment mit dem zugehörigen Unterhaltungseintrag korreliert.

  • screen_recording_url (String, URI oder Null): URL zum passenden Bildschirmaufzeichnungs-Asset. Nur vorhanden, wenn Sie die Bildschirmaufzeichnung in Ihrem Konto aktivieren.

  • screen_recording_file_name (String oder null): Dateiname der Bildschirmaufzeichnung. Wird unter derselben Bedingung wie screen_recording_url angezeigt.

Ereignisse anbieten

• offer_type (String oder Null): Wie die CCAI Platform dem Kundenservicemitarbeiter den Anruf angeboten hat.

• offer_events (Array): Ereignisse, bei denen die CCAI Platform den Anruf Agenten angeboten hat.

  • casting_time (String, Datum/Uhrzeit): Zeitpunkt, zu dem die CCAI Platform den Anruf angeboten hat.

  • group (String): Gruppe, der die CCAI Platform den Anruf angeboten hat.

Sonstige Details

• answer_type (String oder Null): Wie der Anruf aufgelöst wurde („manual“ oder „auto“).

• outbound_number (String oder Null): Verwendete Telefonnummer für ausgehende Anrufe.

• wait_time_sms (Array; nur vorhanden, wenn bei diesem Anruf SMS-Interaktionen zur Wartezeit aufgetreten sind): SMS-Interaktionen, die die CCAI Platform an den Kunden zur erwarteten Wartezeit gesendet hat. Jeder Eintrag enthält Folgendes:

  • transfer_id (Ganzzahl oder null): Übertragungsereignis-ID, wenn mit einer Übertragung verknüpft.

  • status (String): Status der SMS. Mögliche Werte: not_triggered, triggered, triggered_allowed, triggered_denied, triggered_no_selection, triggered_sent, triggered_failed.

  • received (boolesch): Gibt an, ob der Nutzer die SMS erhalten hat.

• in_call_sms (Array; nur vorhanden, wenn während dieses Anrufs SMS-Interaktionen stattgefunden haben): SMS-Interaktionen während des Anrufs. Jeder Eintrag enthält Folgendes:

  • transfer_id (Ganzzahl oder null): Übertragungsereignis-ID, wenn mit einer Übertragung verknüpft.

  • preset_sent (boolesch): Gibt an, ob die CCAI Platform eine voreingestellte Nachricht gesendet hat.

  • custom_sent (boolesch): Gibt an, ob der Agent eine benutzerdefinierte Nachricht (Freitext) gesendet hat.

  • received (boolesch): Gibt an, ob die CCAI Platform eine SMS vom Nutzer erhalten hat.

• dispositions (Array; nur vorhanden, wenn Sie Nachbereitungscodes oder Notizen in Ihrem Konto aktivieren): Nachbereitungscodes und Notizen, die von Kundenservicemitarbeitern aufgezeichnet wurden. Jeder Eintrag enthält dynamisch gerenderte Felder, die auf Ihrer Nachbereitungskonfiguration basieren:

  • user_id (Ganzzahl): Agent-ID.

  • transfer_id (Ganzzahl oder null): ID des Übertragungsereignisses, falls nach einer Übertragung aufgezeichnet.

  • participant_id (Ganzzahl): Teilnehmer-ID.

  • note (String): Freitext-Notiz des Kundenservicemitarbeiters.

  • original_note (String): Originalversion der Notiz (vor der Bearbeitung).

  • code (String): Name des Dispositionscodes.

  • ujet_code_id (Ganzzahl oder leerer String): Die CCAI Platform-ID des Dispositionscodes – ein stabiler Schlüssel für den Code (der Anzeigename des Codes kann sich ändern). Leerer String, wenn nicht verfügbar.

  • list (String): Name der Liste, zu der der Code gehört.

  • list_path (String): Durch Schrägstriche getrennter Pfad der Codeliste.

  • ujet_list_id (Ganzzahl oder leerer String): Die CCAI Platform-ID der Liste, zu der der Dispositionscode gehört – ein stabiler Schlüssel für die Liste. Leerer String, wenn nicht verfügbar.

  • custom_list_id (String oder Ganzzahl): Vom Kunden definierte Listen-ID, falls zugeordnet.

  • custom_code_id (String oder Ganzzahl): Vom Kunden definierte Code-ID, falls zugeordnet.

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

• feedback (String oder null): Feedback des Nutzers.

• smart_action_text (String oder Null): Text der ausgeführten intelligenten Aktion.

• custom_data_secured (Objekt oder null): Benutzerdefinierte, sicher signierte Daten.

• custom_data_not_secured (Objekt oder null): Benutzerdefinierte, nicht sicher signierte Daten.

• in_queue_wait_time_va (Array; nur vorhanden, wenn Sie die Verfolgung der Wartezeit in der Warteschlange für virtuelle Agenten in Ihrem Konto aktivieren und nur, wenn mindestens eine Eskalation für einen reservierten virtuellen Agenten aufgetreten ist): Zeitintervalle, in denen der Kunde in der Warteschlange gewartet hat, während die CCAI Platform nach der Eskalation einen virtuellen Agenten für ihn reserviert hat. Jeder Eintrag enthält Folgendes:

  • start (String, Datum/Uhrzeit): Zeitpunkt, zu dem die Wartezeit in der Warteschlange begonnen hat.

  • end (String, Datum/Uhrzeit oder Null): Wann die Wartezeit in der Warteschlange endete; Null, wenn sie nicht abgeschlossen wurde.

  • duration (Ganzzahl oder null): Wartezeit in Sekunden; null, wenn end null ist.

• auto_session_summaries (Array; nur vorhanden, wenn Sie die Zusammenfassung von Unterhaltungen in Ihrem Konto aktivieren und die CCAI Platform erfolgreich eine Zusammenfassung generiert hat): KI-generierte Zusammenfassungen von Sitzungen, die von der CCAI Platform im CRM-Datensatz gespeichert werden. Jeder Eintrag enthält:

  • user_id (Ganzzahl): Kennung des KI-Agenten, mit dem die Zusammenfassung verknüpft ist.

  • participant_id (Ganzzahl): Teilnehmer-ID.

  • session_summary (String): Der Zusammenfassungstext.

  • session_summary_sections (Array oder Objekt): Die Zusammenfassung in strukturierten Abschnitten, falls verfügbar.

• sip_headers (Objekt; nur vorhanden, wenn Sie die Erfassung von SIP-Headern in Ihrem Konto aktivieren und für die Aufnahme in Sitzungsmetadaten konfigurieren): Eingehende SIP-Header, die von der CCAI Platform für den Anruf erfasst wurden. Schlüssel und Werte spiegeln die SIP-Header wider, die vom Upstream-Telefonieanbieter empfangen wurden.

Definitionen

In diesem Abschnitt wird jedes Unterschema einmal definiert. Attributgruppen, die auf die Unterschemas verweisen, verlinken auf diese Definitionen, anstatt ihre Formen inline neu zu definieren.

menu_path (Objekt)

Beschreibt einen hierarchischen Menüpfad, den der Anruf durchlaufen hat. Eine vollständige Liste der Felder finden Sie unter Menünavigation.

Referenziert von: das Feld menu_path auf oberster Ebene; jedes transfers[].from_menu_path und transfers[].to_menu_path; jedes escalations[].from_menu_path und escalations[].to_menu_path; jedes deflection_details[].from_menu_path und deflection_details[].to_menu_path.

Agent (Objekt)

Beschreibt einen menschlichen Kundenservicemitarbeiter. Dieses Objekt ist eine der beiden Varianten des Discriminators agent_info auf oberster Ebene (siehe Schemastamm). Eine vollständige Liste der Felder finden Sie unter Informationen zu Agenten und virtuellen Agenten.

Referenziert aus: dem Feld agent_info, wenn ein menschlicher Kundenservicemitarbeiter den Anruf zuletzt bearbeitet hat; jedem transfers[].from_agent und transfers[].to_agent; jedem escalations[].to_agent.

virtual_agent (Objekt)

Beschreibt einen virtuellen Agenten. Dieses Objekt ist eine der beiden Varianten des Discriminators agent_info auf oberster Ebene (siehe Schema-Root). Eine vollständige Liste der Felder finden Sie unter Informationen zu Agenten und virtuellen Agenten.

Referenziert von: das Feld agent_info, wenn ein virtueller Agent den Anruf zuletzt bearbeitet hat; jedes transfers[].from_virtual_agent und transfers[].to_virtual_agent; jedes escalations[].from_virtual_agent; jedes virtual_agent_handle_durations[].virtual_agent; jedes virtual_agent_deflected_escalations[].virtual_agent.

deflection (String, Enum)

Der Umleitungsstatus eines Anrufs oder Anrufsegments. Die Werte folgen dem Benennungsmuster <trigger>_<destination>, wobei das Präfix die Bedingung identifiziert, die die Umleitung ausgelöst hat (z. B. Überkapazität, außerhalb der Geschäftszeiten oder vorübergehende Umleitung), und das Suffix das Ziel oder die Behandlung identifiziert (z. B. Voicemail, Warteschlange, Telefon oder Nachricht).

Häufige Suffixe für Ziel-URLs:

• _phone: Der Anruf wird an eine externe Telefonnummer weitergeleitet.

• _voicemail: Der Anruf wird an die Mailbox weitergeleitet.

• _message – Spielt eine Informationsnachricht ab.

• _message_only: Spielt eine Nachricht ab und beendet den Anruf ohne weitere Weiterleitung.

• _callback: Bietet einen geplanten Rückruf an.

• _wait: Der Anrufer wird in die Warteschleife gesetzt.

• _queue: Der Anruf wird in eine andere Warteschlange gestellt.

• _sip: Leitet den Anruf an ein SIP-Ziel weiter.

• _extension: Leitet den Anruf an eine Durchwahl weiter.

• _phone_with_extension: Leitet den Anruf an ein Telefonziel mit einer Durchwahl weiter.

Zulässige Werte, gruppiert nach Triggerfamilie:

• Keine Ablenkung: no_deflection, deflecting.

• Überkapazität – wenn die Warteschlange ihren Kapazitätsschwellenwert überschritten hat: over_cap_phone, over_cap_voicemail, over_cap_callback, over_cap_wait, over_cap_queue, over_cap_message, over_cap_ewt_only, over_cap_sip, over_cap_extension, over_cap_phone_with_extension.

• Abgebrochene Weiterleitung – wenn eine Weiterleitung oder ein Anruf beendet wurde, bevor die ausstehende Weiterleitung abgeschlossen wurde: deflection_abandoned.

• Außerhalb der Geschäftszeiten – wenn der Anruf außerhalb der für das Menü konfigurierten Öffnungszeiten eingegangen ist: after_hours_voicemail, after_hours_phone, after_hours_message_only, after_hours_queue, after_hours_message, after_hours_sip, after_hours_extension, after_hours_phone_with_extension.

• Temporäre Weiterleitung: Wenn Sie eine temporäre Weiterleitung im Menü konfigurieren: temp_redirection_phone, temp_redirection_message, temp_redirection_voicemail, temp_redirection_queue, temp_redirection_sip, temp_redirection_extension, temp_redirection_phone_with_extension.

• IVR-Vorsitzung: ivr_presession_deflection.

• Von einem virtuellen Kundenservicemitarbeiter initiiert – wenn ein virtueller Kundenservicemitarbeiter den Anruf weitergeleitet oder übergeben hat: va_redirection_phone, va_redirection_sip, va_third_party_phone, va_third_party_sip.

• Interner Anruf außerhalb der Geschäftszeiten: internal_call_after_hours_message, internal_call_after_hours_queue, internal_call_after_hours_phone, internal_call_after_hours_extension, internal_call_after_hours_sip, internal_call_after_hours_voicemail.

• Überkapazität bei internen Aufrufen: internal_call_over_capacity_message, internal_call_over_capacity_queue, internal_call_over_capacity_phone, internal_call_over_capacity_extension, internal_call_over_capacity_sip, internal_call_over_capacity_voicemail, internal_call_over_capacity_wait.

• Automatische Weiterleitung interner Aufrufe: internal_call_automatic_redirection_message, internal_call_automatic_redirection_queue, internal_call_automatic_redirection_phone, internal_call_automatic_redirection_extension, internal_call_automatic_redirection_sip, internal_call_automatic_redirection_voicemail.

• Anrufweiterleitung außerhalb der Geschäftszeiten: call_transfer_after_hours_message, call_transfer_after_hours_queue, call_transfer_after_hours_phone, call_transfer_after_hours_extension, call_transfer_after_hours_sip, call_transfer_after_hours_voicemail.

• Überkapazität bei der Anrufweiterleitung: call_transfer_over_capacity_message, call_transfer_over_capacity_queue, call_transfer_over_capacity_phone, call_transfer_over_capacity_extension, call_transfer_over_capacity_sip, call_transfer_over_capacity_voicemail, call_transfer_over_capacity_wait.

• Automatische Weiterleitung bei Anrufweiterleitung: call_transfer_automatic_redirection_message, call_transfer_automatic_redirection_queue, call_transfer_automatic_redirection_phone, call_transfer_automatic_redirection_extension, call_transfer_automatic_redirection_sip, call_transfer_automatic_redirection_voicemail.

• Notabschaltung – wenn ein Administrator eine Notabschaltung ausgelöst hat: emergency_shutdown, emergency_shutdown_message, emergency_shutdown_after_hours, emergency_shutdown_over_capacity.

• Dynamisches Anrufrouting (DCR): dcr_transferred, dcr_missed, dcr_redirected, dcr_finished.

Referenziert von: jedem deflection_details[].deflection, das dieses Vokabular vollständig verwendet. Zwei weitere Felder greifen jeweils auf eine Teilmenge davon zu:

• Das Feld deflection auf oberster Ebene verwendet alle Werte außer over_cap_ewt_only und temp_redirection_url.

• Jeder transfers[].deflection verwendet eine kleinere Teilmenge, die auf die Übertragung beschränkt ist: no_deflection, deflecting, deflection_abandoned, die zehn over_cap_*-Werte, die acht after_hours_*-Werte, die sieben temp_redirection_*-Werte außer temp_redirection_url, ivr_presession_deflection, va_redirection_phone und va_redirection_sip. Die Familien internal_call_*, call_transfer_*, emergency_shutdown_*, dcr_* und va_third_party_* werden bei einer Übertragung nie angezeigt.

Versionsverwaltung und Einstellungen

Das Metadatenschema für Anrufsitzungen unterstützt die abwärtskompatible Weiterentwicklung. Die CCAI Platform kann jederzeit neue Felder und Arrays hinzufügen. Integrationen sollten nicht erkannte Schlüssel ignorieren, um die Funktionalität aufrechtzuerhalten. Die Felder in diesem Abschnitt sind veraltet, veraltet oder teilweise ersetzt. Sie bleiben aus Gründen der Abwärtskompatibilität in der Nutzlast, aber neue Integrationen müssen den Anleitungen für jedes Feld folgen.

Verworfene Felder

• voip_provider (String) – Eingestellt. Gibt immer den String „deprecated“ zurück. Die CCAI Platform stellt Integrationen über dieses Dokument keine Anbieterinformationen mehr zur Verfügung. Es gibt kein Ersatzfeld. Wenn Ihre Integration den vorgelagerten Telefonieanbieter identifizieren muss, wenden Sie sich an Ihr Account-Management-Team.

Legacy-Duplikate

• session_type (String) – Legacy-Alias von call_type. Gibt immer denselben Wert wie call_type zurück und verwendet dasselbe Legacy-Enum-Vokabular. Die CCAI Platform behält dieses Feld aus Gründen der Abwärtskompatibilität mit Integrationen bei, die auf session_type basieren. Neue Integrationen sollten call_type direkt parsen oder für detailliertere eingehende Unterscheidungen session_type_v2 (siehe Vokabularentwicklung unten).

Entwicklung des Vokabulars

call_type und session_type_v2 beschreiben denselben zugrunde liegenden Aufruftyp mit zwei verschiedenen Vokabularen. Die CCAI Platform gibt beide Felder für jeden Datensatz aus. Sie sind keine Duplikate voneinander:

• call_type verwendet das alte Enum-Vokabular. Werte wie Voice Inbound (App) und Voice Inbound (IVR via App) decken alle eingehenden mobilen und In-App-SDK-Ursprünge unter einem einzigen Label ab. call_type wurde nicht eingestellt. Die CCAI Platform gibt dieses Feld weiterhin aus, aber das Vokabular wird nicht um neue detaillierte Werte erweitert.

• session_type_v2 verwendet das aktuelle Enum-Vokabular. Es werden detailliertere eingehende Unterscheidungen eingeführt, z. B. Voice Inbound (Mobile) und Voice Inbound (IVR via Mobile), für die Aufruftypen, die v2-spezifische Werte haben. Für Aufruftypen, die keinen v2-spezifischen Wert haben, gibt session_type_v2 denselben String wie call_type zurück.

Neue Integrationen sollten session_type_v2 parsen. Die Werte für die einzelnen Felder sind unter Wichtige Informationen aufgeführt.

Nomenklatur für Wartezeitfelder

Im Dokument mit den Sitzungsmetadaten der Anrufsitzung wird die Wartezeit in der Warteschlange in zwei Bereichen unter zwei Feldnamen angegeben:

• Anrufsumme: Das Feld wait_duration auf oberster Ebene enthält die Gesamtzeit, die der Kunde während des gesamten Anrufs in der Warteschlange verbracht hat.

• Pro Segment: Jeder Eintrag im queue_durations-Array auf oberster Ebene (Warteschlangendauer) hat ein eigenes queue_duration-Feld, das die Warteschlangenzeit für dieses einzelne Warteschlangensegment enthält.

Beide Namen beziehen sich auf dieselbe Art von Messung – die in der Warteschlange verbrachte Zeit – in verschiedenen Bereichen. Der Gesamtwert für den Anruf wait_duration spiegelt die gesamte Wartezeit des Nutzers wider, während die Werte pro Segment queue_duration die einzelnen Warteschlangensegmente beschreiben. In diesem Dokument wird kein separates queue_duration-Feld auf oberster Ebene ausgegeben. Segmentbezogene Werte sind nur innerhalb von queue_durations verfügbar.