跳转到正文

@capgo/capacitor-crisp

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

@capgo/capacitor-crisp 嵌入 用于应用内支持的 Crisp 原生聊天 SDK 配置您的网站 ID、识别用户、推送事件,并在移动端处理 Crisp push tokens。

平台支持
iOS原生 Crisp SDK
Android原生 Crisp SDK
Web 端推送辅助功能不可用
  • configure - 使用您的网站 ID 配置 Crisp SDK。必须在调用任何其他方法之前调用。
  • openMessenger - 打开 Crisp 聊天窗口。向用户显示聊天界面。
  • setTokenID - 为当前用户会话设置唯一的 token ID。用于识别并恢复之前的对话。
  • setUser - 设置当前会话的用户信息。更新客服人员可见的用户资料。
方法描述
configure使用您的网站 ID 配置 Crisp SDK。必须在调用其他任何方法之前调用。
openMessenger打开 Crisp 聊天窗口。向用户展示聊天界面。
setTokenID为当前用户会话设置唯一的 token ID。用于识别并恢复之前的对话。
setUser- 设置当前会话的用户信息。更新客服人员可见的用户资料。
pushEvent向 Crisp 推送自定义事件。适用于追踪用户操作和行为。
setCompany设置当前会话的公司信息。将用户与 Crisp 中的公司进行关联。
setInt设置自定义整数数据字段。存储与用户会话相关的数值数据。
setString设置自定义字符串数据字段。存储与用户会话相关的文本数据。
sendMessage从用户向聊天窗口发送消息。通过代码模拟用户输入并发送消息。
setSegment设置用户分层(Segment)以便进行定向和管理。用于在 Crisp dashboard 中对用户进行分类。
reset重置 Crisp 会话。清除所有用户数据并开启新会话。适用于用户登出场景。
getPluginVersion获取插件的版本号。

此参考文档同步自 src/definitions.ts 中的 capacitor-crisp.

如果你正在使用 @capgo/capacitor-crisp 要规划原生插件工作,请将其与 使用 @capgo/capacitor-crisp 用于“使用 @capgo/capacitor-crisp”中的原生能力, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节, 添加或更新插件 关于“添加或更新插件”中的实现细节,以及 Ionic Enterprise 插件替代方案 关于“Ionic Enterprise 插件替代方案”中的产品工作流。