Zum Hauptinhalt springen

Intercom Entwickler-FAQs

Antworten auf häufig gestellte Fragen zu unserer Entwicklerdokumentation, APIs, webhooks und Apps.

Verfasst von Liz Moy

Verwenden Sie diesen Artikel, um Ihre Intercom-Entwicklerumgebung einzurichten, eine benutzerdefinierte Help Center domain mit SSL zu konfigurieren, Ihre App über Zugriffstoken oder OAuth zu authentifizieren und Kontakte, Unterhaltungen und tickets über die Intercom API (Application Programming Interface) zu verwalten. Er behandelt auch webhooks, Paginierung, den Aufbau von Messenger- und Inbox-Apps sowie die Fehlerbehebung bei häufigen API- und SSL-Fehlern. Für Entwickler gedacht, die Integrationen mit Intercom erstellen.


Intercom einrichten

Wie erstelle ich ein Entwicklerkonto?

Sie können einen neuen Entwicklerarbeitsbereich erstellen, um Apps zu entwickeln. Entwicklerarbeitsbereiche sind kostenlos und nur für Entwicklungszwecke gedacht. Nachdem Sie den neuen Arbeitsbereich erstellt haben, können Sie dieser Anleitung folgen, um eine App zu erstellen und Ihren ersten API-Aufruf zu tätigen.

Sie können eine neue App für Ihren Produktionsarbeitsbereich erstellen und das Zugriffstoken für die App erhalten, indem Sie zu https://app.intercom.com/a/apps/{your-workspace-id}/developer-hub/ gehen.

Wie richte ich eine benutzerdefinierte help center domain ein?

Wenn Sie Ihr Articles Help Center aktivieren, ist Ihr Inhalt standardmäßig über intercom.help verfügbar. Ihre URL sieht dann so aus: intercom.help/exampleapp.

Wenn Sie eine andere URL verwenden möchten, können Sie eine erstellen, indem Sie manuell eine benutzerdefinierte domain einrichten. Dies beinhaltet das Eingeben der benutzerdefinierten domain in Ihren Help Center Einstellungen, das Erstellen eines benutzerdefinierten CNAME-Eintrags und optional die Konfiguration von SSL. Die vollständigen Anweisungen zur Einrichtung finden Sie in unserer Entwicklerdokumentation. Wenn Ihr Help Center nach der Einrichtung einer benutzerdefinierten domain einen "nicht gefunden"-Fehler anzeigt, überprüfen Sie Ihren CNAME-Eintrag, um sicherzustellen, dass Ihr Subdomain auf den richtigen Intercom-Host zeigt: • Für HTTPS-Schnelleinrichtung: us.intercomhelpcenter.com (US-Region) • Für manuelle/HTTP-Einrichtung: custom.intercom.help (US-Region) Überprüfen Sie auch, ob das in Ihren Help Center Einstellungen ausgewählte Sicherheitsprotokoll mit Ihrer DNS-Konfiguration übereinstimmt.

Wie richte ich SSL ein?

SSL (oder TLS) ist die am weitesten verbreitete Methode, um die Verbindung zwischen Ihrem Server und Ihrem Browser zu sichern. Es stellt sicher, dass die Verbindung zwischen Server und Browser verschlüsselt und sicher ist und als HTTPS angezeigt wird.

Es gibt zwei Möglichkeiten, SSL mit Articles auf Ihrer benutzerdefinierten domain einzurichten:

  • Verwenden Sie ein flexibles SSL (unter Verwendung eines Drittanbieter-DNS-Anbieters wie CloudFlare oder AWS CloudFront)

  • Verwenden Sie Ihr eigenes SSL-Zertifikat (unter Verwendung eines TLS-Termination-Proxys)

Übernimmt Intercom die Verwaltung von SSL-Zertifikaten für benutzerdefinierte domains?

