Artikelvorlage

Allgemein

Wie aktiviere ich mein Benutzerkonto?

Um auf API und zugehörige Funktionen zugreifen zu können, müssen Sie zunächst das Benutzerkonto aktivieren. Siehe Persönliche Einstellungen Einstellungen für weitere Informationen.

Wie beginne ich mit der API?

Siehe Qualtrics Social Connect API – Schritt-für-Schritt-Leitfaden.

Welche Art von Benutzerkonto benötige ich, um das API zu verwenden?

Der Zugriff auf das API ist nicht in allen Preisplänen enthalten. Kontakt den -Support, wenn Sie Fragen dazu haben, was in Ihrer Lizenz enthalten ist.

Haben Sie eine Bibliothek in der Programmiersprache x?

Qualtrics bietet keine Client-Bibliotheken an, aber Bibliotheken für das OAuth-Protokoll sind in fast jeder Sprache vorhanden, siehe http://oauth.net/code/.

Kann ich die API schnell testen?

Sie können das API über das API. Hier wählen Sie einen Endpunkt aus und geben die erforderlichen Parameter ein. Ein sofortiges Ergebnis wird angezeigt, damit Sie sehen können, ob das API zu Ihrem gewünschten Ergebnis geführt hat.

Können Sie die API erhöhen?

Siehe Ratenbegrenzung für eine Übersicht über API. Unsere aktuellen Tarifgrenzen reichen für Standardanwendungsfälle mehr als aus. Wenn Sie jedoch zusätzliche Tarifgrenzen benötigen, Kontakt an den Support, und beschreiben Sie den Anwendungsfall Ihrer Anwendung und die angeforderten Ratengrenzen.

Wie funktioniert das Filtern im API?

Mehrere Endpunkte des API ermöglichen es Ihnen, einen Filterzeichenfolgenparameter zu übergeben.

Angenommen, Sie rufen eine Liste von Erwähnungen ab. Sie können die Erwähnungen so filtern, dass nur Erwähnungen mit einem bestimmten Tag zurückgegeben werden.

Der Filterparameter ist immer eine Zeichenfolge. Die Syntax unterstützt die Suche nach mehreren Eigenschaften der Daten (erwähnte Wörter, Tags, Status, Auflösungszeit usw.) und deren Kombination mithilfe einer booleschen und geschachtelten Syntax.

Wenn Sie einen Filter in der Social-Connect-Plattform erstellen, ist dem Filter eine Textdarstellung zugeordnet. Diese Darstellung wird im Filterfenster angezeigt, nachdem Sie Ihre Filterfelder ausgewählt haben. Sie können diesen Parameter kopieren, um ihn dann in Ihren API zu verwenden.

Welche Methode wird zum Signieren von Webhooks verwendet?

Siehe Webhooks für weitere Informationen.

Warum werde ich auf 20 API pro Stunde begrenzt?

Wenn Sie die API verwenden, beträgt das Ratenlimit 20 authentifizierte Aufrufe pro Stunde, anstatt der standardmäßigen 350 Aufrufe pro Stunde für andere API. Wenn Sie dieses Limit von 20 Aufrufen haben, stellen Sie sicher, dass Sie das Zugriffstoken für Ihre API verwenden, nicht die API.

API

Wie werden API authentifiziert?

Qualtrics verwendet das Standard-OAuth-2.0-Protokoll. Siehe Authentifizierung für weitere Informationen.

Muss ich wirklich OAuth für meine Anwendung implementieren?

Wenn Sie die Benutzer Ihrer Anwendung nicht benötigen, um ihr Qualtrics zu authentifizieren, können Sie stattdessen ein OAuth-Token für Ihr eigenes Benutzerkonto generieren. Wechseln Sie zur Anwendungsübersicht, und wählen Sie Bearbeiten weiter Sie neben Ihrer registrierten Anwendung zur Zugriffstoken Registerkarte. Wenn Sie Mich autorisierenwird ein Zugriffstoken für Ihren aktuell angemeldeten Benutzer (mit seinen Berechtigungen) generiert. Mit diesem Zugriffstoken können Sie API signieren.

Wie lange sind Zugriffstoken gültig?

Siehe Authentifizierung Seite für weitere Informationen.

Auf welche Konten und Daten kann ich mit einem Token zugreifen?

Ein OAuth-Zugriffstoken wird für einen bestimmten Social-Connect-Benutzer generiert. Dieser Benutzer hat Zugriff auf ein oder mehrere Konten (Sie können über den Endpunkt `/me/accounts` sehen, welche). Welche Daten Sie aufrufen können, hängt davon ab, auf welche Konten der Benutzer selbst Zugriff hat und welche Benutzerrolle er in diesem Benutzerkonto hat.

Arbeiten mit Erwähnungen

Wie erhalte ich Erwähnungen aus meinem Social-Connect-Posteingang in meine eigene Anwendung?

