Iniziato alla Guida

Installa

bun add @capgo/capacitor-crisp
bunx cap sync

Importa

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

API Panoramica

configure

Configure the Crisp SDK with your website ID. Must be called before using any other methods.

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

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

openMessenger

Apri la finestra di chat di messaggistica Crisp. Mostra l'interfaccia di chat all'utente.

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

await CapacitorCrisp.openMessenger();

setTokenID

Imposta un ID token univoco per la sessione corrente dell'utente. Usato per identificare e ripristinare conversazioni precedenti.

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

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

setUser

Imposta informazioni utente per la sessione corrente. Aggiorna il profilo utente visibile agli agenti di supporto.

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

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

pushEvent

Inoltra un evento personalizzato a Crisp. Utile per tracciare azioni e comportamenti dell'utente.

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

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

setCompany

Imposta le informazioni dell'azienda per la sessione corrente. Associa l'utente ad un'azienda in Crisp.

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

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

setInt

Imposta un campo di dati intero personalizzato. Memorizza i dati numerici associati alla sessione dell'utente.

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

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

setString

Imposta un campo di dati di testo personalizzato. Memorizza i dati di testo associati alla sessione dell'utente.

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

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

sendMessage

Invia un messaggio dall'utente alla chat. Invia un messaggio in modo programmatico come se l'utente lo avesse digitato.

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

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

setSegment

Imposta un segmento di utenti per la targeting e l'organizzazione. Usato per categorizzare gli utenti nella dashboard di Crisp.

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

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

reset

Ripristina la sessione di Crisp. Svuota tutti i dati degli utenti e inizia una nuova sessione. Utile quando l'utente si disconnette.

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

await CapacitorCrisp.reset();

Riferimento di tipo

ConfigureOptions

Configurazione per l'inizializzazione di 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

Colori disponibili per gli eventi Crisp. Utilizzati per categorizzare visivamente gli eventi nel dashboard Crisp.

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

Fonte di Verità

Questa pagina è generata dal plugin’s src/definitions.ts. Riavvia la sincronizzazione quando le informazioni pubbliche API cambiano in fase di sviluppo.

Continua da dove si è iniziato con Getting Started

Se si utilizza Getting Started per pianificare dashboard e API operazioni, connettilo con Utilizzando @capgo/capacitor-crisp per la capacità nativa in Utilizzo di @capgo/capacitor-crisp, API Panoramica per il dettaglio di implementazione in API Panoramica, Introduzione per il dettaglio di implementazione in Introduzione, API Chiavi per il dettaglio di implementazione in API Chiavi, e Dispositivi per il dettaglio di implementazione in Dispositivi.