Getting Started

설치

Capgo의 AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 기능을 추가하려면 다음 명령어를 사용하세요.

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

다음과 같은 프롬프트를 사용하세요.

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

만약 Manual Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래에 플랫폼에 따라 설명된 지침을 따르세요.

bun add @capgo/capacitor-crisp
bunx cap sync

수입

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

현재 사용자 세션에 고유한 토큰 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

__CAPGO_KEEP_2__

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

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

setString

__CAPGO_KEEP_4__

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

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

sendMessage

__CAPGO_KEEP_6__

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

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

setSegment

__CAPGO_KEEP_8__

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

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

reset

__CAPGO_KEEP_2__

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

await CapacitorCrisp.reset();

__CAPGO_KEEP_3__

ConfigureOptions

__CAPGO_KEEP_5__

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

__CAPGO_KEEP_7__

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

원본

이 페이지는 플러그인의 src/definitions.ts업스트림에서 API이 변경되면 다시 싱크를 실행하세요.

시작하기

이러한 기능을 사용하는 경우 시작하기 대시보드와 API를 계획하고 운영하기 위해 native capability을 사용하는 경우 @capgo/capacitor-crisp Using @capgo/capacitor-crisp API 개요 API 개요에 대한 구현 세부 사항에 대해 소개 __CAPGO_KEEP_0__ 키에 대한 구현 세부 사항에 대해 API 키 API 키 및 장치에 대한 구현 세부 사항에 대해 장치 __CAPGO_KEEP_0__ 장치에 대한 구현 세부 사항에 대해