Verwenden Sie den Endpunkt `/{account_id}/Inbox/mentions`, um alle Erwähnungen in einem Ihrer Themen abzurufen. Diese API deckt ab, welche Informationen für Ihre Erwähnungen abgerufen werden.

Sie können auch einen Workflow entwerfen, um Web-Hooks in Ihrer Anwendung über die Funktion der Social-Connect-Automatisierung aufzurufen.

Warum fehlen Details in Tweets, die von der API zurückgegeben werden?

Für Tweets kann Qualtrics nur die Social-Connect-spezifischen Daten und die Twitter-Tweet-ID zurückgeben. Dies ist eine Einschränkung der API.

Da Sie die Tweet-ID haben, können Sie auf die API, und verwenden Sie den Endpunkt “/status/lookup”  , um alle Details abzurufen.

Warum sind einige Facebook-Beiträge anonym?

Öffentliche Facebook-Beiträge (die von Social Connect über Ihre Stichwortsuche abgerufen werden, nicht Nachrichten auf Ihren Facebook-Seiten) werden anonymisiert. Hierbei handelt es sich um eine Einschränkung des API.

Kann ich meine eigenen Nachrichten zu Social Connect hinzufügen?

Wenn Sie ein Kontakt oder ein internes Forum haben, das von Social Connect überwacht werden soll, können Sie den Endpunkt “/{account_id}/Inbox/add” aufrufen, um Ihre benutzerdefinierten Nachrichten zu Social Connect hinzuzufügen. Auf diese Nachrichten kann dann in Ihrem Posteingang und in Erkenntnisse zugegriffen werden.

Nachrichten, die Social Connect über die API hinzugefügt wurden, können in Social Connect nicht beantwortet werden. Wenn Sie diese engere Integration in Ihr benutzerdefiniertes System wünschen, wenden Sie sich bitte an den Support.

Kann ich Fälle über das API exportieren?

Sie können den regulären Erwähnungsendpunkt (Liste exportieren/einzelne Erwähnung aktualisieren) verwenden, um Fälle zu exportieren. Wenn Sie in Ihrer Anfrage nur Fälle zurückgeben möchten, können Sie den Filter „sub_category:case“ verwenden.

Was ist der Unterschied zwischen Fällen und Erwähnungen für das API?

In Social Connect ist eine „Erwähnung“ das zentrale Objekt einer Nachricht (ein einzelner Tweet, eine einzelne private Nachricht, ein einzelner Kommentar). Es gibt auch das Konzept eines „Falls“, bei dem es sich im Grunde um eine Sammlung von Erwähnungen handelt.

Die Hauptverwendung für Fälle besteht darin, mehrere Nachrichten eines bestimmten Benutzers und Antworten von Agents in Konversationen zu gruppieren.

Aus technischer Sicht besteht ein „Fallgespräch“ aus:

• Der Fall selbst (der auch ein Erwähnungsobjekt ist).
• Ein Fall kann Bezeichnungen, einen Status, einen Titel usw. haben.
• Eine Liste der Erwähnungen, die Teil der Unterhaltung sind.
• Die Erwähnungen, die im Fall gruppiert wurden.

Siehe Diese API für weitere Informationen zu Fällen und Erwähnungen.

Kann ich Nachrichten in den Social-Connect-Ausgang importieren?

Über den Endpunkt “/{account_id}/publisher/add” können Sie Entwürfe von neuen Beiträgen für Social Manager anlegen, um sie zu überprüfen, zu bearbeiten und zu veröffentlichen.

Kann ich eine Erwähnung über das API bearbeiten?

Sie können vorhandene Erwähnungen bearbeiten, indem Sie den Endpunkt “/{account_id}/inbound/erwähnen/{topic_id}/{id}” verwenden. Die Dokumentation für diesen Endpunkt enthält Beispiele für die Aktualisierung der Tags einer Erwähnung, das Hinzufügen einer Notiz usw.

Wie lösche ich alle Daten eines bestimmten Benutzers in Engage über die API?

Wenn Sie alle Daten eines bestimmten Kunden löschen möchten, die sich in Ihrem Benutzerkonto befinden, müssen Sie zwei Arten von Daten löschen:

1. Alle Erwähnungen dieses Benutzers im System
2. Alle Informationen über diesen Benutzer, die in Social Connect CRM gespeichert sind.

Um alle Erwähnungen eines bestimmten Benutzers zu finden, verwenden Sie den Endpunkt “/{account_id}/Inbox/mentions”, und filtern Sie nach einer bestimmten Berechtigungs-ID, z.B. “author.id:123”.Sobald Sie diese Liste der Erwähnungen haben, können die Erwähnungen über den Endpunkt “/{account_id}/inbound/erwähnung/{topic_id}/{id}” gelöscht werden.

Um zu erfahren, ob Ihre Agents weitere Kontakt in Social Connect CRM für einen Kontakt gesichert haben, stellen Sie eine GET-Anfrage an “/{account_id}/Inbox/Kontakt/{service}/{service_id}”. Wenn das Antwortobjekt eine Kontakt enthält, bedeutet dies, dass es einen Kontakt für diesen Benutzer gibt. Wenn die Antwort keine Eigenschaft Kontakt enthält, bedeutet dies, dass keine Daten in Social Connect CRM gespeichert wurden.

