Empezar

Instalar

Puedes utilizar nuestra configuración asistida por inteligencia artificial para instalar el complemento. Agrega las Capgo habilidades a tu herramienta de inteligencia artificial utilizando el siguiente comando:

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

Luego utiliza el siguiente prompt:

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

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-crisp
bunx cap sync

Importar

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

API Resumen

configure

Configura el Crisp SDK con tu ID de sitio web. Debes llamar a este método antes de utilizar cualquier otro método.

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

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

openMessenger

Abre la ventana de chat de mensajero de Crisp. Muestra la interfaz de chat al usuario.

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

await CapacitorCrisp.openMessenger();

setTokenID

Establece un ID de token único para la sesión de 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 empresa para la sesión actual. Asocia al usuario con una empresa 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 de 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 a la conversación. 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. Borra todos los datos del usuario y comienza una nueva sesión. Útil cuando el usuario se desloguea.

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

await CapacitorCrisp.reset();

Referencia de tipo

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

Colores disponibles para eventos de Crisp. Se utilizan 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 a partir del plugin’s src/definitions.ts. Re-ejecutar la sincronización cuando los cambios públicos API cambien en la fuente original.

Sigue adelante desde Inicio

Si estás utilizando Inicio para planificar la consola y las operaciones de API, conecta con Usando @capgo/capacitor-crisp para la capacidad nativa en Usando @capgo/capacitor-crisp Resumen de API para el detalle de implementación en Resumen de API Introducción para el detalle de implementación en Introducción Claves de API para los detalles de implementación en API Claves, y Dispositivos para los detalles de implementación en Dispositivos.