开始使用

安装

您可以使用我们的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.

如果您更喜欢手动设置，请运行以下命令并按照以下平台特定的说明进行操作：

bun add @capgo/capacitor-crisp
bunx cap sync

导入

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

API 简介

configure

配置 Crisp 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

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

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

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

真实来源

重新同步公共 __CAPGO_KEEP_0__ 时，重新运行上游的同步。 src/definitions.ts. Re-run the sync when the public API changes upstream.

继续从开始

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