시작하기

설치하기

bun add @capgo/capacitor-crisp
bunx cap sync

import

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

API 개요

configure

SDK을 사용하여 웹사이트 ID를 설정하세요. 이 메서드를 사용하기 전에 반드시 호출해야 합니다.

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

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

openMessenger

사용자에게 대화 인터페이스를 표시하는 Crisp 메신저 채팅 창을 열어주세요.

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

await CapacitorCrisp.openMessenger();

setTokenID

__CAPGO_KEEP_0__을 사용하여 현재 사용자 세션에 고유한 토큰 ID를 설정하세요. 이 토큰 ID를 사용하여 이전 대화를 복원할 수 있습니다.

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

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

setUser

현재 세션에 사용자 정보를 설정합니다. 지원 담당자에게 보이는 사용자 프로필을 업데이트합니다.

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

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

pushEvent

사용자 행동과 행동을 추적하기 위해 Crisp에 커스텀 이벤트를 푸시합니다.

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

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

setCompany

현재 세션에 회사 정보를 설정합니다. 사용자를 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

사용자 세션에 커스텀 정수 데이터 필드를 설정합니다. 사용자 세션과 관련된 숫자 데이터를 저장합니다.

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

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

setString

사용자 세션에 대한 문자열 데이터 필드를 사용자 지정합니다. 사용자 세션과 관련된 텍스트 데이터를 저장합니다.

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

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

sendMessage

사용자가 채팅에서 메시지를 입력한 것처럼 메시지를 프로그램적으로 전송합니다.

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

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

setSegment

대상과 조직을 위해 사용자 세그먼트를 설정합니다. Crissp 대시보드에서 사용자를 분류합니다.

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

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

reset

사용자 데이터를 모두 삭제하고 새로운 세션을 시작합니다. 사용자가 로그아웃 할 때 유용합니다.

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

await CapacitorCrisp.reset();

타입 참조

ConfigureOptions

크립 초기화에 대한 구성

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

크립 이벤트에 사용되는 색상. 크립 대시보드에서 이벤트를 시각적으로 분류하기 위해 사용됩니다.

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

진실의 근원

이 페이지는 플러그인의 생성된 페이지입니다. src/definitions.ts. upstream API이 변경될 때 다시 동기화 하세요.