Einstieg

Installieren

bun add @capgo/capacitor-crisp
bunx cap sync

Importieren

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

API Übersicht

configure

Konfigurieren Sie die Crisp SDK mit Ihrer Website-ID. Muss vor der Verwendung von anderen Methoden aufgerufen werden.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.configure({ websiteID: 'YOUR_WEBSITE_ID' });

openMessenger

Öffnen Sie das Chatfenster von Crisp. Zeigt dem Benutzer das Chatinterface.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.openMessenger();

setTokenID

Setzen Sie eine eindeutige Token-ID für die aktuelle Benutzersitzung. Wird verwendet, um vorherige Gespräche zu identifizieren und wiederherzustellen.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.setTokenID({} as { tokenID: string });

setUser

Setzen Sie Benutzerinformationen für die aktuelle Sitzung. Aktualisiert das Benutzerprofil, das den Supportagenten sichtbar ist.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setUser({
  nickname: 'John Doe',
  email: 'john@example.com',
  phone: '+1234567890'
});

pushEvent

Senden Sie ein benutzerdefiniertes Ereignis an Crisp. Wird verwendet, um Benutzeraktionen und Verhalten zu tracken.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.pushEvent({
  name: 'completed_purchase',
  color: 'green'
});

setCompany

Firmeninformationen für die aktuelle Sitzung festlegen. Der Benutzer wird mit einer Firma in Crisp verbunden.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setCompany({
  name: 'Acme Corp',
  url: 'https://acme.com',
  employment: ['CEO', 'Executive'],
  geolocation: ['USA', 'San Francisco']
});

setInt

Eine benutzerdefinierte Ganzzahl-Datenfeld festlegen. Zahlendaten, die mit der Benutzersitzung verbunden sind, speichern.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setInt({ key: 'user_level', value: 42 });

setString

Ein benutzerdefiniertes Zeichenfolgen-Datenfeld festlegen. Textdaten, die mit der Benutzersitzung verbunden sind, speichern.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setString({ key: 'subscription_tier', value: 'premium' });

sendMessage

Ein Nachrichten von dem Benutzer an den Chat senden. Programmatisch eine Nachricht senden, als ob der Benutzer sie getippt hätte.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.sendMessage({ value: 'Hello, I need help!' });

setSegment

Legen Sie einen Benutzersegment für die Zielgruppen und Organisation fest. Wird verwendet, um Benutzer in der Crisp-Dashboard-Kategorisierung zu klassifizieren.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setSegment({ segment: 'premium-users' });

reset

Richten Sie die Crisp-Sitzung neu ein. Löscht alle Benutzerdaten und startet eine frische Sitzung. Wird nützlich, wenn sich der Benutzer abmeldet.

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.reset();

Typenverweis

ConfigureOptions

Konfiguration für die Initialisierung von Crisp.

export interface ConfigureOptions {
  /**
   * Your Crisp website ID from dashboard.
   */
  websiteID: string;
  /**
   * Optional - Locale to force in the Crisp chat widget (ISO 639-1), eg. `en`, `fr`, `es`.
   * Web + Android: overrides the runtime locale. iOS follows the device/app locale.
   */
  locale?: string;
  /**
   * Optional - Unique token identifier for the user session continuity.
   */
  tokenID?: string;
}

eventColor

Verfügbare Farben für Crisp-Ereignisse. Wird verwendet, um Ereignisse in der Crisp-Dashboard visuell zu kategorisieren.

export type eventColor =
  | 'red'
  | 'orange'
  | 'yellow'
  | 'green'
  | 'blue'
  | 'purple'
  | 'pink'
  | 'brown'
  | 'grey'
  | 'black';

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API upstream ändert, führen Sie die Synchronisation erneut durch.