Metadaten des Chattranskripts

In diesem Dokument wird das JSON-Schema erläutert, das zum Strukturieren von Metadaten für Chat-Transkripte verwendet wird. Dieses Schema ist erforderlich, um Chatunterhaltungen genau darzustellen und zu verarbeiten.

Metadatenschema für Chattranskripte

Dieses Schema beschreibt die Datenstruktur von Chat-Transkripten. Die Kernkomponenten werden in den folgenden Abschnitten beschrieben:

Wichtige Informationen zum Transkript

Die folgenden Eigenschaften enthalten die grundlegenden Informationen zum Transkript selbst:

• comm_type (String). Die Art der Kommunikation, zu der dieses Transkript gehört. Es kann sich um einen Chat oder einen Anruf handeln, wenn die SMS-Funktion verwendet wird.

• comm_id (Ganzzahl). Eine Kennung für die Kommunikation, z. B. den Chat oder Anruf, auf den sich dieses Transkript bezieht.

• transcript_version (String). Die Version des Transkriptformats. Dies ist für die Abwärtskompatibilität beim Parsen von Transkripten erforderlich.

• assigned_at (String, Datum/Uhrzeit). Der Zeitstempel für die Zuweisung des Chats.

• timezone (String). Die Zeitzone, in der der Chat stattgefunden hat.

Nachrichtendefinitionen

Der Abschnitt definitions enthält wiederverwendbare Schemakomponenten, die die Struktur verschiedener Nachrichtentypen im Transkript definieren. So können Sie verschiedene Inhaltsformate flexibel verarbeiten:

• text (Objekt): stellt eine SMS dar

  • type (String): muss „text“ sein

  • content (String): Der tatsächliche Textinhalt der Nachricht

  • lang (String): Die Sprache des Textinhalts.

• text_template (Objekt): Stellt eine SMS mit Vorlage dar.

  • type (String): muss text_template sein

  • content (String): Der Inhalt der Textvorlage, der möglicherweise Platzhalter enthält.

• markdown (Objekt): Stellt eine Nachricht mit Markdown-Formatierung dar.

  • type (String): muss Markdown sein

  • content (String): Der Inhalt der Markdown-Vorlage.

• markdown_template (Objekt): Stellt eine Markdown-Nachricht mit Vorlage dar.

  • type (String): muss markdown_template sein.

  • content (String): Der Inhalt der Markdown-Vorlage, möglicherweise mit Platzhaltern

• photo (Objekt): Stellt eine Nachricht mit einem Foto dar.

  • type (String): muss photo sein

  • media_id (Ganzzahl): Die ID der Mediendatei für das Foto.

• video (Objekt): Stellt eine Nachricht mit einem Video dar.

  • title (String): Titel des Videos

  • video (Objekt): Details zum Video

    • url (String): URL des Videos

    • text (String): Textalternative zur Video-URL

  • media_id (Ganzzahl): Media-ID zum Abrufen der Video-URL, falls nicht direkt angegeben

• image (Objekt): Stellt eine Nachricht mit einem Bild dar.

  • title (String): Titel des Bildes

  • image (object): Details zum Bild

    • url (String): URL des Bildes

    • text (String): Textalternative zur Bild-URL

• document (Objekt): Stellt eine Nachricht mit einem Dokument dar.

  • title (String): Titel des Dokuments

  • document (Objekt): Details zum Dokument

    • url (string): URL des Dokuments.

    • text (String): Textalternative zur Dokument-URL

• inline_button (Objekt): Stellt eine Gruppe von Inline-Schaltflächen dar.

  • title (String): Titel der Inline-Schaltflächengruppe

  • buttons (Array): Array von Schaltflächenobjekten

    • title (String): Titel der Schaltfläche

    • action (String): Name der Aktion, die durch die Schaltfläche angegeben wird

    • link (String): URL-Link für Links in Schnellantworten

• sticky_button (Objekt): Stellt eine Gruppe von fixierten Schaltflächen dar.

  • title (String): Titel des Sets mit fixierten Schaltflächen

  • buttons (Array): Array von Schaltflächenobjekten

    • title (String): Titel der Schaltfläche

    • action (String): Name der Aktion, die durch die Schaltfläche angegeben wird

    • link (String): URL-Link für Links in Schnellantworten

• content_card (Objekt): Stellt eine Inhaltskarte dar.

  • cards (Array): Array von Inhaltskartenobjekten

    • title (String): Titel der Inhaltskarte

    • body (String): Textkörper der Inhaltskarte

