Dies sind Antworten auf häufig gestellte Fragen zu:

Sie können einen neuen Entwicklerarbeitsbereich erstellen, um Apps zu entwickeln. Entwicklerarbeitsbereiche sind kostenlos und nur für Entwicklungszwecke gedacht. Sobald 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.

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.

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:

Ja! Wenn Sie „HTTPS (quick setup)“ 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 – richten Sie einfach Ihren CNAME auf us.intercomhelpcenter.com und wir kümmern uns um den Rest.

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

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.

1. Domain nicht sicher

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 im Developer Hub ändern, indem Sie den Schritten in dieser Anleitung folgen.

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

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

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 im Messenger 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.

In Intercom fallen Benutzer unter die Bezeichnung Contacts. Es gibt keinen Endpunkt zum massenhaften Erstellen von Contacts über die API, aber Sie können den Create Contacts Endpunkt verwenden, um ein Skript zu erstellen, das Benutzer importiert, oder folgen Sie diesem Tutorial, das Ihnen Beispielcode zum Einstieg bietet.

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

Um die Daten eines archivierten Contacts abzurufen, müssen Sie den Contact zuerst wiederherstellen, was Sie mit dem Unarchive Contact API Endpunkt tun können, wenn Sie die ID des Contacts haben.

Dann können Sie über den Get a Contact API Endpunkt wieder auf die Daten des Contacts zugreifen und über den Retrieve a Conversation API Endpunkt auf deren Gespräche.

Nein, derzeit gibt es keine Möglichkeit, einzelne Notizen oder mehrere Notizen von Contacts ü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 unterstützen. Notizen können manuell im Workspace gelöscht werden, aber nur einzeln.

Wenn Sie eine Konversation einem Team über die API zuweisen möchten, haben Sie zwei Möglichkeiten.

Die erste Möglichkeit ist, eine Konversation direkt einem Admin oder einem Team über den manage a conversation API endpoint zuzuweisen. Sie benötigen Zugriff auf die von Intercom bereitgestellte ID der Konversation sowie auf die admin_id und die assignee_id.

Die andere Möglichkeit ist, bereits eingerichtete Zuweisungsregeln auf die Konversation über den run assignment rules on a conversation API endpoint anzuwenden. Sie benötigen Zugriff auf die von Intercom bereitgestellte ID der Konversation.

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

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

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

Wenn Sie bereits ein Tag in der UI erstellt haben, können Sie dieses Tag verwenden, um es auf Konversationen anzuwenden. Sie können auch ein neues Tag über die API erstellen.

Um den add tag to a conversation API endpoint zu verwenden, benötigen Sie Zugriff auf die conversation_id der zu taggenden Konversation, 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 collection oder in Ihrem eigenen Terminal oder Ihrer IDE testen. Vergessen Sie nicht, Ihren Intercom-Zugriffstoken als Bearer-Token zu verwenden.

Sie können eine Konversation über die API erstellen, die von einem Kontakt (z. B. user oder lead) initiiert wurde, indem Sie den create a conversation API endpoint verwenden. Die Konversation kann nur eine In-App-Nachricht sein.

Sie benötigen außerdem die von Intercom bereitgestellte ID des Kontakts und den Textkörper. Verwenden Sie diese, um die Konversation zu starten.

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

Um eine Konversation über die API zu schließen, können Sie den manage a conversation API endpoint verwenden. Sie benötigen die von Intercom bereitgestellte ID der Konversation, Ihre admin_id und müssen einen message_type von "close" verwenden.

Wenn Sie nur einen bestimmten Teil der Konversation schwärzen möchten, 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 collection oder in Ihrem eigenen Terminal oder Ihrer IDE testen. Vergessen Sie nicht, Ihren Intercom-Zugriffstoken als Bearer-Token zu verwenden.

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

Sie sollten das conversation.admin.assigned conversation topic verwenden. Alle Konversationsthemen 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 die Aktion ausführt, sobald der webhook ausgelöst wird, um die Benachrichtigung an Ihren bevorzugten Kanal zu senden.

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