Ja! Wenn Sie „HTTPS (Schnelleinrichtung)“ in Ihren Help Center Einstellungen aktivieren, stellt Intercom automatisch ein SSL-Zertifikat für Ihre benutzerdefinierte domain aus und verwaltet es (wie https://help.ourdomain.com). Eine manuelle SSL-Einrichtung ist nicht erforderlich – weisen Sie einfach Ihren CNAME auf us.intercomhelpcenter.com und wir kümmern uns um den Rest.

So aktivieren Sie HTTPS (Schnelleinrichtung) für Ihre benutzerdefinierte domain

Hinweis: HTTPS (Schnelleinrichtung) ist nicht standardmäßig für alle Arbeitsbereiche verfügbar – es ist eine Einstellung, die unser Support-Team für Sie aktivieren kann. Nach der Aktivierung erscheint die Option HTTPS (Schnelleinrichtung) in Ihren Help Center Einstellungen. Folgen Sie den untenstehenden DNS-Einrichtungsanweisungen, um Ihre Konfiguration abzuschließen.

Wenn Sie Ihre benutzerdefinierte domain auf HTTPS umstellen möchten:

  1. Navigieren Sie zu Einstellungen > Help Center > Konfigurieren & Stil.

  2. Gehen Sie zum Abschnitt Domain .

  3. Wählen Sie HTTPS (Schnelleinrichtung) als Ihr Sicherheitsprotokoll und speichern Sie die Änderungen.

  4. Nach der Aktivierung stellen Sie sicher, dass Ihr CNAME-Eintrag auf [us.intercomhelpcenter.com](https://us.intercomhelpcenter.com) (oder [eu.intercomhelpcenter.com](https://eu.intercomhelpcenter.com) für EU-Regionen) über Ihren domain-Anbieter zeigt. Sie sollten eine Bestätigungs-E-Mail erhalten, wenn die Einrichtung erfolgreich war, normalerweise innerhalb von 48 Stunden.

Sie können SSL für Ihre benutzerdefinierte domain konfigurieren, um sensible Informationen verschlüsselt zu halten. Wenn Sie dies tun möchten, stellen Sie sicher, dass Sie Ihren CNAME bei einem DNS-Anbieter eingerichtet haben, der SSL unterstützt, wie Cloudflare.

Folgen Sie der Anleitung in unserer Entwicklerdokumentation zur Einrichtung von SSL. Beachten Sie, dass die Einrichtungsschritte je nach gewähltem Anbieter variieren können.

Erweiterte Fehlerbehebung

Wenn die Standard-SSL- und HTTPS-Konfigurationsschritte Ihr Problem nicht gelöst haben, behandeln die folgenden Szenarien häufige Sonderfälle für benutzerdefinierte Help Center domains:

  • HTTPS standardmäßig auf manuelle Einrichtung eingestellt: Siehe unseren Leitfaden für benutzerdefinierte domains für genaue Konfigurationsschritte.

  • Domain wird als „Nicht sicher“ angezeigt: Um Ihr help center, das auf HTTP gehostet wird, zu sichern, sollten Sie Folgendes in Betracht ziehen:

    • Verwendung eines Drittanbieter-DNS-Anbieters wie Cloudflare oder AWS CloudFront für flexibles SSL-Proxying.

    • Einsatz eines TLS-Termination-Proxys für erweiterte SSL-Zertifikatsverwaltung.

Häufige HTTPS/SSL-Probleme und Fehlerbehebung

1. Domain nicht sicher

  • Stellen Sie sicher, dass nur das Intercom SSL-Zertifikat für Ihre domain aktiv ist. Entfernen oder deaktivieren Sie alle zusätzlichen Zertifikate von Ihrem Host oder CDN (Content Delivery Network).

  • Wenn Sie ein CDN wie Cloudflare verwenden, stellen Sie den Proxy-Status auf „Nur DNS“ (graues Wolkensymbol).

  • Überprüfen Sie, ob Ihr DNS-CNAME-Eintrag auf den richtigen Intercom-Endpunkt zeigt (us.intercomhelpcenter.com für die USA, eu.intercomhelpcenter.com für die EU).

ERR_SSL_VERSION_OR_CIPHER_MISMATCH Fehler

  • Überprüfen Sie, ob Ihr CNAME (Canonical Name) Eintrag auf [us.intercomhelpcenter.com](https://us.intercomhelpcenter.com) zeigt.

  • Bestätigen Sie, dass keine widersprüchlichen DNS (Domain Name System) Einträge vorhanden sind. Es sollte nur ein CNAME für den domain-Eintrag aktiv sein. Löschen Sie alle Duplikate.

  • Stellen Sie sicher, dass die DNS-Propagation, die bis zu 72 Stunden dauern kann, abgeschlossen ist. Sie können Tools wie whatsmydns.net verwenden, um die globale Propagation zu überprüfen.

2. HTTPS-Einrichtung hängt auf „Ausstehend“

  • Überprüfen Sie häufige DNS-Konfigurationsprobleme, wie Formatierungsfehler im CNAME-Eintrag (z. B. versehentliches Anhängen von .yourdomain.com) oder die Verwendung eines falschen Eintragstyps (z. B. ein A-Eintrag statt CNAME).

  • Stellen Sie sicher, dass der CNAME-Eintrag auf us.intercomhelpcenter.com (oder eu.intercomhelpcenter.com für EU-Regionen) zeigt.

  • Warten Sie nach Korrekturen auf die DNS-Propagation, die bis zu 72 Stunden dauern kann. Verwenden Sie whatsmydns.net, um die globale Propagation vor erneuten Tests zu überprüfen.

3. HTTPS (Schnelleinrichtung) Option nicht verfügbar

  • Kontaktieren Sie den Intercom Support, um die HTTPS-Schnelleinrichtung für Ihren Workspace zu aktivieren — sie ist nicht standardmäßig verfügbar.

  • Stellen Sie sicher, dass Ihre Domain nicht bereits von einem anderen Intercom-Konto verwendet wird.

  • Überprüfen Sie, ob ein CNAME-Eintrag bei Ihrem DNS-Anbieter hinzugefügt wurde, der auf us.intercomhelpcenter.com zeigt.

4. Zugriff verweigert Fehler

  • Überprüfen Sie, ob der CNAME-Eintrag korrekt auf us.intercomhelpcenter.com zeigt.

  • Wenn Sie Cloudflare verwenden, stellen Sie SSL auf ‚Flexible‘ oder ‚Full‘ ein — vermeiden Sie ‚Full (Strict)‘.

  • Schalten Sie die SSL-Konfiguration aus und wieder ein, um die SSL-Bereitstellungssequenz neu zu starten.


Help Center URL- und Domain-Verwaltung

Defekte URLs nach der Migration

Wenn eine migrierte Artikel-URL nach dem Verschieben des Inhalts zu Intercom nicht mehr funktioniert:

  • Erstellen Sie einen neuen öffentlichen Artikel, um die defekte URL zu ersetzen.

  • Aktualisieren Sie alle Handlungsaufrufe oder Links in Ihrem Inhalt, damit sie auf die URL des neuen Artikels verweisen.

„Nicht gefunden“-Fehler, wenn Artikel intern in Ordnung aussehen

Wenn Ihr Help Center auf der öffentlichen URL einen „Nicht gefunden“-Fehler anzeigt, die Artikel aber in Ihrem Workspace korrekt erscheinen:

  • Überprüfen Sie, ob Ihr Help Center in Ihren Einstellungen auf Live gesetzt ist.

  • Navigieren Sie zu Einstellungen > Help Center und setzen Sie den Status auf Live, um die öffentliche URL zugänglich zu machen.

Allgemeine Schritte zur Fehlerbehebung bei Help Center-Problemen

Wenn Sie unerwartetes Verhalten in Ihrem Help Center feststellen, beginnen Sie mit diesen Schritten, bevor Sie die Konfiguration untersuchen:

  • Hard Refresh: Laden Sie die Seite neu, um temporäre Cache-Probleme zu beheben. Mac: Command + Shift + R. Windows: Strg + Shift + R.

  • Inkognito-Modus: Öffnen Sie das Help Center in einem privaten Browserfenster, um Browsererweiterungen oder zwischengespeicherte Inhalte auszuschließen. Mac: Command + Shift + N. Windows: Strg + Shift + N.

  • Cache und Cookies löschen: Löschen Sie den Cache und die Cookies Ihres Browsers und laden Sie die Seite neu.

  • In anderem Browser testen: Prüfen Sie, ob das Problem browserspezifisch ist, indem Sie das Help Center in einem anderen Browser öffnen.


Die Intercom API

Was ist die aktuelle Version der API?

Die aktuelle Version der API ist 2.15. Die Dokumentation zur API finden Sie auf unserer Entwickler-Dokumentationsseite. Sie können die Version, die Ihre App verwendet, auch in Ihrem Developer Hub ändern, indem Sie die Schritte in dieser Anleitung befolgen.

Wenn Sie die Intercom API verwenden, können Sie die Version auch im HTTP-Header Ihrer Anfrage ändern.

Welche Endpunkte sind in der aktuellen Version der API verfügbar?

Die folgenden Endpunkte sind in Version 2.15 der Intercom API verfügbar:

Kann ich einen Artikel über eine Schaltfläche im Messenger öffnen lassen?

Ja, wenn Sie einen Artikel im Messenger öffnen möchten, können Sie die showArticle Methode aus der JavaScript API verwenden. Der Artikel wird im Messenger geöffnet, und durch Klicken auf die Zurück-Schaltfläche des Messengers gelangen Sie zum vorherigen Kontext zurück. Wenn der Messenger beim Aufruf der Methode geschlossen ist, wird er zuerst geöffnet und dann der Artikel angezeigt. Dies ist auf allen Plattformen im Messenger verfügbar.

Wie man einen Artikel aus HTML auslöst

# You can add a link anywhere on your site to open an article in the Messenger: 

<a href="#" onclick="Intercom('showArticle', 123)">Open article</a>


Kontakte

Kann ich Benutzer mit der API in großen Mengen erstellen?

In Intercom fallen users unter die Bezeichnung Kontakte. Es gibt keinen Endpunkt zum massenhaften Erstellen von Kontakten mit der API, aber Sie können den create contacts endpoint verwenden, um ein Skript zu erstellen, das users importiert, oder folgen Sie diesem Tutorial, das Ihnen Codebeispiele zum Einstieg bietet.

Stellen Sie sicher, dass Sie eine Rate-Limiting-Prüfung einrichten, um sicherzustellen, dass Sie das Limit nicht überschreiten, das derzeit 10.000 API-Aufrufe pro Minute für jede App und 25.000 API-Aufrufe pro Minute pro Workspace beträgt.

Wie kann ich die Daten eines archivierten users abrufen?

Um die Daten eines archivierten Kontakts abzurufen, müssen Sie den Kontakt zuerst entarchivieren, was Sie mit dem unarchive contact API endpoint tun können, wenn Sie die Kontakt-ID haben.

Dann können Sie wieder auf die Kontaktdaten über den get a contact API endpoint und auf deren Gespräche über den retrieve a conversation API endpoint zugreifen.

Es ist nicht möglich, einen user oder Kontakt über die Benutzeroberfläche zu entarchivieren, dies muss über die API erfolgen.

Kann ich Notizen zu meinen Kontakten über die API löschen?

Nein, derzeit gibt es keine Möglichkeit, einzelne Notizen oder mehrere Notizen von Kontakten über die API zu löschen. Wenn diese Funktion für Ihre Abläufe wichtig ist, besuchen Sie bitte die Product Wishlist, um eine Funktionsanfrage zu erstellen, zu kommentieren oder zu bewerten. Notizen können manuell im Workspace gelöscht werden, jedoch nur einzeln.


Gespräche

Wie weise ich Gespräche einem Team über die API zu?

Wenn Sie ein Gespräch einem Team über die API zuweisen möchten, haben Sie zwei Möglichkeiten.

Die erste Möglichkeit ist, ein Gespräch direkt einem Admin oder einem Team über den manage a conversation API endpoint zuzuweisen. Sie benötigen Zugriff auf die von Intercom bereitgestellte ID für das Gespräch sowie auf admin_id und assignee_id.

Die andere Möglichkeit ist, bereits eingerichtete Zuweisungsregeln für das Gespräch über den run assignment rules on a conversation API endpoint auszuführen. Sie benötigen Zugriff auf die von Intercom bereitgestellte ID für das Gespräch.

Sie können die Funktionalität über die "Try It"-Funktion in unserer Entwicklerdokumentation, die Intercom Postman-Sammlung oder in Ihrem eigenen Terminal oder IDE (Integrierte Entwicklungsumgebung) testen. Vergessen Sie nicht, Ihr Intercom-Zugriffstoken als Bearer-Token zu verwenden.

Wie füge ich Notizen zu Gesprächen über die API hinzu?

Eine Notiz ist ein interner Kommentar, der nur für Teammitglieder sichtbar ist. Um eine Notiz zu einem Gespräch hinzuzufügen, können Sie den reply to a conversation API endpoint verwenden. Sie müssen einen message_type von note und einen Typ von "admin" sowie die admin_id angeben, von der die Notiz stammen soll.

Sie können die Funktionalität über die "Try It"-Funktion in unserer Entwicklerdokumentation, die Intercom Postman-Sammlung oder in Ihrem eigenen Terminal oder IDE testen. Vergessen Sie nicht, Ihr Intercom-Zugriffstoken als Bearer-Token zu verwenden.

Wie füge ich Tags zu Gesprächen über die API hinzu?

Wenn Sie bereits ein Tag in der Benutzeroberfläche erstellt haben, können Sie dieses Tag verwenden, um es Gesprächen zuzuweisen. Sie können auch ein neues Tag mit der API erstellen.

Um den add tag to a conversation API endpoint zu verwenden, benötigen Sie Zugriff auf die conversation_id des zu taggenden Gesprächs, die von Intercom bereitgestellte ID des Tags und die admin_id.

Sie können die Funktionalität über die "Try It"-Funktion in unserer Entwicklerdokumentation, die Intercom Postman-Sammlung oder in Ihrem eigenen Terminal oder IDE testen. Vergessen Sie nicht, Ihr Intercom-Zugriffstoken als Bearer-Token zu verwenden.

Wie erstelle ich ein Gespräch mit der API?

Sie können ein Gespräch über die API erstellen, das von einem Kontakt (z. B. user oder Lead) initiiert wurde, indem Sie den create a conversation API endpoint verwenden. Das Gespräch kann nur eine In-App-Nachricht sein.

Sie benötigen außerdem die von Intercom bereitgestellte ID für den Kontakt und den Textkörper, der als Nachrichteninhalt bei der Anfrage verwendet wird.

Sie können die Funktionalität über die "Try It"-Funktion in unserer Entwicklerdokumentation, die Intercom Postman-Sammlung oder in Ihrem eigenen Terminal oder IDE testen. Vergessen Sie nicht, Ihr Intercom-Zugriffstoken als Bearer-Token zu verwenden.

Wie lösche ich Gespräche mit der API?

Um ein Gespräch mit der API zu schließen, können Sie den manage a conversation API endpoint verwenden. Sie benötigen die von Intercom bereitgestellte ID des Gesprächs, Ihre admin_id und müssen einen message_type von "close" verwenden.

Wenn Sie nur einen bestimmten Teil des Gesprächs schwärzen müssen, verwenden Sie den redact a conversation part API endpoint.

Sie können die Funktionalität über die "Try It"-Funktion in unserer Entwicklerdokumentation, die Intercom Postman-Sammlung oder in Ihrem eigenen Terminal oder IDE testen. Vergessen Sie nicht, Ihr Intercom-Zugriffstoken als Bearer-Token zu verwenden.

Wie richte ich benutzerdefinierte Benachrichtigungen ein, wenn ein Teammitglied einem Gespräch zugewiesen wird?

Um eine benutzerdefinierte Benachrichtigung einzurichten, wenn eine Aktion ausgeführt wird, z. B. wenn ein Teammitglied einem Gespräch zugewiesen wird, können Sie webhooks verwenden.

Sie sollten das conversation.admin.assigned conversation topic verwenden. Alle Gesprächsthemen finden Sie in unserer Entwicklerdokumentation.

Sie können dieses webhook topic dann im Developer Hub abonnieren, indem Sie den Schritten in dieser Anleitung folgen. Sie benötigen außerdem eine öffentlich zugängliche Endpunkt-URL, die verfügbar ist, damit die Aktion ausgeführt wird, sobald der webhook ausgelöst wird, um die Benachrichtigung an Ihren bevorzugten Kanal zu senden.

Wie greife ich über die API auf Side Conversations zu?

Side Conversations haben keinen eigenen dedizierten Endpunkt, daher können Sie sie nicht direkt abrufen. Wenn Sie jedoch ein Gespräch abrufen, an das die Side Conversation angehängt ist, sehen Sie Gesprächsteile, die als "part_type": "side_conversation_reply" mit dem Inhalt der Nachrichten des users in der Side Conversation angezeigt werden.


Tickets

Wie erstelle ich ein Ticket mit der API?

Um ein Ticket mit der Intercom API zu erstellen, müssen Sie zuerst den Typ des Tickets erstellen oder erhalten, um das neue Ticket zu kennzeichnen. Dann können Sie das Ticket mit einer curl-Anfrage oder mit einer Programmiersprache Ihrer Wahl erstellen.

Folgen Sie dieser Anleitung aus unserer Entwicklerdokumentation, um einen Tickettyp zu erstellen und ein neues Ticket zu erstellen.

Wie kann ich Back Office Tickets kennzeichnen, damit sie bei der Verwendung der API nicht gezählt werden?

Wenn Sie die API verwenden, um Tickets und Ticketdaten abzurufen, können Sie den search tickets API endpoint verwenden. Um Back Office Tickettypen auszuschließen, setzen Sie das Feld auf ticket_type_id und verwenden Sie den Operator !=, um die ticket_type_id auszuschließen, die Back Office Tickettypen zugewiesen ist.

Wenn Sie die API verwenden, um ein Gespräch abzurufen oder Gespräche aufzulisten, die mit Back Office Tickets verbunden sind, und Sie diese ausschließen möchten, können Sie ähnlich alle Ergebnisse herausfiltern, die den Back Office Tickettyp als Attribut haben. Verknüpfte Tickets finden Sie im tickets-Parameter in der Antwort oder unter linked_objects.

Eine weitere verfügbare Option ist, die API zu verwenden, um Gespräche mit einem Back-Office-Ticket zu kennzeichnen, das damit verbunden ist. Sie können dann das Tag verwenden, um nach Ticketkategorie zu filtern.


Fehlercodes und Meldungen

Was bedeutet eine 403 API Plan restricted Fehlermeldung in einer Antwort?

Wenn Sie eine 403 API Plan restricted Meldung in einer Antwort erhalten, bedeutet dies, dass die API, die Sie verwenden möchten, in Ihrem App-Plan nicht verfügbar ist.

Um auf die API zugreifen zu können, müssen Sie Ihren Plan upgraden. Weitere Informationen zu Intercom-Plänen finden Sie auf dieser Seite. Eine vollständige Liste der Fehlercodes und HTTP-Antworten finden Sie in unserer Entwicklerdokumentation.

Was bedeutet eine 409 conflict Fehlermeldung in einer Antwort?

Wenn Sie eine 409 conflict Meldung in einer Antwort erhalten, bedeutet dies, dass vorhandene Daten in Ihrem Intercom-Arbeitsbereich mit den Anfragedaten kollidieren. Dies kann passieren, wenn Sie versuchen, einen Kontakt zu erstellen und bereits ein Kontakt mit dieser E-Mail-Adresse in Ihrer App vorhanden ist.

Um diesen Fehler zu vermeiden, können Sie stattdessen den Update-Endpunkt verwenden oder einen neuen Kontakt über user_id erstellen. Eine vollständige Liste der Fehlercodes und HTTP-Antworten finden Sie in unserer Entwicklerdokumentation.

Was bedeutet eine 429 Fehlermeldung in einer Antwort?

Wenn Sie eine 429 Meldung erhalten, bedeutet dies, dass der Client ein Rate-Limit erreicht oder überschritten hat oder der Server überlastet ist. Jede App hat ein Standard-Rate-Limit von 10.000 API-Aufrufen pro Minute pro App und 25.000 API-Aufrufen pro Minute pro Workspace. Weitere Informationen zu Rate-Limits sind in unserer Entwicklerdokumentation verfügbar.

Um diesen Fehler zu vermeiden, können Sie eine Rate-Limit-Prüfung einrichten, um sicherzustellen, dass Sie das Limit nicht überschreiten. Eine vollständige Liste der Fehlercodes und HTTP-Antworten finden Sie in unserer Entwicklerdokumentation.

Was sind die aktuellen Rate-Limits?

Private Apps haben ein Standard-Rate-Limit von 10.000 API-Aufrufen pro Minute pro App und 25.000 API-Aufrufen pro Minute pro Workspace. Das bedeutet, wenn in einem Workspace mehrere private Apps installiert sind, trägt jede einzelne zur Gesamtzahl der Anfragen bei.

Public Apps haben ein Standard-Rate-Limit von 10.000 API-Aufrufen pro Minute pro App und 25.000 API-Aufrufen pro Minute pro Workspace. Das bedeutet, wenn in einem Workspace mehrere public Apps installiert sind, hat jede ihr eigenes separates Anfragelimit, ohne zu den anderen beizutragen. Weitere Informationen zu Rate-Limits finden Sie in unserer Entwicklerdokumentation.


Berichterstattung

Warum ist mein Bericht unterschiedlich, wenn er über die API im Vergleich zur UI abgerufen wird?

Wenn Sie eigene Berichte mit der API erstellen, können Sie feststellen, dass es einige Unterschiede zwischen den beiden Berichten gibt. Dies kann aus verschiedenen Gründen passieren.

Ein häufiges Problem ist, wenn Daten und Zeiten nicht übereinstimmen. Dies liegt oft daran, dass die Zeitzone, die Sie in Ihrem Intercom-Arbeitsbereich verwenden, anders ist als die Zeitzone, die Sie für die Abfrage der API verwenden. Um dies zu beheben, passen Sie entweder Ihre API-Abfrageparameter an die Zeitzone Ihres Arbeitsbereichs an oder ändern Sie die Zeitzone Ihres benutzerdefinierten Berichts.

Ein weiteres Problem ist, dass Sie möglicherweise Metriken verwenden, die nicht mit den Metriken der Intercom-Berichts-UI übereinstimmen. Einige Metriken sind in der Berichts-UI verfügbar, aber nicht über die API, da es sich um berechnete Metriken handelt. Einige davon können durch Verwendung der API und Durchführung der Berechnungen auf Ihrer Seite erstellt werden. Sehen Sie sich den Leitfaden zum Erstellen eigener Berichte in der Intercom-Entwicklerdokumentation an.

Werden Back-Office-Tickets in den Statistiken gezählt, wenn ein Bericht über die API abgerufen wird?

Wenn Sie sich die Gesprächsberichte in der UI im Vergleich zu Berichten ansehen, die über die Conversations API abgerufen werden, werden Sie feststellen, dass es Unterschiede in der Anzahl der Gespräche gibt. Dies liegt daran, dass Back-Office-Tickets, die mit einem Gespräch verbunden sind, beim Abruf über die API einbezogen werden.

Um dies zu lösen, können Sie die Ergebnisse nach dem Abrufen über die list conversations, retrieve a conversation oder search for conversations API filtern und die Tickets von den Gesprächen anhand des ticket-Feldes in der Conversation API-Antwort trennen. Das ticket-Feld wird mit einem Objekt gefüllt, wenn es sich um ein Ticket handelt, und ist null, wenn es sich um ein Gespräch handelt.


Webhooks

Welche Webhooks sind verfügbar?

Webhooks ermöglichen es Ihnen, sich für Echtzeitbenachrichtigungen über Ereignisse in Intercom zu abonnieren, z. B. wenn ein Kontakt erstellt wird oder eine eingehende Nachricht empfangen wird.

Sie können die verfügbaren Webhooks für jede Version in unserer Entwicklerdokumentation einsehen. Sobald Sie den benötigten webhook identifiziert haben, folgen Sie dieser Anleitung, um ihn einzurichten.

Gibt es Pläne, neue Webhooks hinzuzufügen?

Es gibt keine Pläne, neue Webhooks in unserer Roadmap hinzuzufügen, aber wenn Ihr Team einen webhook benötigt, senden Sie bitte eine Anfrage an das Team oder fügen Sie ihn der Produkt-Wunschliste in der Intercom-Community hinzu.


Paginierung

Wie funktioniert die Paginierung?

Intercom APIs zum Auflisten und Durchsuchen von Ressourcen bieten eine Cursor-basierte Paginierung. Dies ist verfügbar, damit Sie bei der Anforderung großer Datenmengen – wie viele Gespräche mit all ihren Teilen – diese in kleineren Abschnitten empfangen und verarbeiten können.

Beispiele zur Verwendung der Paginierung mit den Intercom List APIs, die Pfadparameter akzeptieren, und den Search APIs, die Abfrageparameter verwenden, finden Sie in unserem Paginierungsleitfaden.

Wie verwende ich das starting_after-Feld?

Für die Cursor-basierte Paginierung verwendet Intercom einen Zeiger, der auf einen bestimmten Datensatz verweist, basierend auf dem Limit, das Sie durch die Anzahl der Seiten festlegen, die Sie pro Anfrage angeben.

Wenn es in einem Objekt zurückgegeben wird, sieht der Zeiger ungefähr so aus: 'WzXXXXXXXXXXXXXX'.

Sie können dann den Zeiger aus der Antwort verwenden, um die nächste Anfrage für den nächsten Datenblock zu stellen.

Die Paginierungsformatierung in der Anfrage unterscheidet sich leicht zwischen List APIs und Search APIs, aber die Antworten funktionieren gleich.

Beispiele für curl-Anfragen finden Sie auf unserer Paginierungsseite sowie Tutorials zur Verwendung von List APIs und Search APIs.


Authentifizierung

Welche Art der Authentifizierung ist für public apps erforderlich?

Alle Apps, die mit Daten von Drittanbieter-Workspaces interagieren, und Apps, die mit Canvas Kit erstellt wurden, benötigen OAuth. Sie sollten Benutzer niemals nach ihrem Zugriffstoken fragen und nur OAuth verwenden, um mit deren Daten zu interagieren.

Siehe die Dokumentation für Anweisungen zum Einrichten von OAuth.

Muss ich OAuth für meine App verwenden?

Sie müssen OAuth einrichten, wenn Sie eine Integration mit Intercom erstellen, die auf die Intercom-Daten anderer Personen zugreift. Dies gilt für public apps, die Sie im Intercom App Store listen möchten, sowie für Apps und Integrationen, die Sie Benutzer über Ihre eigene Website installieren lassen. Erfahren Sie mehr über OAuth in unserer Entwicklerdokumentation.

Wenn Sie nur auf Daten in Ihrem eigenen Intercom-Arbeitsbereich zugreifen, können Sie ein Access Token verwenden.

Welche Art der Authentifizierung ist für private apps erforderlich?

Wenn Sie eine private App erstellen, die nur auf Daten in Ihrem Intercom-Arbeitsbereich zugreift, können Sie Ihr Intercom Access Token zur Authentifizierung verwenden. Finden Sie Ihr Access Token in Ihrem Entwickler-Hub und erfahren Sie hier mehr über Authentifizierung.

Wo finde ich mein Intercom Access Token?

Sie können Ihr Intercom Access Token verwenden, wenn Sie die API nutzen, um auf Daten in Ihrem eigenen Intercom-Arbeitsbereich zuzugreifen. Finden Sie Ihr Access Token in Ihrem Entwickler-Hub und erfahren Sie hier mehr über Authentifizierung.

Um Ihr API Access Token zu finden, folgen Sie diesen Schritten:

  1. Öffnen Sie das Intercom Developer Hub.

  2. Navigieren Sie zu Your Apps im Developer Hub > Einstellungen > Your Apps. Sie sollten eine Liste der mit Ihrem Workspace verbundenen Apps sehen.

  3. Suchen Sie Ihre private App, die möglicherweise den Namen Ihres Workspace und manchmal den Zusatz "Access Token App" enthält.

  4. Klicken Sie auf den App-Namen, um die Details zu öffnen.

  5. Gehen Sie zum Abschnitt Authentication, um den Token zu finden. Behandeln Sie diesen Token wie ein Passwort, da er privat ist und nicht geteilt werden sollte.

Kann ich mein OAuth Client Secret rotieren oder ändern?

Ja, Intercom Support kann das OAuth Client Secret für Ihre App auf Anfrage rotieren. Nach der Rotation wird das alte Secret sofort ungültig und das neue Secret ist im Developer Hub verfügbar.

**Wichtig:** Das alte Secret wird sofort nach der Rotation ungültig. Seien Sie bereit, die Konfiguration Ihrer Integration sofort nach der Rotation zu aktualisieren, um Unterbrechungen zu vermeiden.

Um eine Rotation anzufordern, kontaktieren Sie Intercom Support mit Ihren App-Details. Stellen Sie sicher, dass Ihr Team bereit ist, die Konfiguration Ihrer Integration mit dem neuen Secret sofort zu aktualisieren, da das alte Secret ab dem Moment der Rotation nicht mehr gültig ist.


Apps installieren und veröffentlichen

Wie baue ich eine App für meinen Inbox?

Sie können eine App für Ihren Intercom Inbox mit Canvas Kit erstellen, einem Toolkit, das es Ihnen ermöglicht, Apps direkt innerhalb der Intercom UI zu bauen.

Folgen Sie diesem Tutorial, um zu lernen, wie Sie Ihre erste Inbox-App bauen. Sie können auch mehr über Canvas Kit erfahren und Referenzdokumente in unserer Entwicklerdokumentation finden.

Wie baue ich eine App für meinen Messenger?

Sie können eine App für Ihren Intercom Messenger mit Canvas Kit erstellen, einem Toolkit, das es Ihnen ermöglicht, Apps direkt innerhalb der Intercom UI zu bauen.

Beachten Sie, dass Anpassungen auf das beschränkt sind, was mit Canvas Kit möglich ist und innerhalb des Messenger erstellt werden müssen: Es ist nicht möglich, den Messenger neu zu erstellen oder umzugestalten.

Folgen Sie diesem Tutorial, um zu lernen, wie Sie Ihre erste Inbox-App bauen. Sie können auch mehr über Canvas Kit erfahren und Referenzdokumente in unserer Entwicklerdokumentation finden.

Wie installiere ich meine App?

Wenn Sie die Seite Test & Publish > Your Workspaces Ihrer App im Developer Hub besuchen, sollten Sie alle Workspaces sehen, bei denen Sie (als Intercom-Teammitglied) Mitglied sind.

Sie können auf Install app neben dem Workspace klicken, auf dem Sie die App installieren möchten. Diese App wird dann installiert und ein Access Token wird für diesen Workspace bereitgestellt, damit Sie über die API auf dessen Daten zugreifen können.

Für Anweisungen zur Installation von Drittanbieter-Apps siehe unsere Entwicklerdokumentation.

Wie kann ich meine App im Intercom App Store veröffentlichen?

Wenn Sie bereit sind, Ihre App zu veröffentlichen, können Sie die Schritte im Developer Hub befolgen. Eine Anleitung zum Veröffentlichen Ihrer App finden Sie in unserer Entwicklerdokumentation.


Messenger

Wie installiere ich den Messenger für iOS?

Das Intercom SDK (Software Development Kit) für iOS ermöglicht es Ihnen, den Intercom Messenger in Ihrer App zu verwenden, mit Ihren Kunden zu kommunizieren, reichhaltige ausgehende Nachrichten zu senden, Ihr Help Center anzuzeigen und Ereignisse zu verfolgen.

Sie können Intercom für iOS mit Cocoapods, Swift Package Manager oder manuell installieren. Lesen Sie die vollständige iOS-Installationsanleitung. Sie finden Intercom für iOS auf GitHub zusammen mit einer Beispiel-App, um das SDK zu erkunden.

Wie installiere ich den Messenger für Android?

Das Intercom SDK für Android ermöglicht es Ihnen, den Intercom Messenger in Ihrer App zu verwenden, mit Ihren Kunden zu kommunizieren, reichhaltige ausgehende Nachrichten zu senden, Ihr Help Center anzuzeigen und Ereignisse zu verfolgen.

Sie können Intercom für Android mit Gradle oder manuell installieren. Lesen Sie die vollständige Android-Installationsanleitung. Sie finden Intercom für Android auf GitHub zusammen mit einer Beispiel-App, um das SDK zu erkunden.

Wie installiere ich den Messenger für React Native?

Der Intercom React Native Wrapper ermöglicht es Ihnen, Intercom für iOS und Intercom für Android in Ihren React Native Apps zu verwenden. Folgen Sie der React Native Installationsanleitung, um zu starten.

Hat dies deine Frage beantwortet?