跳转至正文

清晰 Capacitor 插件

将 Crisp 在线聊天和客户支持直接集成到你的移动应用中

安装

bun add @capgo/capacitor-crisp bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-crisp
  • pnpm add @capgo/capacitor-crisp
  • yarn add @capgo/capacitor-crisp

指南

如何在 Capacitor 中使用 Crisp

在设备上测试

下载 Capgo App,然后扫描二维码 code。

Crisp 插件预览二维码 code

使用 @capgo/capacitor-crisp

适用于 Capacitor 的 Crisp Chat SDK 插件。通过 Crisp.chat 提供实时聊天和客户支持功能。

安装

bun add @capgo/capacitor-crisp
bunx cap sync

插件暴露的内容

  • configure - 使用您的网站 ID 配置 Crisp SDK。必须在调用任何其他方法之前调用。
  • openMessenger - 打开 Crisp 聊天窗口。向用户显示聊天界面。
  • setTokenID - 为当前用户会话设置唯一的 token ID。用于识别并恢复之前的对话。
  • setUser - 设置当前会话的用户信息。更新客服人员可见的用户资料。

用法示例

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

为当前用户会话设置唯一的 token 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'
});

完整参考

继续阅读:使用 @capgo/capacitor-crisp

如果你正在使用 使用 @capgo/capacitor-crisp 要规划迁移和企业运营,请将其与 @capgo/capacitor-crisp 有关 @capgo/capacitor-crisp 的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 企业版 用于 Capgo Enterprise 中的产品工作流, Ionic Enterprise 插件替代方案 查看 Ionic Enterprise 插件替代方案中的产品工作流,以及 Capgo 替代方案 有关 Capgo 替代方案的产品工作流。

常见问题

Crisp plugin 常见问题

如何在 Capacitor 应用中安装 Crisp plugin?

运行 "bun add @capgo/capacitor-crisp"(或 "npm install @capgo/capacitor-crisp"),然后运行 "bunx cap sync",让 iOS 和 Android 项目识别原生 code。再在你的应用 code 中从 "@capgo/capacitor-crisp" 导入它。

@capgo/capacitor-crisp 是否支持 React、Vue 和 Angular?

支持。Crisp 是一个 Capacitor 包,因此适用于任何运行在 Capacitor 中的 Web 框架,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-crisp 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-crisp 是免费开源的吗?

是的。源码(code)已在 GitHub 公开,地址为 https://github.com/Cap-go/capacitor-crisp/,并且可以通过 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我可以在不经过 App Store 审核的情况下,更新使用了 Crisp 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待应用审核,即可发布 Crisp 变更

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo