Artikelvorlage

Informationen zum XM Discover Link Inbound Connector

Sie können den XM Discover Link Inbound Connector verwenden, um XM über einen REST an XM Discover zu senden und dabei alle vom Connectors-Framework angebotenen Funktionen wie Feldzuordnung, Transformationen, Filter, Jobüberwachung usw. zu nutzen.

Unterstützte Datenformate

Die folgenden Datentypen werden in unterstützt: Nur JSON:

• Individuelles Feedback
• Digitale Interaktionen
• Protokolle aufrufen

Erstellen Sie vor dem Einrichten des Connectors eine Stichprobe, die die Felder darstellt, die Sie in XM Discover importieren möchten. Weitere Informationen zu den erforderlichen Feldern und Dateiformaten finden Sie auf den verlinkten Seiten oben.

Es stehen auch Vorlagendateien zum Herunterladen im Konnektor für bestimmte Datenformate zur Verfügung:

• Chat
  • Chat (Standard): Für standardmäßige digitale Interaktionsdaten verwenden.
  • Amazon Connect: Verwenden Sie diese Option für digitale Interaktionen, die für Amazon Connect Chat spezifisch sind.
• Anruf
  • Aufruf (Standard): Für Standardanrufprotokollierungsdaten verwenden.
  • Verint: Verwenden Sie für Verint spezifische Anrufprotokolle.
• Feedback
  • Dynamics 365: Für Microsoft Dynamics-Daten verwenden.

Anlegen eines XM Discover

1. Klicken Sie auf der Registerkarte Jobs auf Neuer Job.
   
2. Klicken Sie auf das Symbol XM Discover Job.
   
3. Geben Sie Ihrem Job einen Namen, damit Sie ihn identifizieren können.
   
4. Wählen Sie das Projekt aus, in das die Daten geladen werden sollen.
5. Geben Sie Ihrer Stelle eine Beschreibung, damit Sie ihren Zweck kennen.
6. Klicken Sie auf Weiter.
7. Wählen Sie Ihren Berechtigungsmodus oder die Art und Weise, wie Sie eine Verbindung zu XM Discover herstellen möchten:
   
   • API: Verbinden über eine XM Discover .
   • OAuth 2.0: Stellen Sie eine Verbindung über eine Client-ID und einen geheimen Client-Schlüssel her, die vom XM Discover bereitgestellt werden. Kontakt Ihren XM Success Manager:in um diese Methode anzufordern.
8. Klicken Sie auf Weiter.
9. Wählen Sie Ihr Datenformat: Chat (digital), Anruf oder Feedback.
   
10. Wählen Sie bei Bedarf eine Vorlage aus, und klicken Sie dann auf die hier Link zum Herunterladen der Vorlagendatei.
11. Geben Sie Folgendes ein: JSON zu einer Teilmenge von JSON, die Dokumentknoten enthält. Lassen Sie dieses Feld leer, wenn sich die Dokumente auf Ebene befinden.
12. Klicken Sie auf das Symbol Klicken, um Datei für Upload auszuwählen und wählen Sie die Stichprobe auf Ihrem Computer aus.
13. Eine Vorschau der Datei wird angezeigt. Wenn Sie anstelle der Vorschau eine Fehlermeldung oder einen Rohdateiinhalt sehen, kann es zu einem Problem mit den von Ihnen ausgewählten Datenformatoptionen kommen. Siehe Stichprobe für Hilfe bei der Fehlerbehebung in Ihrer Datei.
14. Klicken Sie auf Weiter.
15. Passen Sie bei Bedarf Ihre Datenzuordnungen. Siehe Supportseite für die Datenzuordnung für detaillierte Informationen zu Zuordnungsfeldern in XM Discover. Die Standarddatenzuordnung enthält spezifische Anleitungen für diesen Konnektor.
    
16. Klicken Sie auf Weiter.
17. Bei Bedarf können Sie Folgendes hinzufügen: Regeln für Datensubstitution und Unkenntlichmachung um sensible Daten auszublenden oder bestimmte Wörter und Phrasen in Feedback und -interaktionen automatisch zu ersetzen. Siehe Supportseite für Datenersetzung und Redaktion für weitere Informationen.
    
18. Klicken Sie auf Weiter.
19. Bei Bedarf können Sie eine Konnektorfilter um die eingehenden Daten zu filtern, um einzuschränken, welche Daten importiert werden.
    
20. Klicken Sie auf Weiter.
21. Legen Sie fest, wie duplizieren Belege behandelt werden. Siehe Handhabung Duplizieren für weitere Informationen.
    
22. Klicken Sie auf Weiter.
23. Überprüfen Sie Ihre Einrichtung. Wenn Sie eine bestimmte Einstellung ändern müssen, klicken Sie auf das Symbol Bearbeiten Drucktaste, die zu diesem Schritt in der Verbindungseinrichtung weitergeleitet werden soll.
    
24. Die API enthält Ihren API, der zum Senden von Daten an XM Discover verwendet wird. Siehe Zugriff auf den API für weitere Informationen.
25. Klicken Sie auf Fertigstellen , um Ihre Einrichtung zu sichern.

Standarddatenzuordnung

Dieser Abschnitt enthält Informationen zu den Standardfeldern für XM Discover”.

Beim Zuordnen Ihrer Felder sind die folgenden Standardfelder verfügbar:

• feedback_type: Mithilfe des Feedback können Sie Daten anhand ihres Typs identifizieren. Dies ist nützlich für das Reporting, wenn Ihr Projekt verschiedene Arten von Daten enthält (z.B. Umfragen und Feedback). Dieses Feld kann bearbeitet werden. Standardmäßig ist der Wert dieses Attribut auf Folgendes gesetzt:
  • “call” für Anrufprotokolle
  • „Chat“ für digitale Interaktionen
  • “Feedback” für individuelles Feedback
  • Sie können Folgendes verwenden: benutzerdefinierte Transformationen um einen benutzerdefinierten Wert festzulegen.
• Quelle: Mit der Quelle können Sie Daten identifizieren, die aus einer bestimmten Quelle abgerufen wurden. Dabei kann es sich um alles handeln, was die Herkunft der Daten beschreibt, z.B. der Name einer Umfrage oder einer mobilen Marketingkampagne. Dieses Feld kann bearbeitet werden. Standardmäßig ist der Wert dieses Attribut auf „XM Discover Link“ gesetzt. Sie können eine benutzerdefinierte Transformation verwenden, um einen benutzerdefinierten Wert festzulegen.
• richVerbatim: Dieses Feld wird für dialogorientierte Daten (z.B. Anruf- und Chat-Protokolle) verwendet und kann nicht bearbeitet werden. XM Discover verwendet ein dialogorientiertes ausführliches Format für das richVerbatim-Feld. Dieses Format unterstützt die Aufnahme dialogspezifischer Metadaten, die zum Entsperren dialogorientierter Visualisierung (Sprecherwechsel, Stille, dialogorientierte Ereignisse usw.) und Anreicherungen (Startzeit, Dauer usw.) erforderlich sind. Dieses ausführliche Feld enthält „untergeordnete“ Felder, um die Seite des Kunden und des Vertreters des Gesprächs zu verfolgen:
  • clientVerbatim verfolgt die Seite des Kunden im Gespräch.
  • agentVerbatim verfolgt die Seite des Repräsentanten (des Agenten) des Gesprächs.
  • unbekannt verfolgt die unbekannte Seite des Gesprächs.
• Tipp: Transformationen werden für dialogbezogene ausführliche Felder nicht unterstützt. Dasselbe Wort kann nicht für verschiedene Arten von dialogorientierten Daten verwendet werden. Wenn Sie möchten, dass Ihr Projekt mehrere Arten von Konversationen hostet, verwenden Sie separate Paare von Gesprächsverben pro Konversationstyp.
• clientVerbatim: Dieses Feld wird für dialogorientierte Daten verwendet und kann bearbeitet werden. Dieses Feld verfolgt die Seite des Kunden des Gesprächs in Anruf- und Chat-Interaktionen. Dieses Feld ist standardmäßig Folgendem zugeordnet:
  • clientVerbatimChat für digitale Interaktionen.
  • clientVerbatimCall für Anrufinteraktionen.
• agentVerbatim: Dieses Feld wird für dialogorientierte Daten verwendet und kann bearbeitet werden. Dieses Feld verfolgt die Seite des Vertreters des Gesprächs in Anruf- und Chat-Interaktionen. Dieses Feld ist standardmäßig Folgendem zugeordnet:
  • agentVerbatimChat für digitale Interaktionen.
  • agentVerbatimCall für Anrufinteraktionen.
• unbekannt: Dieses Feld wird für dialogorientierte Daten verwendet und kann bearbeitet werden. Dieses Feld verfolgt die unbekannte Seite der Konversation in Anruf- und Chat-Interaktionen. Standardmäßig ist dieses Feld Folgendem zugeordnet:
  • unknown wnVerbatimChat für digitale Interaktionen.
  • unknown wnVerbatimCall für Anrufinteraktionen.
• document_date: Das Belegdatum ist das primäre Datumsfeld, das mit einem Dokument verknüpft ist. Dieses Datum wird in XM Discover, Trends, Warnungen usw. verwendet. Wählen Sie für das Belegdatum eine der folgenden Optionen:
  • ConversationTimestamp (für dialogorientierte Daten): Datum und Uhrzeit für das gesamte Gespräch.
  • Wenn Quelldaten andere Datumsfelder enthalten, können Sie eines davon als Belegdatum festlegen, indem Sie es aus dem Dropdown-Menü im Feldname.
  • Sie können auch ein bestimmtes Datum festlegen indem Sie ein benutzerdefiniertes Feld hinzufügen.
• natural_id: Natürliche ID dient als eindeutige ID eines Dokuments und ermöglicht die korrekte Verarbeitung von Duplikaten. Wählen Sie für die natürliche ID eine der folgenden Optionen:
  • ConversationId (für dialogorientierte Daten): Eine eindeutige ID für die gesamte Unterhaltung.
  • Wählen Sie ein beliebiges Text- oder numerisches Feld aus Ihren Daten im Feldname.
  • IDs automatisch generieren indem Sie ein benutzerdefiniertes Feld hinzufügen.
• feedback_provider: Feedback hilft Ihnen dabei, die von einem bestimmten Anbieter erhaltenen Daten zu identifizieren. Für XM Discover ist der Wert dieses Attribut auf „XM Discover Link“ gesetzt und kann nicht bearbeitet werden.
• Jobname: Der Jobname hilft Ihnen dabei, Daten anhand des Namens des Jobs zu identifizieren, der zum Hochladen verwendet wurde. Sie können den Wert dieses Attribut in der Jobname oben auf der Seite oder über das Feld Menü „Joboptionen“.
• loadDate: Ladedatum gibt an, wann ein Dokument in XM Discover hochgeladen wurde. Dieses Feld wird automatisch gesetzt und kann nicht bearbeitet werden.

Zusätzlich zu den oben genannten Feldern können Sie auch alle benutzerdefinierten Felder zuordnen, die Sie importieren möchten. Siehe Supportseite für die Datenzuordnung für weitere Informationen zu benutzerdefinierten Feldern.

Zugriff auf den API

Der API wird verwendet, um Daten in XM Discover hochzuladen, indem die Daten über eine REST im JSON gesendet werden.

Sie können über die Seite Jobs auf den Endpunkt zugreifen:

1. Auswählen Zusammenfassung im Menü „Joboptionen“ für Ihren Job.
   
2. Klicken Sie auf das Symbol API Link.
   
3. Klicken Sie auf das Symbol Drucken Schaltfläche, um alle Informationen in diesem Fenster als druckbare PDF herunterzuladen.
   
4. Ihre Endpunktinformationen umfasst:
   • API : Die URL, die für die API verwendet wird.
   • Methode: Verwenden Sie die POST Methode zum Laden von Daten in XM Discover.
   • Job-ID: Die ID des aktuell ausgewählten Jobs.
5. Eine JSON ist in der Anforderungstext Abschnitt. Eine API sollte nur ein Dokument enthalten und nur die Felder in der Beispiel-Payload enthalten.
6. Die Antworten Im Abschnitt werden die möglichen Erfolgs- und Antworten der API aufgeführt.
   
7. Die Schema zeigt das Datenschema an. Erforderliche Felder befinden sich in der erforderlich Array.

Überwachen eines XM Discover über API

Sie können den Status von XM Discover Link-Jobs überwachen, ohne sich bei XM Discover den API aufrufen. Auf diese Weise können Sie den neuesten Jobausführungsstatus, Metriken für einen bestimmten Joblauf oder akkumulierte Metriken für einen bestimmten Zeitraum abrufen.

Informationen zum Statusendpunkt

Um den Statusendpunkt aufzurufen, benötigen Sie Folgendes:

• API : https://na-data.clarabridge.net/v1/public/job/status/?apiKey=<jobID><apiKey>
  • <jobId> ist die ID des XM Discover, den Sie überwachen möchten.
  • <apiKey> ist das API-Token.
• Typ: Verwenden Sie die REST
• HTTP-Methode: Verwenden Sie die GET-Methode, um Daten abzurufen.

Eingabeelemente

Die folgenden optionalen Eingabeelemente können verwendet werden, um zusätzliche Metriken zu Ihrem Job abzurufen:

• historicalRunId: Die ID der spezifischen Upload-Sitzung. Wenn dieses Element ausgelassen wird und kein Datumsbereich angegeben ist, gibt der API den Status der letzten Jobausführung zurück. Wenn dieses Element ausgelassen und ein Datumsbereich angegeben wird, gibt der API kumulierte Metriken für den angegebenen Zeitraum zurück.
• startDate: Definieren Sie das Startdatum, ab dem Daten zurückgegeben werden sollen.
• Enddatum: Definieren Sie das Enddatum, um Daten basierend auf dem letzten Upload zurückzugeben. Wenn dieses Element ausgelassen und startDate angegeben wird, wird endDate automatisch auf das aktuelle Datum gesetzt.

Ausgabeelemente

Die folgenden Ausgabeelemente werden zurückgegeben, sofern Sie die erforderlichen Eingabeelemente eingegeben haben:

• job_status: Die Stelle Status.
• job_failure_reason: Wenn der Job fehlgeschlagen ist, der Grund für den Fehler.
• run_metrics: Informationen zu den Dokumenten, die vom Job verarbeitet werden. Folgende Metriken sind enthalten:
  • SUCCESSFULLY_CREATED: Die Anzahl der erfolgreich angelegten Dokumente.
  • ERFOLGREICH AKTUALISIERT: Die Anzahl der erfolgreich aktualisierten Dokumente.
  • SKIPPED_AS_DUPLICATES: Die Anzahl der Belege, die als Duplikate übersprungen wurden.
  • FILTERED_OUT: Die Anzahl der Dokumente, die entweder durch einen quellspezifischen Filter oder einen Konnektorfilter herausgefiltert wurden.
  • BAD_RECORD: Die Anzahl der digitalen Interaktionen, die zur Verarbeitung übermittelt wurden und nicht mit dem Qualtrics übereinstimmen.
  • SKIPPED_NO_ACTION: Die Anzahl der Belege, die als Nicht-Duplikate übersprungen wurden.
  • FAILED_TO_LOAD: Die Anzahl der Dokumente, die nicht geladen werden konnten.
  • INSGESAMT: Die Gesamtzahl der Dokumente, die während der Ausführung dieses Jobs verarbeitet wurden.

Fehlermeldungen

Die folgende Fehlermeldung ist für die API möglich:

• 401 Nicht berechtigt: Authentifizierung fehlgeschlagen. Verwenden Sie einen anderen API.
• 404 Nicht gefunden: Es ist kein Job mit der angegebenen ID vorhanden. Verwenden Sie eine andere Job-ID.

Stichprobe

Im Folgenden finden Sie eine Beispielanforderung zum Abrufen des Status für einen Job:

curl --location --request GET 'https://na-data.clarabridge.net/v1/public/job/status/62da736987c9788b830918e0?apiKey=02e7a0e26b592632dd50f623e974fff6'

Stichprobe

