上下文: Capgo营销网站。角色: 网站副本句子。见于: 组件doc/SignupCta.astro, 组件Hero.astro。消息键`hero_subtitle_v2` (Hero Subtitle V2)。

context

您可以使用我们的AI辅助设置来安装插件。将Capgo技能添加到您的AI工具中，使用以下命令：

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.

如果您prefer手动设置，安装插件并运行以下命令，然后遵循以下平台特定的说明：

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 CapacitorCrisp.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({ tokenID: 'token-id-123' });

setUser

为当前会话设置用户信息。 更新支持代理可见的用户资料。

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

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

pushEvent

推送一个自定义事件到Crisp。 有助于跟踪用户行为和活动。

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

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

setCompany

设置公司信息为当前会话。 将用户与Crisp中的公司相关联。

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

await CapacitorCrisp.setCompany({
  name: 'Acme Corp',
  url: 'https://acme.com',
  employment: ['CEO', 'Executive'],
  geolocation: ['USA', 'San Francisco']
});

setInt

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

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

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

setString

设置自定义字符串数据字段。 与用户会话相关联的文本数据。

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

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

sendMessage

发送消息

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

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

setSegment

设置用户段

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

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

reset

重置

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

await CapacitorCrisp.reset();

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

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 事件的可用颜色，用于在 Crisp 控制台中可视化分类事件。

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

真实来源

此页面由插件的 src/definitions.ts重新同步公共 API 时，重新运行同步。

继续从 Getting Started

如果您正在使用 开始使用 来规划仪表板和API操作，连接它与 使用@capgo/capacitor-crisp 为在使用@capgo/capacitor-crisp中native能力 API概述 为在API概述中的实现细节 介绍 为在介绍中的实现细节 API密钥 为在API密钥中的实现细节 设备 查看设备的实现细节