Getting Started

Instalar

bun add @capgo/capacitor-crisp
bunx cap sync

Importar

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

API Resumen

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

Abrir la ventana de chat de Crisp. Muestra la interfaz de chat al usuario.

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

await CapacitorCrisp.openMessenger();

setTokenID

Establecer un ID de token único para la sesión del usuario actual. Se utiliza para identificar y restaurar conversaciones anteriores.

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

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

setUser

Establecer información de usuario para la sesión actual. Actualiza el perfil de usuario visible para los agentes de soporte.

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

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

pushEvent

Enviar un evento personalizado a Crisp. Útil para rastrear acciones y comportamiento del usuario.

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

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

setCompany

Establecer información de la compañía para la sesión actual. Asocia al usuario con una compañía en 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

Establecer un campo de datos entero personalizado. Almacena datos numéricos asociados con la sesión del usuario.

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

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

setString

Establecer un campo de datos de cadena personalizado. Almacena datos de texto asociados con la sesión del usuario.

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

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

sendMessage

Enviar un mensaje del usuario al chat. Enviar un mensaje de manera programática como si el usuario lo hubiera escrito.

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

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

setSegment

Establecer un segmento de usuario para la segmentación y organización. Se utiliza para categorizar a los usuarios en la consola de Crisp.

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

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

reset

Reiniciar la sesión de Crisp. Elimina todos los datos de usuario y comienza una nueva sesión. Útil cuando el usuario se desloguea.

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

await CapacitorCrisp.reset();

Referencia de tipos

ConfigureOptions

Configuración para inicializar 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

Disponibles colores para eventos Crisp. Usados para categorizar visualmente eventos en la consola de Crisp.

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

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.tsRe-ejecutar la sincronización cuando los cambios públicos API cambian en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar operaciones de dashboard y API , conecta con Usando @capgo/capacitor-crisp para la capacidad nativa en Usando @capgo/capacitor-crisp, API Resumen para el detalle de implementación en API Resumen, Introducción para el detalle de implementación en Introducción, API Llaves para el detalle de implementación en API Llaves, y Dispositivos para el detalle de implementación en Dispositivos.