Per iniziare

Installa

Puoi usare il nostro setup assistito dall'IA per installare il plugin. Aggiungi le skill Capgo al tuo strumento di IA usando il seguente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Poi usa il seguente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-crisp` plugin in my project.

Se preferisci la configurazione manuale, installa il plugin eseguendo questi comandi e segui le istruzioni specifiche per piattaforma qui sotto:

bun add @capgo/capacitor-crisp
bunx cap sync

Importa

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

Avvio rapido

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

await CapacitorCrisp.configure({ websiteID: 'your-website-id' });
await CapacitorCrisp.setUser({ nickname: 'Ada', email: 'ada@example.com' });
await CapacitorCrisp.openMessenger();

Esempio: push token

await CapacitorCrisp.registerPushToken({ token: apnsOrFcmToken });

Errori comuni

• Configura una sola volta: chiamata configure() prima di aprire la chat.
• Reset al logout: reset() cancella la sessione Crisp.
• Web: i push helper sono solo per mobile.

Panoramica API

configure

Configura il SDK di Crisp con il tuo ID sito. Deve essere chiamato prima di qualsiasi altro metodo.

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

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

openMessenger

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

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

await CapacitorCrisp.openMessenger();

setTokenID

Imposta un token ID univoco per la sessione utente corrente. Serve per identificare e ripristinare le conversazioni precedenti.

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

await CapacitorCrisp.setTokenID({ tokenID: 'token-id-123' });

setUser

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

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

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

pushEvent

Invia un evento personalizzato a Crisp. Utile per tracciare le azioni e il comportamento dell'utente.

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

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

setCompany

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

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

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

setInt

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

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

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

setString

Imposta un campo dati stringa personalizzato. Memorizza dati testuali associati alla sessione dell'utente.

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

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

sendMessage

Invia un messaggio dall'utente alla chat.\nInvia un messaggio programmaticamente come se fosse stato digitato dall'utente.

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

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

setSegment

Imposta un segmento utente per targeting e organizzazione. Utilizzato per categorizzare gli utenti nella dashboard di Crisp.

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

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

reset

Reset della sessione Crisp. Cancella tutti i dati utente e avvia una nuova sessione. Utile quando l'utente effettua il logout.

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

await CapacitorCrisp.reset();

Riferimento ai tipi

ConfigureOptions

Configurazione per inizializzare 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. Usati per categorizzare visivamente gli eventi nella dashboard di Crisp.

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

Fonte di verità

Questa pagina è generata dal src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Per iniziare per pianificare le operazioni della dashboard e di API, collegalo a Utilizzo di @capgo/capacitor-crisp per la funzionalità nativa in Using @capgo/capacitor-crisp, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi API per i dettagli di implementazione in Chiavi API, e Dispositivi per i dettagli di implementazione in Dispositivi.