Häufig gestellte Fragen zur Social-Connect-API

Allgemein

Wie aktiviere ich mein Entwicklerkonto?

Um auf API und zugehörige Funktionen zugreifen zu können, müssen Sie zunächst das Entwicklerkonto aktivieren. Weitere Informationen finden Sie unter Persönliche Einstellungen Einstellungen.

Wie kann ich mit der Social Connect API beginnen?

Weitere Informationen finden Sie in der Schritt-für-Schritt-Anleitung zur Qualtrics Social Connect API.

Welche Art von Konto benötige ich, um das Social Connect API zu verwenden?

Der Zugriff auf das API ist nicht in allen Preisplänen enthalten. Wenden Sie sich an den -Support, wenn Sie Fragen zu den in Ihrer Lizenz enthaltenen Informationen haben.

Verfügen Sie über eine Client-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 die API über die API-Konsole testen. Hier wählen Sie einen Endpunkt aus und geben die erforderlichen Parameter ein. Es wird ein sofortiges Ergebnis angezeigt, in dem Sie sehen können, ob die API zu Ihrem gewünschten Ergebnis geführt hat.

Können Sie die API-Ratengrenzen erhöhen?

Eine Übersicht der API-Ratenlimits finden Sie unter Ratenbegrenzung. Unsere aktuellen Ratengrenzen sind für Standardanwendungsfälle mehr als ausreichend. Wenn Sie jedoch zusätzliche Ratenlimits benötigen, wenden Sie sich an den Support, und beschreiben Sie den Anwendungsfall Ihrer Anwendung und die angeforderten Ratenlimits.

Wie funktioniert das Filtern im API?

Mit mehreren Endpunkten des Social-Connect-APIs können Sie einen Filter-String-Parameter ü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 ein String. Die Syntax unterstützt die Suche nach mehreren Eigenschaften der Daten (Wörter, Tags, Status, Auflösungszeit usw.) und deren Kombination mithilfe einer booleschen und verschachtelten Syntax.

Wenn Sie einen Filter in der Social-Connect-Plattform erstellen, ist dem Filter eine textuelle Darstellung 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-Aufrufen zu verwenden.

Welche Methode wird zum Signieren von Webhooks verwendet?

Weitere Informationen finden Sie unter Webhooks.

Warum bin ich auf 20 API-Aufrufe pro Stunde begrenzt?

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

API-Authentifizierung

Wie werden API-Aufrufe authentifiziert?

Qualtrics verwendet das Standard-OAuth-2.0-Protokoll. Weitere Informationen finden Sie unter Authentifizierung.

Muss ich OAuth wirklich für meine Anwendung implementieren?

Wenn Sie die Benutzer Ihrer Anwendung nicht benötigen, um ihr Qualtrics-Social-Connect-Konto zu authentifizieren, können Sie stattdessen ein OAuth-Token für Ihr eigenes Benutzerkonto generieren. Wechseln Sie zur Anwendungsübersicht, klicken Sie neben Ihrer registrierten Anwendung auf Bearbeiten, und wechseln Sie zur Registerkarte Zugriffstoken. Wenn Sie auf Mich selbst autorisieren klicken, wird ein Zugriffstoken für Ihren aktuell angemeldeten Benutzer (mit seinen Berechtigungen) generiert. Mit diesem Zugriffstoken können Sie API-Anforderungen signieren.

Wie lange sind Zugriffstoken gültig?

Weitere Informationen finden Sie auf der Seite Authentifizierung.

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 (welche können Sie über den Endpunkt `/me/accounts` sehen). Welche Daten Sie aufrufen können, hängt davon ab, auf welche Konten der Benutzer selbst Zugriff hat und welche Benutzerrolle er in diesem Konto hat.

Arbeiten mit Erwähnungen

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

Verwenden Sie den Endpunkt `/{account_id}/box/mentions`, um alle Erwähnungen in einem Ihrer Themen abzurufen. Auf dieser API-Supportseite erfahren Sie, welche Informationen für Ihre Erwähnungen abgerufen werden.

