开始使用

安装

bun add @capgo/capacitor-crisp
bunx cap sync

导入

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

API 概览

configure

使用您的网站 ID 配置 Crisp SDK。 必须在使用其他任何方法之前调用。

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

为用户会话设置自定义整数数据字段。 存储与用户会话相关的数字数据。

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

设置用户分段以进行目标和组织。 用于在 Crisp 控制台中分类用户。

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

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

reset

重置 Crisp 会话。 清除所有用户数据并开始一个新的会话。 在用户注销时有用。

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

await CapacitorCrisp.reset();

类型参考

ConfigureOptions

初始化 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

可用于在 Crisp 控制台中可视化分类事件的颜色

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

真实来源

本页面由插件生成 src/definitions.ts. 当 API 公共资源发生变化时，请重新同步。