• server_message (Objekt): Stellt eine vom Server abgerufene Nachricht dar.

  • message_id (Ganzzahl): ID der gespeicherten Servernachricht

  • content (String): Inhalt der vom Server abgerufenen Nachricht

• action (Objekt): Stellt eine Aktion dar, die während des Chats ausgeführt wurde. Mögliche Werte:

  • action_escalation (Objekt): Stellt eine Eskalierungsaktion dar.

    • action (String): muss „escalation“ sein

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

    • menu_id (Ganzzahl): die ID, an die die Kommunikation eskaliert werden soll

    • language (String): ISO 689-Sprachcode der Warteschlange, an die eskaliert werden soll

  • action_deflection (Objekt): steht für eine Ablenkungsaktion

    • action (String): muss deflection sein

    • deflection_type (String): Der Typ der Ablenkung

    • sip_parameters (Objekt oder Null): SIP-Parameter, die im Rahmen der Umleitung weitergeleitet werden sollen, falls vorhanden

  • action_end (Objekt): stellt eine Endaktion dar.

    • action (String): muss end sein

• noti (Objekt): Stellt eine Benachrichtigungsnachricht dar. Es kann sich um einen von verschiedenen Benachrichtigungstypen handeln:

  • noti_transfer_started (Objekt): Benachrichtigung über den Beginn einer Übertragung.

    • type (String): muss noti sein

    • event (String): muss „transferStarted“ sein

    • target (String): Das Ziel der Übertragung, z. B. ein Menü oder ein Agent.

    • agent (Objekt): Der Agent, der die Übertragung gestartet hat.

      • id (Ganzzahl): ID des Agenten

      • email (String): E‑Mail-Adresse des Kundenservicemitarbeiters

      • name (String): Name des Agenten

  • noti_verification_requested (Objekt): Benachrichtigung für einen Überprüfungsantrag

  • type (String): muss noti sein

  • event (String): muss verificationRequested sein

  • agent (object): der Agent, der die Überprüfung anfordert

    • id (Ganzzahl): ID des Agenten, der die Bestätigung anfordert

    • email (String): E‑Mail-Adresse des Kundenservicemitarbeiters, der die Bestätigung anfordert

    • name (String): Name des Agents, der die Überprüfung beantragt

  • noti_end_user_verified (Objekt): Benachrichtigung, wenn ein Endnutzer bestätigt wird

    • type (String): muss noti sein

    • event (String): muss endUserVerified sein

  • Andere noti_\*-Typen definieren Benachrichtigungen für verschiedene Ereignisse wie Fotoanfragen, Videoanfragen, Ereignisse für die gemeinsame Nutzung, Ereignisse für den virtuellen Kundenservicemitarbeiter, das Hinzukommen eines Kundenservicemitarbeiters sowie Statusänderungen bei Übertragungen oder Eskalierungen.

  • noti_custom (Objekt): Stellt eine benutzerdefinierte Benachrichtigung dar.

    • type (String): muss noti sein

    • event (String): muss custom sein

    • detail (Objekt): Details zum benutzerdefinierten Ereignis

    • key (String): Schlüssel, der das benutzerdefinierte Ereignisdetail darstellt

    • data (Objekt): benutzerdefinierte Ereignisnutzlast

Transkripteinträge

• entries (Array): Ein Array von Objekten, wobei jedes Objekt eine einzelne im Chat gesendete Nachricht darstellt.

  • timestamp (String): Der Zeitstempel für den Versand der Nachricht

  • type (String): Der Typ der Meldung, der auf eine der zuvor beschriebenen Definitionen verweist, z. B. text, photo, noti.

  • body (Objekt): Der Inhalt der Nachricht, der der Struktur des Nachrichtentyps entspricht. Dank oneOf können unterschiedliche Körpertypen berücksichtigt werden.

  • role (String): Die Rolle des Teilnehmers, der die Nachricht gesendet hat. Mögliche Werte sind end_user, agent, manager, virtual_agent, external_agent, task_virtual_agent, system.

  • user_data (object): Daten für den Nutzer, der die Nachricht gesendet hat, sofern es sich nicht um eine Endnutzer- oder Systemnachricht handelt.

    • name (String): Der Name des Nutzers.

    • id (Ganzzahl): Die eindeutige ID des Nutzers

  • avatar_url (String): Speicher-URL für den Avatar des Nutzers