Sobald Sie eine Kontakt haben, können Sie eine DELETE-Anforderung an den Endpunkt /{account_id}/Inbox/Kontakt/{contact_id} durchführen, um alle Informationen zu entfernen.

Mit Kontakten arbeiten  ​

Wie finde ich Kontakt aus einer Erwähnung oder einem Fall?

Wenn ein Erwähnung oder ein Fall wird vom API zurückgegeben. enthält sie eine Liste von „action_link“-Objekte. Aktionslinks enthalten Informationen für das aktuelle Objekt darüber, welche anderen API oder URLs in der Webanwendung für dieses Objekt relevant sind. Für Erwähnungen und Fälle ist einer der enthaltenen Aktionslinks, über den Sie die Kontakt des Autors der Erwähnung oder des Falls abrufen können.

Wenn Sie den Endpunkt /{account_id}/Inbox/cases verwenden, ist standardmäßig das Kontakt des Autors der Erwähnung enthalten. Qualtrics enthält nicht das vollständige Kontakt für Erwähnungen, aber über die Aktionslinks kann dieses Objekt dann durch einen separaten API abgerufen werden.

Publishing-Funktion

Kann ich die Clarabridge Engage API verwenden, um sie in einem Social-Media-Kanal zu veröffentlichen?

Nein, die API lässt keine direkte Veröffentlichung auf Drittanbieterplattformen zu. Das bedeutet, dass Sie das Social Connect API nicht verwenden können, um einen Tweet oder einen Facebook-Kommentar zu veröffentlichen.

Sie können jedoch das API verwenden, um Entwürfe oder Warteschlangennachrichten zur Genehmigung anzulegen. Diese werden dann veröffentlicht, wenn sie über die Social-Connect-Schnittstelle genehmigt oder veröffentlicht werden. Der Endpunkt für Nachrichtenentwürfe ist /{account_id}/publisher/add.

Benutzerverwaltung

Kann ich den Status von Benutzern über das API ändern?

Nein, Sie können den Status von Benutzern nicht über API ändern. Während Sie den Status nicht ändern können, können Sie den Namen, das Unternehmen, die E-Mail, den Avatar und den Plan für Geschäftszeiten über den Endpunkt /{account_id}/settings/user/{id} ändern.

Kann ich die Benutzerrolle von Benutzern über das API ändern?

Es ist möglich, die Benutzerrolle eines Benutzers über unser API zu ändern. Aus Sicherheitsgründen ist es jedoch nicht möglich, eine Benutzerrolle in Administrator zu ändern. Alle anderen Benutzerrollen können über den Endpunkt /{account_id}/settings/user/{id} in geändert werden.

Kann ich neue Benutzer über das API anlegen?

Aus Sicherheitsgründen ist dies über API nicht möglich.

Arbeiten mit Social-Media-Profilen

Kann ich Informationen zu den sozialen Profilen in meinen Themen abrufen?

Sie können Informationen zu einem bestimmten Social-Media-Profil über den Endpunkt “/{account_id}/Inbox/Kontakt/{service}/{service_id}” abrufen. Dazu gehören alle Details, die Sie für diese Person in Social Connect CRM eingegeben haben, z.B. Geschlecht, E-Mail oder benutzerdefinierte Attribute, die Sie für diesen Benutzer hinzugefügt haben.

Arbeiten mit Erkenntnisse

Kann ich Statistiken von Clarabridge Engage erhalten?

Sie können Daten aus Erkenntnisse über zwei verschiedene API abrufen:

1. Der Endpunkt “/{account_id}/dashboards/export/{dashboard_id}” gibt die Daten aus allen Widgets in einem bestimmten Dashboard zurück. Sobald Sie oder Ihre Benutzer benutzerdefinierte Dashboards eingerichtet haben, können Sie diesen Endpunkt verwenden, um die Daten hinter ihnen abzurufen.
2. Der Endpunkt “/{account_id}/Erkenntnisse/facets” fungiert als API der Funktion “Diagrammauswahl” in Social Connect.

Probleme

Wo finde ich meine Benutzerkonto?

Nachdem Sie sich authentifiziert haben, können Sie über den Endpunkt “/me/accounts” eine Liste aller Konten (und deren IDs) abrufen, auf die ein Benutzer Zugriff hat.

Wo finde ich meine Themen-ID?

Nachdem Sie sich authentifiziert haben, können Sie über den Endpunkt “/me/accounts” eine Liste aller Topics (und deren IDs) abrufen, auf die ein Benutzer Zugriff hat.

Wo finde ich meine Benutzer-ID?

Nachdem Sie sich authentifiziert haben, können Sie Details zum authentifizierenden Benutzer (einschließlich seiner ID) über den Endpunkt “/me” abrufen.