此用例描述了将Chat(可选地,共同浏览)功能集成到第三方系统所需的配置和API使用示例步骤。

词汇表

  • 用户/代理是应答聊天的用户/代理。
  • 客户是通过聊天写消息的用户。

1. 设置和脚本的实施

插件配置

激活并配置您的WebChat插件。

  • 颜色
  • 文本
  • 外观
  • ...

前往设置.

JavaScript 集成

必须将JavaScript集成到我们要浏览的每个网页中。

了解添加聊天到您的页面的步骤

2. 控制聊天的可见性

📌注意: 如果未配置任何内容,则默认情况下会显示聊天。

您可以设置单独的操作规则来控制聊天的可见性:

  • 所有代理都在线
  • 所有代理都可用
  • 营业时间
  • 访客在页面提留了x 秒
  • 访客第二次访问页面

或者您可以通过REST API对其进行控制。

使用REST API 设置聊天的可见性

📌注意: REST API和操作规则也可以结合使用

3. 代理的同步更新

如果您使用第三方环境来管理代理,则只需通过我们的REST API将代理帐户与Chatvisor同步即可。

使用 REST API 来完成代理的同步更新

4. 标记客户以使其与您的内部ID相匹配

有时,您可能想重新识别客户,并想用其他信息扩展他们。 所以

使用REST API to 标记客户

{
  "email": "[email protected]",
  "firstname": "John",
  "id": 123,
  "labels": [
    "foo",
    "bar"
  ],
  "lastname": "Doe"
}

5. 接收新的对话/消息

WebHooks

可以在“设置”“ API”“ WebHooks”中配置WebHooks。 当开始新的对话或收到新的消息时,您会收到一个Webhook。 如果在Chatvisor中未配置自动路由规则,则可以手动将对话路由到您的一个座席,并生成一个公共URL来加入对话。

前往配置

REST API

您还可以通过REST API轮询对话。

前往文档

6. 生成代理的公共聊天链接

成功创建对话/客户后,可以生成一个公共URL来加入对话。 为此,我们需要从WebHook或Conversation API收到的[customerId]。

📌注意: 验证并生成API令牌 前往文档

使用REST API 来生成代理的公共聊天链接

📌注意: 这是唯一的链接,代理将在其中自动登录并重定向到给定的聊天室。

7. 可选项 - 附加地互助浏览

您只需启用并浏览插件并对其进行配置。 然后,它将自动集成到实时聊天中。

前往配置