Im Folgenden finden Sie eine Stichprobe eines fehlgeschlagenen Auftrags:
{
"job_status": "Failed",
"job_failure_reason": "{\"problem\":[{\"requestId":"RQ-MOB-f339aa58-71b6-4a1d-a67c-12b8d3439321","severity":"ERROR","description":"Längenbeschränkung von 900 Zeichen für Attribut supportexperienceresp wurde überschritten, Länge ist 1043\"}],\"status\":\"ERROR\"}",
"run_metrics": {
"Successfully_created": 10,
"failed_to_load": 1,
"Gesamt": 11
}
}


Payload-Beispiele

Dieser Abschnitt enthält 1 JSON für jeden unterstützten Typ strukturierter Daten (Feedback, Chat, Anruf).

Klicken Sie hier, um die Feedback anzuzeigen.

curl --location --request POST 'https://na-data.clarabridge.net/v1/cb_link?apiKey=887fc11663c456f9f34844a8a8bdff64&jobId=5f4e583f9142ae48a1090a76' \
--header 'Content-Type: application/json ' \
--data-raw '{
"dataSource": "JSON ",
"Row_ID": "id43682",
"store_number": "226,1,1,0,0",
"Adresse": "5916 W Loop 289 Lubbock, TX 79424",
"phone_number": "806-791-4384",
"reviewer_name": "Mariposa",
"review_rating": 2,
"Review_Date": "03.03.2019",
„Employee_Knowledge“: 2,
"Price_value": 3,
"Checkout_process": 1,
"comments": "Eine der besten Erfahrungen, die ich bei Best Buy seit langem gemacht habe. Bleiben Sie bei der guten Arbeit.",
"LTR": 10,
"state": "TX",
"Rewards_Member": "Meine BestBuy"
}'

Klicken Sie hier, um die Chat-Beispiel-Payload anzuzeigen.

curl --location --request POST 'https://na-data.clarabridge.net/v1/cb_link?apiKey=887fc11663c456f9f34844a8a8bdff64&jobId=5f4d77656afa99b0396ef959' \
--header 'Content-Type: application/json ' \
--data-raw '{
"conversationId": "37854",
"conversationTimestamp": "2020-07-30T12:42:15.000Z",
"content": {
"contentType": "CHAT",
"Teilnehmer": [
{
"ParticipantId": "1",
"ParticipantType": "AGENT",
"is_bot": true
},
{
"ParticipantId": "2",
"ParticipantType": "CLIENT",
"is_bot": falsch
}
],
"conversationContent": [
{
"ParticipantId": "1",
"Text": "Hallo, wie kann ich Ihnen helfen?",
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785201"
},
{
"ParticipantId": "2",
"Text": "Hallo, hast du heute geöffnet?",
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785202"
},
{
"ParticipantId": "1",
"Text": "Wir sind von 17:00 bis 23:00 Uhr geöffnet.",
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785203"
},
{
"ParticipantId": "2",
"Text": "Ich möchte eine Reservierung vornehmen.",
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785204"
},
{
"ParticipantId": "1",
"text": "Auf jeden Fall! Welchen Namen kann ich verwenden?",
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785205"
}
]
},
"Stadt": "Boston",
"Quelle": "Facebook"
}'

Klicken Sie hier, um die Anruf-Beispiel-Payload anzuzeigen.

curl --location --request POST 'https://na-data.clarabridge.net/v1/cb_link?apiKey=887fc11663c456f9f34844a8a8bdff64&jobId=5f4e564d9242ae6e6308ff04' \
--header 'Content-Type: application/json ' \
--data-raw '{
"conversationId": "462896",
"conversationTimestamp": "2020-07-30T10:15:45.000Z",
"content": {
"contentType": "CALL",
"Teilnehmer": [
{
"Participant_id": "1",
"type": "AGENT",
"is_ivr": falsch
},
{
"Participant_id": "2",
"type": "CLIENT",
"is_ivr": falsch
}
],
"conversationContent": [
{
"Participant_id": "1",
"Text": "Das ist Emily, wie kann ich Ihnen helfen?",
"start": 22000,
"Ende": 32000
},
{
"Participant_id": "2",
"text": "Hallo, ich habe ein paar Fragen.",
"start": 32000,
"Ende": 42000
}
],
"contentSegmentType": "TURN"
},
"Stadt": "Boston",
"source": "Call Center"
}'