Démarrage

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

bun add @capgo/capacitor-crisp
bunx cap sync

Importer

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

API Présentation

configure

Configurez le Crisp SDK avec votre ID de site. Doit être appelé avant d'utiliser d'autres méthodes.

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

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

openMessenger

Ouvrez la fenêtre de chat Crisp. Affiche l'interface de chat à l'utilisateur.

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

await CapacitorCrisp.openMessenger();

setTokenID

Définissez un ID de jeton unique pour la session de l'utilisateur actuel. Utilisé pour identifier et restaurer les conversations précédentes.

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

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

setUser

Définir les informations de l'utilisateur pour la session actuelle. Mise à jour du profil de l'utilisateur visible pour les agents de support.

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

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

pushEvent

Envoyer un événement personnalisé à Crisp. Utile pour suivre les actions et le comportement de l'utilisateur.

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

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

setCompany

Définir les informations de la société pour la session actuelle. Associe l'utilisateur à une société dans 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

Définir un champ de données entier personnalisé. Stocke des données numériques associées à la session de l'utilisateur.

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

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

setString

Configurez un champ de données de chaîne personnalisé. Stocke les données de texte associées à la session de l'utilisateur.

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

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

sendMessage

Envoyer un message de l'utilisateur à la conversation. Envoie un message de manière programmée comme si l'utilisateur l'avait tapé.

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

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

setSegment

Configurez un segment d'utilisateur pour la ciblisation et l'organisation. Utilisé pour classer les utilisateurs dans l'interface de dashboard Crisp.

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

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

reset

Réinitialiser la session Crisp. Supprime toutes les données de l'utilisateur et démarre une nouvelle session. Utile lorsqu'un utilisateur se déconnecte.

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

await CapacitorCrisp.reset();

Référence de type

ConfigureOptions

Configuration pour l'initialisation de 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

Couleurs disponibles pour les événements de Crisp. Utilisées pour catégoriser visuellement les événements dans le tableau de bord de Crisp.

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

Source de vérité

Re-run la synchronisation lorsque les modifications publiques __CAPGO_KEEP_0__ sont détectées en amont. src/definitions.ts. Re-run the sync when the public API changes upstream.

Documentation de Crisp

Si vous utilisez Getting Started pour planifier votre tableau de bord et les opérations API, connectez-le avec Utilisez @capgo/capacitor-crisp pour la capacité native dans Utilisez @capgo/capacitor-crisp, API Vue d'ensemble pour les détails d'implémentation dans API Vue d'ensemble, Introduction pour les détails d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans API Clés, et Appareils pour le détail d'implémentation dans Appareils.