github/sim
1
0
Fork 0
mirror of https://github.com/simstudioai/sim.git synced 2026-02-17 09:52:38 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
f5640b2919fdce6feb9d17c9bf9301cb31cc05d7
sim/apps/docs/content/docs/de/tools/intercom.mdx
cherkanov_art d1d43b27bd feat(i18n): change lockfile (#3216) 
* fix: update i18n.lock

* feat(docs): enhance documentation with new sections on file handling, form deployment, quick reference, agent skills, and A2A integration
2026-02-16 00:00:12 -08:00

728 lines
31 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
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`
Erstellen und senden Sie eine neue, vom Administrator initiierte Nachricht in Intercom. Gibt nur API-konforme Felder zurück.
#### Eingabe
| 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 erhält |
| `created_at` | number | Nein | Unix-Zeitstempel für den Zeitpunkt der Nachrichtenerstellung. Wenn nicht angegeben, wird die aktuelle Zeit verwendet. |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `message` | object | Erstelltes Nachrichtenobjekt |
| ↳ `id` | string | Eindeutige Kennung für die Nachricht |
| ↳ `type` | string | Objekttyp \(message\) |
| ↳ `created_at` | number | Unix-Zeitstempel der Nachrichtenerstellung |
| ↳ `body` | string | Inhalt der Nachricht |
| ↳ `message_type` | string | Typ der Nachricht \(in_app oder email\) |
| ↳ `conversation_id` | string | ID der erstellten Konversation |
| ↳ `owner` | object | Eigentümer der Nachricht |
| `messageId` | string | ID der erstellten Nachricht |
| `success` | boolean | Status des Vorgangserfolgs |
### `intercom_list_admins`
Eine Liste aller Administratoren für den Workspace abrufen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `admins` | array | Array von Administrator-Objekten |
| ↳ `id` | string | Eindeutige Kennung für den Administrator |
| ↳ `type` | string | Objekttyp \(admin\) |
| ↳ `name` | string | Name des Administrators |
| ↳ `email` | string | E-Mail des Administrators |
| ↳ `job_title` | string | Berufsbezeichnung des Administrators |
| ↳ `away_mode_enabled` | boolean | Ob der Administrator im Abwesenheitsmodus ist |
| ↳ `away_mode_reassign` | boolean | Ob Konversationen bei Abwesenheit neu zugewiesen werden sollen |
| ↳ `has_inbox_seat` | boolean | Ob der Administrator einen bezahlten Posteingangsplatz hat |
| ↳ `team_ids` | array | Liste der Team-IDs, denen der Administrator angehört |
| ↳ `avatar` | object | Avatar-Informationen |
| ↳ `email_verified` | boolean | Ob die E-Mail verifiziert ist |
| `type` | string | Objekttyp \(admin.list\) |
### `intercom_close_conversation`
Eine Konversation in Intercom schließen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `conversationId` | string | Ja | Die ID der zu schließenden Konversation |
| `admin_id` | string | Ja | Die ID des Administrators, der die Aktion ausführt |
| `body` | string | Nein | Optionale Abschlussnachricht, die zur Konversation hinzugefügt werden soll |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `conversation` | object | Das geschlossene Konversationsobjekt |
| ↳ `id` | string | Eindeutige Kennung für die Konversation |
| ↳ `type` | string | Objekttyp \(conversation\) |
| ↳ `state` | string | Status der Konversation \(closed\) |
| ↳ `open` | boolean | Ob die Konversation offen ist \(false\) |
| ↳ `read` | boolean | Ob die Konversation gelesen wurde |
| ↳ `created_at` | number | Unix-Zeitstempel, wann die Konversation erstellt wurde |
| ↳ `updated_at` | number | Unix-Zeitstempel, wann die Konversation zuletzt aktualisiert wurde |
| `conversationId` | string | ID der geschlossenen Konversation |
| `state` | string | Status der Konversation \(closed\) |
### `intercom_open_conversation`
Eine geschlossene oder schlummernde Konversation in Intercom öffnen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `conversationId` | string | Ja | Die ID der zu öffnenden Konversation |
| `admin_id` | string | Ja | Die ID des Administrators, der die Aktion ausführt |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `conversation` | object | Das geöffnete Konversationsobjekt |
| ↳ `id` | string | Eindeutige Kennung für die Konversation |
| ↳ `type` | string | Objekttyp \(conversation\) |
| ↳ `state` | string | Status der Konversation \(open\) |
| ↳ `open` | boolean | Ob die Konversation offen ist \(true\) |
| ↳ `read` | boolean | Ob die Konversation gelesen wurde |
| ↳ `created_at` | number | Unix-Zeitstempel, wann die Konversation erstellt wurde |
| ↳ `updated_at` | number | Unix-Zeitstempel, wann die Konversation zuletzt aktualisiert wurde |
| `conversationId` | string | ID der geöffneten Konversation |
| `state` | string | Status der Konversation \(open\) |
### `intercom_snooze_conversation`
Eine Konversation schlummern lassen, um sie zu einem späteren Zeitpunkt wieder zu öffnen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `conversationId` | string | Ja | Die ID der Konversation, die schlummern soll |
| `admin_id` | string | Ja | Die ID des Administrators, der die Aktion ausführt |
| `snoozed_until` | number | Ja | Unix-Zeitstempel für den Zeitpunkt, zu dem die Konversation wieder geöffnet werden soll |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `conversation` | object | Das schlummernde Konversationsobjekt |
| ↳ `id` | string | Eindeutige Kennung für die Konversation |
| ↳ `type` | string | Objekttyp \(conversation\) |
| ↳ `state` | string | Status der Konversation \(snoozed\) |
| ↳ `open` | boolean | Ob die Konversation offen ist |
| ↳ `snoozed_until` | number | Unix-Zeitstempel, wann die Konversation wieder geöffnet wird |
| ↳ `created_at` | number | Unix-Zeitstempel, wann die Konversation erstellt wurde |
| ↳ `updated_at` | number | Unix-Zeitstempel, wann die Konversation zuletzt aktualisiert wurde |
| `conversationId` | string | ID der schlummernden Konversation |
| `state` | string | Status der Konversation \(snoozed\) |
| `snoozed_until` | number | Unix-Zeitstempel, wann die Konversation wieder geöffnet wird |
### `intercom_assign_conversation`
Eine Konversation einem Administrator oder Team in Intercom zuweisen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `conversationId` | string | Ja | Die ID der Konversation, die zugewiesen werden soll |
| `admin_id` | string | Ja | Die ID des Administrators, der die Zuweisung durchführt |
| `assignee_id` | string | Ja | Die ID des Administrators oder Teams, dem die Konversation zugewiesen werden soll. Auf "0" setzen, um die Zuweisung aufzuheben. |
| `body` | string | Nein | Optionale Nachricht, die beim Zuweisen hinzugefügt werden kann \(z. B. "Übergabe an das Support-Team"\) |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `conversation` | object | Das zugewiesene Konversationsobjekt |
| ↳ `id` | string | Eindeutige Kennung für die Konversation |
| ↳ `type` | string | Objekttyp \(conversation\) |
| ↳ `state` | string | Status der Konversation |
| ↳ `open` | boolean | Ob die Konversation offen ist |
| ↳ `admin_assignee_id` | number | ID des zugewiesenen Administrators |
| ↳ `team_assignee_id` | string | ID des zugewiesenen Teams |
| ↳ `created_at` | number | Unix-Zeitstempel, wann die Konversation erstellt wurde |
| ↳ `updated_at` | number | Unix-Zeitstempel, wann die Konversation zuletzt aktualisiert wurde |
| `conversationId` | string | ID der zugewiesenen Konversation |
| `admin_assignee_id` | number | ID des zugewiesenen Administrators |
| `team_assignee_id` | string | ID des zugewiesenen Teams |
### `intercom_list_tags`
Eine Liste aller Tags im Workspace abrufen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `tags` | array | Array von Tag-Objekten |
| ↳ `id` | string | Eindeutige Kennung für den Tag |
| ↳ `type` | string | Objekttyp \(tag\) |
| ↳ `name` | string | Name des Tags |
| `type` | string | Objekttyp \(list\) |
### `intercom_create_tag`
Ein neues Tag erstellen oder einen bestehenden Tag-Namen aktualisieren
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `name` | string | Ja | Der Name des Tags. Erstellt ein neues Tag, falls nicht gefunden, oder aktualisiert den Namen, wenn eine ID angegeben ist. |
| `id` | string | Nein | Die ID eines bestehenden Tags zum Aktualisieren. Weglassen, um ein neues Tag zu erstellen. |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `id` | string | Eindeutige Kennung für das Tag |
| `name` | string | Name des Tags |
| `type` | string | Objekttyp \(tag\) |
### `intercom_tag_contact`
Einem bestimmten Kontakt ein Tag hinzufügen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `contactId` | string | Ja | Die ID des Kontakts, der getaggt werden soll |
| `tagId` | string | Ja | Die ID des anzuwendenden Tags |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `id` | string | Eindeutige Kennung für das Tag |
| `name` | string | Name des Tags |
| `type` | string | Objekttyp \(tag\) |
### `intercom_untag_contact`
Ein Tag von einem bestimmten Kontakt entfernen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `contactId` | string | Ja | Die ID des Kontakts, dessen Tag entfernt werden soll |
| `tagId` | string | Ja | Die ID des zu entfernenden Tags |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `id` | string | Eindeutige Kennung für das entfernte Tag |
| `name` | string | Name des entfernten Tags |
| `type` | string | Objekttyp \(tag\) |
### `intercom_tag_conversation`
Ein Tag zu einer bestimmten Konversation hinzufügen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `conversationId` | string | Ja | Die ID der zu markierenden Konversation |
| `tagId` | string | Ja | Die ID des anzuwendenden Tags |
| `admin_id` | string | Ja | Die ID des Administrators, der das Tag anwendet |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `id` | string | Eindeutige Kennung für das Tag |
| `name` | string | Name des Tags |
| `type` | string | Objekttyp \(tag\) |
### `intercom_create_note`
Eine Notiz zu einem bestimmten Kontakt hinzufügen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `contactId` | string | Ja | Die ID des Kontakts, zu dem die Notiz hinzugefügt werden soll |
| `body` | string | Ja | Der Textinhalt der Notiz |
| `admin_id` | string | Nein | Die ID des Administrators, der die Notiz erstellt |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `id` | string | Eindeutige Kennung für die Notiz |
| `body` | string | Der Textinhalt der Notiz |
| `created_at` | number | Unix-Zeitstempel, wann die Notiz erstellt wurde |
| `type` | string | Objekttyp \(note\) |
| `author` | object | Der Administrator, der die Notiz erstellt hat |
| ↳ `type` | string | Autorentyp \(admin\) |
| ↳ `id` | string | Autoren-ID |
| ↳ `name` | string | Autorenname |
| ↳ `email` | string | Autoren-E-Mail |
| `contact` | object | Der Kontakt, für den die Notiz erstellt wurde |
| ↳ `type` | string | Kontakttyp |
| ↳ `id` | string | Kontakt-ID |
### `intercom_create_event`
Ein benutzerdefiniertes Ereignis für einen Kontakt in Intercom verfolgen
#### Input
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `event_name` | string | Ja | Der Name des Ereignisses \(z. B. "order-completed"\). Verwenden Sie das Format Verb-Nomen in der Vergangenheitsform für bessere Lesbarkeit. |
| `created_at` | number | Nein | Unix-Zeitstempel für den Zeitpunkt, zu dem das Ereignis aufgetreten ist. Wird dringend empfohlen für Eindeutigkeit. |
| `user_id` | string | Nein | Ihre Kennung für den Benutzer \(external_id\) |
| `email` | string | Nein | E-Mail-Adresse des Benutzers. Verwenden Sie dies nur, wenn Ihre App E-Mail zur eindeutigen Identifizierung von Benutzern verwendet. |
| `id` | string | Nein | Die Intercom-Kontakt-ID |
| `metadata` | string | Nein | JSON-Objekt mit bis zu 10 Metadaten-Schlüssel-Wert-Paaren über das Ereignis \(z. B. \{"order_value": 99.99\}\) |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `accepted` | boolean | Ob das Ereignis akzeptiert wurde \(202 Accepted\) |
### `intercom_attach_contact_to_company`
Einen Kontakt mit einem Unternehmen in Intercom verknüpfen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `contactId` | string | Ja | Die ID des Kontakts, der mit dem Unternehmen verknüpft werden soll |
| `companyId` | string | Ja | Die ID des Unternehmens, mit dem der Kontakt verknüpft werden soll |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `company` | object | Das Unternehmensobjekt, mit dem der Kontakt verknüpft wurde |
| ↳ `id` | string | Eindeutige Kennung für das Unternehmen |
| ↳ `type` | string | Objekttyp \(company\) |
| ↳ `company_id` | string | Die von Ihnen definierte company_id |
| ↳ `name` | string | Name des Unternehmens |
| ↳ `created_at` | number | Unix-Zeitstempel, wann das Unternehmen erstellt wurde |
| ↳ `updated_at` | number | Unix-Zeitstempel, wann das Unternehmen aktualisiert wurde |
| ↳ `user_count` | number | Anzahl der Benutzer im Unternehmen |
| ↳ `session_count` | number | Anzahl der Sitzungen |
| ↳ `monthly_spend` | number | Monatlicher Umsatzbetrag |
| ↳ `plan` | object | Details zum Unternehmensplan |
| `companyId` | string | ID des Unternehmens |
| `name` | string | Name des Unternehmens |
### `intercom_detach_contact_from_company`
Einen Kontakt von einem Unternehmen in Intercom entfernen
#### Eingabe
| Parameter | Typ | Erforderlich | Beschreibung |
| --------- | ---- | -------- | ----------- |
| `contactId` | string | Ja | Die ID des Kontakts, der vom Unternehmen getrennt werden soll |
| `companyId` | string | Ja | Die ID des Unternehmens, von dem der Kontakt getrennt werden soll |
#### Ausgabe
| Parameter | Typ | Beschreibung |
| --------- | ---- | ----------- |
| `company` | object | Das Unternehmensobjekt, von dem der Kontakt getrennt wurde |
| ↳ `id` | string | Eindeutige Kennung für das Unternehmen |
| ↳ `type` | string | Objekttyp \(company\) |
| ↳ `company_id` | string | Die von Ihnen definierte company_id |
| ↳ `name` | string | Name des Unternehmens |
| `companyId` | string | ID des Unternehmens |
| `name` | string | Name des Unternehmens |
Reference in New Issue View Git Blame Copy Permalink