Sie können auch einen Workflow entwerfen, um Web-Hooks in Ihrer Anwendung mithilfe der Automatisierungsrezeptfunktion von Social Connect aufzurufen.

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

Für Tweets kann Qualtrics nur die für Social Connect spezifischen Daten und die Twitter-Tweet-ID zurückgeben. Hierbei handelt es sich um eine Einschränkung der Twitter-API-Bedingungen.

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

Warum sind einige Facebook-Beiträge anonym?

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

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

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

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

Kann ich Fälle über das API exportieren?

Sie können den Endpunkt der regulären Erwähnung (Liste exportieren/einzelne Erwähnung aktualisieren) verwenden, um Fälle zu exportieren. Wenn Sie nur Fälle in Ihrer Anfrage 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“, der im Grunde eine Sammlung von Erwähnungen ist.

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

Technisch gesehen besteht ein „Fallgespräch“ aus:

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

Weitere Informationen zu Fällen und Erwähnungen finden Sie auf dieser API-Supportseite.

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

Sie können Entwürfe neuer Beiträge für Social-Media-Manager anlegen, um sie über den Endpunkt “/{account_id}/publisher/add” zu prü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}/fernen/erwähnen/{topic_id}/{id}” verwenden. Die Dokumentation für diesen Endpunkt enthält Beispiele zum Aktualisieren der Tags einer Erwähnung, zum Hinzufügen einer Notiz usw.

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

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

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

Um alle Erwähnungen eines bestimmten Benutzers zu finden, verwenden Sie den Endpunkt “/{account_id}/inbound/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}/Inbox/erwähnen/{topic_id}/{id}” gelöscht werden.

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

Sobald Sie eine contact.id haben, können Sie eine DELETE-Anfrage an den Endpunkt /{account_id}/box/contact/{contact_id} ausführen, um alle Informationen zu entfernen.

Arbeiten mit Kontakten  ​

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

Wenn das API eine Erwähnung oder einen Fall zurückgibt, enthält sie eine Liste von „action_link“-Objekten. Aktionslinks enthalten Informationen für das aktuelle Objekt darüber, welche anderen API-Endpunkte oder URLs in der Webanwendung für dieses Objekt relevant sind. Für Erwähnungen und Fälle können Sie über einen der enthaltenen Aktionslinks die Kontaktdaten des Autors der Erwähnung oder des Falls abrufen.

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

Publishing

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

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

Sie können jedoch das Social-Connect-API verwenden, um Entwürfe oder Warteschlangennachrichten zur Genehmigung anzulegen. Diese werden dann veröffentlicht, wenn sie genehmigt oder über die Social-Connect-Schnittstelle 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. Obwohl Sie den Status nicht ändern können, können Sie den Namen, das Unternehmen, die E-Mail, den Avatar und den Geschäftsstundenzeitplan ü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 über das API neue Benutzer anlegen?

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

Mit Social-Media-Profilen arbeiten

Kann ich Informationen zu den Social-Media-Profilen in meinen Themen abrufen?

Sie können Informationen zu einem bestimmten Social-Media-Profil über den Endpunkt “/{account_id}/Inbox/contact/{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 Informationen

Kann ich Statistiken von Clarabridge Engage erhalten?

Sie können Daten aus Insights mithilfe von zwei verschiedenen API-Endpunkten abrufen.

1. Der Endpunkt “/{account_id}/dashboards/export/{dashboard_id}” gibt die Daten aus allen Widgets auf 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}/Insights/facets” fungiert als API-Äquivalent der Diagrammauswahl -Funktion in Social Connect.

Probleme

Wo finde ich meine Konto-ID?

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

Wo finde ich meine Themen-ID?

Sobald Sie sich authentifiziert haben, können Sie eine Liste aller Themen (und deren IDs) abrufen, auf die ein Benutzer über den Endpunkt “/me/accounts” zugreifen kann.

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.