mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-24 22:38:00 -05:00
361 lines
15 KiB
Plaintext
361 lines
15 KiB
Plaintext
---
|
||
title: Intercom
|
||
description: Verwalte Kontakte, Unternehmen, Gespräche, Tickets und Nachrichten in Intercom
|
||
---
|
||
|
||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||
|
||
<BlockInfoCard
|
||
type="intercom"
|
||
color="#E0E0E0"
|
||
/>
|
||
|
||
{/* MANUAL-CONTENT-START:intro */}
|
||
[Intercom](https://www.intercom.com/) ist eine führende Kundenkommunikationsplattform, die es dir ermöglicht, deine Interaktionen mit Kontakten, Unternehmen, Gesprächen, Tickets und Nachrichten an einem Ort zu verwalten und zu automatisieren. Die Intercom-Integration in Sim ermöglicht es deinen Agenten, Kundenbeziehungen, Support-Anfragen und Gespräche direkt aus deinen automatisierten Workflows heraus programmatisch zu verwalten.
|
||
|
||
Mit den Intercom-Tools kannst du:
|
||
|
||
- **Kontaktverwaltung:** Erstellen, abrufen, aktualisieren, auflisten, suchen und löschen von Kontakten – automatisiere deine CRM-Prozesse und halte deine Kundendaten aktuell.
|
||
- **Unternehmensverwaltung:** Erstelle neue Unternehmen, rufe Unternehmensdetails ab und liste alle Unternehmen auf, die mit deinen Nutzern oder Geschäftskunden verbunden sind.
|
||
- **Gesprächshandling:** Abrufen, auflisten, beantworten und durchsuchen von Gesprächen – ermöglicht Agenten, laufende Support-Threads zu verfolgen, Antworten zu geben und Folgemaßnahmen zu automatisieren.
|
||
- **Ticket-Management:** Erstelle und rufe Tickets programmatisch ab, um Kundendienst, Tracking von Support-Problemen und Workflow-Eskalationen zu automatisieren.
|
||
- **Nachrichten senden:** Löse Nachrichten an Nutzer oder Leads für Onboarding, Support oder Marketing aus, alles innerhalb deiner Workflow-Automatisierung.
|
||
|
||
Durch die Integration von Intercom-Tools in Sim ermöglichst du deinen Workflows, direkt mit deinen Nutzern zu kommunizieren, Kundensupport-Prozesse zu automatisieren, Leads zu verwalten und die Kommunikation im großen Maßstab zu optimieren. Egal ob du neue Kontakte erstellen, Kundendaten synchronisieren, Support-Tickets verwalten oder personalisierte Engagement-Nachrichten senden musst – die Intercom-Tools bieten eine umfassende Möglichkeit, Kundeninteraktionen als Teil deiner intelligenten Automatisierungen zu verwalten.
|
||
{/* MANUAL-CONTENT-END */}
|
||
|
||
## Nutzungsanweisungen
|
||
|
||
Integriere Intercom in den Workflow. Kann Kontakte erstellen, abrufen, aktualisieren, auflisten, suchen und löschen; Unternehmen erstellen, abrufen und auflisten; Gespräche abrufen, auflisten, beantworten und durchsuchen; Tickets erstellen und abrufen; sowie Nachrichten erstellen.
|
||
|
||
## Tools
|
||
|
||
### `intercom_create_contact`
|
||
|
||
Erstellen Sie einen neuen Kontakt in Intercom mit E-Mail, external_id oder Rolle
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `role` | string | Nein | Die Rolle des Kontakts. Akzeptiert 'user' oder 'lead'. Standardmäßig 'lead', wenn nicht angegeben. |
|
||
| `email` | string | Nein | Die E-Mail-Adresse des Kontakts |
|
||
| `external_id` | string | Nein | Eine eindeutige Kennung für den Kontakt, die vom Client bereitgestellt wird |
|
||
| `phone` | string | Nein | Die Telefonnummer des Kontakts |
|
||
| `name` | string | Nein | Der Name des Kontakts |
|
||
| `avatar` | string | Nein | Eine Avatar-Bild-URL für den Kontakt |
|
||
| `signed_up_at` | number | Nein | Der Zeitpunkt der Registrierung des Benutzers als Unix-Zeitstempel |
|
||
| `last_seen_at` | number | Nein | Der Zeitpunkt, zu dem der Benutzer zuletzt gesehen wurde, als Unix-Zeitstempel |
|
||
| `owner_id` | string | Nein | Die ID eines Administrators, dem die Kontoverantwortung für den Kontakt zugewiesen wurde |
|
||
| `unsubscribed_from_emails` | boolean | Nein | Ob der Kontakt von E-Mails abgemeldet ist |
|
||
| `custom_attributes` | string | Nein | Benutzerdefinierte Attribute als JSON-Objekt \(z. B. \{"attribute_name": "value"\}\) |
|
||
| `company_id` | string | Nein | Unternehmens-ID, mit der der Kontakt bei der Erstellung verknüpft werden soll |
|
||
|
||
#### Ausgabe
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `contact` | object | Erstelltes Kontaktobjekt |
|
||
|
||
### `intercom_get_contact`
|
||
|
||
Einen einzelnen Kontakt anhand der ID von Intercom abrufen
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `contactId` | string | Ja | Kontakt-ID zum Abrufen |
|
||
|
||
#### Output
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `contact` | object | Kontaktobjekt |
|
||
|
||
### `intercom_update_contact`
|
||
|
||
Einen bestehenden Kontakt in Intercom aktualisieren
|
||
|
||
#### Input
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `contactId` | string | Ja | Kontakt-ID, die aktualisiert werden soll |
|
||
| `role` | string | Nein | Die Rolle des Kontakts. Akzeptiert 'user' oder 'lead'. |
|
||
| `external_id` | string | Nein | Eine eindeutige Kennung für den Kontakt, die vom Client bereitgestellt wird |
|
||
| `email` | string | Nein | Die E-Mail-Adresse des Kontakts |
|
||
| `phone` | string | Nein | Die Telefonnummer des Kontakts |
|
||
| `name` | string | Nein | Der Name des Kontakts |
|
||
| `avatar` | string | Nein | Eine Avatar-Bild-URL für den Kontakt |
|
||
| `signed_up_at` | number | Nein | Der Zeitpunkt der Registrierung des Benutzers als Unix-Zeitstempel |
|
||
| `last_seen_at` | number | Nein | Der Zeitpunkt, zu dem der Benutzer zuletzt gesehen wurde, als Unix-Zeitstempel |
|
||
| `owner_id` | string | Nein | Die ID eines Administrators, dem die Kontoverantwortung für den Kontakt zugewiesen wurde |
|
||
| `unsubscribed_from_emails` | boolean | Nein | Ob der Kontakt von E-Mails abgemeldet ist |
|
||
| `custom_attributes` | string | Nein | Benutzerdefinierte Attribute als JSON-Objekt \(z. B. \{"attribute_name": "value"\}\) |
|
||
| `company_id` | string | Nein | Unternehmens-ID, mit der der Kontakt verknüpft werden soll |
|
||
|
||
#### Output
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `contact` | object | Aktualisiertes Kontaktobjekt |
|
||
|
||
### `intercom_list_contacts`
|
||
|
||
Alle Kontakte von Intercom mit Paginierungsunterstützung auflisten
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `per_page` | number | Nein | Anzahl der Ergebnisse pro Seite (max: 150) |
|
||
| `starting_after` | string | Nein | Cursor für Paginierung - ID, nach der begonnen werden soll |
|
||
|
||
#### Ausgabe
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `contacts` | array | Array von Kontaktobjekten |
|
||
|
||
### `intercom_search_contacts`
|
||
|
||
Suche nach Kontakten in Intercom mit einer Abfrage
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `query` | string | Ja | Suchabfrage (z. B. \{"field":"email","operator":"=","value":"user@example.com"\}) |
|
||
| `per_page` | number | Nein | Anzahl der Ergebnisse pro Seite (max: 150) |
|
||
| `starting_after` | string | Nein | Cursor für Paginierung |
|
||
| `sort_field` | string | Nein | Feld zum Sortieren (z. B. "name", "created_at", "last_seen_at") |
|
||
| `sort_order` | string | Nein | Sortierreihenfolge: "ascending" oder "descending" |
|
||
|
||
#### Ausgabe
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `contacts` | array | Array von übereinstimmenden Kontaktobjekten |
|
||
|
||
### `intercom_delete_contact`
|
||
|
||
Einen Kontakt aus Intercom nach ID löschen
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `contactId` | string | Ja | Kontakt-ID zum Löschen |
|
||
|
||
#### Ausgabe
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `id` | string | ID des gelöschten Kontakts |
|
||
| `deleted` | boolean | Ob der Kontakt gelöscht wurde |
|
||
| `metadata` | object | Metadaten der Operation |
|
||
|
||
### `intercom_create_company`
|
||
|
||
Ein Unternehmen in Intercom erstellen oder aktualisieren
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `company_id` | string | Ja | Ihre eindeutige Kennung für das Unternehmen |
|
||
| `name` | string | Nein | Der Name des Unternehmens |
|
||
| `website` | string | Nein | Die Website des Unternehmens |
|
||
| `plan` | string | Nein | Der Name des Unternehmensplans |
|
||
| `size` | number | Nein | Die Anzahl der Mitarbeiter im Unternehmen |
|
||
| `industry` | string | Nein | Die Branche, in der das Unternehmen tätig ist |
|
||
| `monthly_spend` | number | Nein | Wie viel Umsatz das Unternehmen für Ihr Geschäft generiert. Hinweis: Dieses Feld rundet Dezimalzahlen auf ganze Zahlen ab (z. B. wird 155,98 zu 155) |
|
||
| `custom_attributes` | string | Nein | Benutzerdefinierte Attribute als JSON-Objekt |
|
||
| `remote_created_at` | number | Nein | Der Zeitpunkt, zu dem das Unternehmen von Ihnen erstellt wurde, als Unix-Zeitstempel |
|
||
|
||
#### Ausgabe
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `company` | object | Erstelltes oder aktualisiertes Unternehmensobjekt |
|
||
|
||
### `intercom_get_company`
|
||
|
||
Ein einzelnes Unternehmen anhand der ID von Intercom abrufen
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `companyId` | string | Ja | Unternehmens-ID zum Abrufen |
|
||
|
||
#### Ausgabe
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `company` | object | Unternehmensobjekt |
|
||
|
||
### `intercom_list_companies`
|
||
|
||
Listet alle Unternehmen von Intercom mit Paginierungsunterstützung auf. Hinweis: Dieser Endpunkt hat ein Limit von 10.000 Unternehmen, die über Paginierung zurückgegeben werden können. Für Datensätze mit mehr als 10.000 Unternehmen verwenden Sie stattdessen die Scroll-API.
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `per_page` | number | Nein | Anzahl der Ergebnisse pro Seite |
|
||
| `page` | number | Nein | Seitennummer |
|
||
| `starting_after` | string | Nein | Cursor für Paginierung (bevorzugt gegenüber seitenbasierter Paginierung) |
|
||
|
||
#### Ausgabe
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `companies` | array | Array von Unternehmensobjekten |
|
||
|
||
### `intercom_get_conversation`
|
||
|
||
Eine einzelne Konversation anhand der ID von Intercom abrufen
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `conversationId` | string | Ja | Konversations-ID zum Abrufen |
|
||
| `display_as` | string | Nein | Auf "plaintext" setzen, um Nachrichten als reinen Text abzurufen |
|
||
| `include_translations` | boolean | Nein | Wenn true, werden Konversationsteile in die erkannte Sprache der Konversation übersetzt |
|
||
|
||
#### Ausgabe
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `conversation` | object | Konversationsobjekt |
|
||
|
||
### `intercom_list_conversations`
|
||
|
||
Alle Konversationen von Intercom mit Paginierungsunterstützung auflisten
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `per_page` | number | Nein | Anzahl der Ergebnisse pro Seite (max: 150) |
|
||
| `starting_after` | string | Nein | Cursor für Paginierung |
|
||
| `sort` | string | Nein | Feld zum Sortieren (z. B. "waiting_since", "updated_at", "created_at") |
|
||
| `order` | string | Nein | Sortierreihenfolge: "asc" (aufsteigend) oder "desc" (absteigend) |
|
||
|
||
#### Ausgabe
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `conversations` | array | Array von Konversationsobjekten |
|
||
|
||
### `intercom_reply_conversation`
|
||
|
||
Als Administrator auf eine Konversation in Intercom antworten
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `conversationId` | string | Ja | Konversations-ID zum Antworten |
|
||
| `message_type` | string | Ja | Nachrichtentyp: "comment" oder "note" |
|
||
| `body` | string | Ja | Der Textinhalt der Antwort |
|
||
| `admin_id` | string | Nein | Die ID des Administrators, der die Antwort verfasst. Falls nicht angegeben, wird ein Standard-Administrator (Operator/Fin) verwendet. |
|
||
| `attachment_urls` | string | Nein | Kommagetrennte Liste von Bild-URLs (max. 10) |
|
||
| `created_at` | number | Nein | Unix-Zeitstempel für den Zeitpunkt der Erstellung der Antwort. Falls nicht angegeben, wird die aktuelle Zeit verwendet. |
|
||
|
||
#### Ausgabe
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `conversation` | object | Aktualisiertes Konversationsobjekt |
|
||
|
||
### `intercom_search_conversations`
|
||
|
||
Nach Konversationen in Intercom mit einer Abfrage suchen
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `query` | string | Ja | Suchabfrage als JSON-Objekt |
|
||
| `per_page` | number | Nein | Anzahl der Ergebnisse pro Seite \(max: 150\) |
|
||
| `starting_after` | string | Nein | Cursor für Paginierung |
|
||
| `sort_field` | string | Nein | Feld, nach dem sortiert werden soll \(z. B. "created_at", "updated_at"\) |
|
||
| `sort_order` | string | Nein | Sortierreihenfolge: "ascending" oder "descending" |
|
||
|
||
#### Ausgabe
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `conversations` | array | Array von übereinstimmenden Konversationsobjekten |
|
||
|
||
### `intercom_create_ticket`
|
||
|
||
Ein neues Ticket in Intercom erstellen
|
||
|
||
#### Eingabe
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `ticket_type_id` | string | Ja | Die ID des Ticket-Typs |
|
||
| `contacts` | string | Ja | JSON-Array von Kontaktkennungen \(z. B. \[\{"id": "contact_id"\}\]\) |
|
||
| `ticket_attributes` | string | Ja | JSON-Objekt mit Ticket-Attributen einschließlich _default_title_ und _default_description_ |
|
||
| `company_id` | string | Nein | Unternehmens-ID, mit der das Ticket verknüpft werden soll |
|
||
| `created_at` | number | Nein | Unix-Zeitstempel für den Zeitpunkt der Ticket-Erstellung. Wenn nicht angegeben, wird die aktuelle Zeit verwendet. |
|
||
| `conversation_to_link_id` | string | Nein | ID einer vorhandenen Konversation, die mit diesem Ticket verknüpft werden soll |
|
||
| `disable_notifications` | boolean | Nein | Wenn true, werden Benachrichtigungen bei der Ticket-Erstellung unterdrückt |
|
||
|
||
#### Output
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `ticket` | object | Erstelltes Ticket-Objekt |
|
||
|
||
### `intercom_get_ticket`
|
||
|
||
Ein einzelnes Ticket anhand der ID von Intercom abrufen
|
||
|
||
#### Input
|
||
|
||
| Parameter | Type | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `ticketId` | string | Ja | Ticket-ID zum Abrufen |
|
||
|
||
#### Output
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `ticket` | object | Ticket-Objekt |
|
||
|
||
### `intercom_create_message`
|
||
|
||
Eine neue vom Administrator initiierte Nachricht in Intercom erstellen und senden
|
||
|
||
#### Input
|
||
|
||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `message_type` | string | Ja | Nachrichtentyp: "inapp" für In-App-Nachrichten oder "email" für E-Mail-Nachrichten |
|
||
| `template` | string | Ja | Nachrichtenvorlagenstil: "plain" für einfachen Text oder "personal" für personalisierten Stil |
|
||
| `subject` | string | Nein | Der Betreff der Nachricht \(für E-Mail-Typ\) |
|
||
| `body` | string | Ja | Der Inhalt der Nachricht |
|
||
| `from_type` | string | Ja | Absendertyp: "admin" |
|
||
| `from_id` | string | Ja | Die ID des Administrators, der die Nachricht sendet |
|
||
| `to_type` | string | Ja | Empfängertyp: "contact" |
|
||
| `to_id` | string | Ja | Die ID des Kontakts, der die Nachricht empfängt |
|
||
| `created_at` | number | Nein | Unix-Zeitstempel für den Zeitpunkt der Nachrichtenerstellung. Wenn nicht angegeben, wird die aktuelle Zeit verwendet. |
|
||
|
||
#### Output
|
||
|
||
| Parameter | Typ | Beschreibung |
|
||
| --------- | ---- | ----------- |
|
||
| `message` | object | Erstelltes Nachrichtenobjekt |
|
||
|
||
## Notizen
|
||
|
||
- Kategorie: `tools`
|
||
- Typ: `intercom`
|