SDK：GitHub
API 参考：GitHub 页面
示例应用程序：GitHub
NPM 包：npmjs.com
聊天 Web SDK 可使您创建自己的 数字 聊天 应用，或者将 数字 聊天添加到现有 Web 应用程序 中。它可使您在您选择的 UI 中使用 CXone 数字基础设施。这是一个基于 JavaScript 的 SDK，其支持 LiveChat 和聊天消息传送 — 同步和异步消息传送。您还可以设置单
在单线程应用程序中，每个联系人只能有一个聊天线程。 他们与您的组织的任何交互都发生在一个聊天线程中。或多线程 在多线程应用程序中，联系人可以创建任意数量的线程来讨论新话题。 这些线程可以同时处于活动状态。消息传送。此 SDK 可使您更好地控制网站上的 CXone。它可以帮助您避开某些网站的特定技术限制。例如，您的站点可能不允许外部代码，这可能会阻止本机 CXone 数字 聊天运行。
SDK 支持以下功能：
- 数字聊天消息传送
- 用于授权的 OAuth2.0
- 联系人识别和自定义字段
- 线程列表和线程恢复
- 附件
- 富消息
- 正在键入、消息已查看和消息已传递指示器
- 系统消息，例如案例状态事件或分配事件
- 队列位置事件
此 SDK 使用 TypeScript 4.9+ 编写。您还必须使用自定义 应用
SDK 资源
此页面顶部或下面的下拉菜单提供了各种 SDK 资源的链接。
您的开发者可从 GitHub 获取 SDK。该存储库有一个可帮助开发人员入门的自述文件。它还包含事件 的文档以及 API 参考。更加用户友好的 API 参考通过 github.io 单独加以托管。
您还可以查看示例 应用。这可使您尝试聊天并查看相关的源代码。
开发人员将 SDK 作为 NPM 包导入。npmjs.com 上的包条目包含有关使用 SDK 进行设置和构建的所有相同内容和说明。
关键术语
-
线程：聊天 应用程序 中的对话。由坐席或联系人
与联络中心的坐席、IVR 或机器人交互的人员。发送的第一条消息开始一个线程。对话中的每条连续消息均被添加到该线程中。线程是包含每条消息的对象。消息由消息的作者构建。threadId 标识整个会话，会话中的所有消息都有一个消息 ID。当对话结束时，线程也结束。 -
单线程：一种 应用程序 设计，其中联系人一次只能进行一个对话。
-
多线程：一种 应用程序 设计，其中联系人可以一次进行多个对话。
-
渠道：在 Digital Experience 的上下文中，渠道是指消息传递类型或用于通信的 平台。例如，您可以有一个 WhatsApp 实时消息渠道。Mobile SDK 可使您向您的 Mobile 应用程序 添加聊天消息渠道。渠道是在 CXone平台 中创建的。这决定了渠道的设置以及渠道 ID。当 应用程序 用户打开聊天时，您可以使用此 ID 启动聊天渠道。
-
ChannelId：在 CXone 的 数字 部分中创建的数字聊天渠道的 ID。您可以在 CXone 的聊天渠道设置中找到它（ACD > 数字 > 联络点数字 > 聊天 > 初始化和测试）。
-
BrandId：这类似于 Digital Experience 的租户
用于管理 CXone环境的技术支持、计费和全局设置的高级组织分组 ID。其用于初始化聊天。您可以在 CXone 的聊天渠道设置中找到它（ACD > 数字 > 联络点数字 > 聊天 > 初始化和测试）。 -
CustomerId：聊天最终用户的唯一 ID。SDK 在初始化聊天时创建此 ID。如果您设置了 OAuth，则每个联系人在所有设备上的此 ID 都保持不变。如果您没有设置 OAuth，则此 ID 对于每个设备都是不同的；此 ID 变得像访客登录名。
-
区域或环境：您的 CXone 部署在世界范围内的位置。这可以是：澳大利亚 (AU1)、加拿大 (CA1)、欧洲 (EU1)、日本 (JP1)、北美 (NA1) 或英国 (UK1)。开发者必须使用托管您 CXone 系统所在的相同区域，否则聊天连接将被拒绝。
-
联系人、客户和用户：这些术语均指 Mobile 应用程序 的最终用户。在线帮助一般使用术语联系人。在 SDK 文档和代码注释中，您可能会看到客户和用户。
-
CXone：核心 平台，您可以在其中管理和访问 NICE CXone 提供的所有客户体验工具。根据您想要在 Mobile 应用程序 中提供的聊天功能，具有必要用户帐户权限的管理员必须在 CXone 中完成多项设置任务。
-
Digital Experience：CXone 的部分，您可以在其中管理有关数字渠道的所有内容。
开始开发之前
在使用移动 SDK 构建之前，请考虑以下事项：