Um ein ticket über die Intercom API zu erstellen, müssen Sie zunächst 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.

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 den Operator !=, um die ticket_type_id auszuschließen, die Back Office tickettypen zugewiesen ist.

Wenn Sie die API verwenden, um eine Konversation abzurufen oder Konversationen 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 Möglichkeit ist, die API zu verwenden, um Konversationen mit einem Back Office ticket zu taggen. Sie können dann das Tag verwenden, um nach ticketkategorie zu filtern.

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.

Wenn Sie eine 409 conflict Meldung in einer Antwort erhalten, bedeutet dies, dass es bereits Daten in Ihrem Intercom-Arbeitsbereich gibt, die 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.

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 für jede App und 25.000 API-Aufrufen pro Minute pro Arbeitsbereich. Weitere Informationen zu Rate-Limits finden Sie in unserer Entwicklerdokumentation.

Um diesen Fehler zu vermeiden, können Sie eine Rate-Limiting-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.

Private Apps haben ein Standard-Rate-Limit von 10.000 API-Aufrufen pro Minute pro App und 25.000 API-Aufrufen pro Minute pro Arbeitsbereich. Das bedeutet, wenn in einem Arbeitsbereich 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 für jede App und 25.000 API-Aufrufen pro Minute pro Arbeitsbereich. Das bedeutet, wenn in einem Arbeitsbereich 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.

Wenn Sie eigene Berichte mit der API erstellen, stellen Sie möglicherweise fest, 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 Reporting UI übereinstimmen. Einige Metriken, die in der Reporting UI verfügbar sind, sind über die API nicht verfügbar, da es sich um berechnete Metriken handelt. Einige davon können erstellt werden, indem Sie die API verwenden und die Berechnungen auf Ihrer Seite durchführen. Sehen Sie sich den Leitfaden zum Erstellen eigener Berichte in der Intercom-Entwicklerdokumentation an.

Wenn Sie sich die in der UI verfügbaren Gesprächsberichte im Vergleich zu Berichten ansehen, die über die conversations API abgerufen werden, werden Sie möglicherweise feststellen, dass die Anzahl der Gespräche unterschiedlich ist. 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 Gesprächen anhand des ticket-Felds 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 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 für jede Version verfügbaren webhooks in unserer Entwicklerdokumentation einsehen. Sobald Sie den benötigten webhook identifiziert haben, folgen Sie diesem Leitfaden, um ihn einzurichten.

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.

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 vieler 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.

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 Datenabschnitt zu stellen.

Die Formatierung der Paginierung 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.

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.

Sie müssen OAuth einrichten, wenn Sie eine Integration mit Intercom erstellen, die auf die Intercom-Daten anderer Personen zugreift. Dies gilt für öffentliche 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 Workspace zugreifen, können Sie ein Access Token verwenden.

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

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

Um Ihr API Access Token zu finden, befolgen Sie diese Schritte:

Sie können eine App für Ihren Intercom Inbox mit Canvas Kit erstellen, einem Toolkit, mit dem Sie Apps direkt innerhalb der Intercom UI erstellen können.

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

Sie können eine App für Ihren Intercom Messenger mit Canvas Kit erstellen, einem Toolkit, mit dem Sie Apps direkt innerhalb der Intercom UI erstellen können.

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

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

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 jeweilige App installieren möchten. Diese App wird dann installiert und ein Access Token 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.

Wenn Sie bereit sind, Ihre App zu veröffentlichen, können Sie die Schritte im developer hub befolgen. Eine Anleitung zur Veröffentlichung Ihrer App finden Sie in unserer Entwicklerdokumentation.

Das Intercom SDK 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 Details hier. Intercom für iOS finden Sie auf GitHub zusammen mit einer Beispiel-App, mit der Sie das SDK ausprobieren können hier.

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 Details hier. Intercom für Android finden Sie auf GitHub zusammen mit einer Beispiel-App, mit der Sie das SDK ausprobieren können hier.

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 den Einrichtungsschritten hier.