CXone Mobile SDK

当前版本：2.1
API 参考：

CXone Mobile SDK 可使您将 CXone 数字聊天集成到您的企业移动电话 应用程序 中。这可使 应用程序 用户通过数字关闭 与Digital Experience相关的任何渠道、联系或技能。聊天渠道与您的联系中心坐席和机器人聊天。SDK 可简化实施数字聊天的过程；开发者无需处理业务逻辑实施。开发者的主要任务是直观地显示和管理您在 CXone 中设置的功能，例如推送通知或富消息。SDK 支持 iOS 和 Android 应用程序。iOS 应用程序 必须使用 Swift 此链接将在新窗口中打开 编写，Android 应用程序 必须使用 Kotlin 此链接将在新窗口中打开 编写。

使用 CXone Mobile SDK：

要快速了解 SDK 的优势，您可以查看 CXone Mobile SDK 数据表 此链接将在新窗口中打开。您还可以观看简短演示视频 此链接将在新窗口中打开。

软件开发工具包 (SDK) 就像是开发者的工具箱。它提供了一套可使构建软件 应用 变得更容易的工具和资源。您可以将其视为预制构建块的集合。这些构建块具有现有功能。开发者可使用这些现有块，而不是从头开始亲自构建功能。以下是使用 SDK 的四个一般好处：

  1. 效率：SDK 提供现成的工具和预构建组件，从而可节省开发者的时间。他们可以专注于其 应用程序 的独特方面，而不是浪费时间做无用功。

  2. 一致性：SDK 可确保在不同 应用程序 间保持一致性。通过使用同一套工具和库，开发者可为用户保持统一的体验。

  3. 平台兼容性：iOS 和 Android SDK 针对各自的 平台 进行了定制。它们可处理 平台 特定的复杂性，从而使创建跨平台 应用程序 变得更容易。

  4. 质量保证：凭借记录器，开发者可验证他们的代码，及早发现错误，以及提供更可靠的软件。

总之，SDK 可简化开发，确保质量并促进协作，从而使其成为高效创建 应用程序 的重要工具。

SDK 资源

从公共 GitHub 存储库下载 SDK 包 (Android 此链接将在新窗口中打开 iOS 此链接将在新窗口中打开)。两个存储库都包含一个自述文件，以帮助您开始进行开发。它们还在 /docs 中提供带有代码示例的用例。在您开发聊天时使用这些来获得灵感。这两个存储库还包含更改日志。

您可以在浏览器中访问这些 API 参考 (Android 此链接将在新窗口中打开 iOS 此链接将在新窗口中打开)。

您的开发者还可查看 Android 此链接将在新窗口中打开 和 iOS 此链接将在新窗口中打开 平台 的示例 应用。这些可帮助开发者查看已实施功能的示例。

Mobile SDK 版本控制

SDK 的当前版本是 2.0，其与 CXone 24.2 主要版本相关。以上“SDK 资源”部分提供了最新资源的链接。

在 SDK 存储库中，您可以使用标签查找 SDK 的早期版本。

Mobile SDK 如何适合 Digital Experience

Mobile SDK 是一种扩展 Digital Experience 并在移动 应用程序 中提供 数字 聊天的方法。Digital Experience 是 CXone 中支持数字渠道的部分。数字渠道的示例为 WhatsApp、Facebook 上的帖子或数字聊天。要将 CXone 数字聊天添加到 应用程序 中，您必须在 CXone 界面的 Digital Experience 部分中配置某些功能。然后利用 SDK，您可以访问和使用在 CXone 中设置的功能。

例如，入门过程的一部分是在 CXone 中设置数字聊天渠道。您的 应用程序 创建与您创建的渠道之间的 WebSocket 连接。您还可以设置高级功能，例如欢迎消息或聊天前调查。这些为您提供了各种选项来简化您的 应用程序 用户体验。用户可以提供有关其问题或请求的初始信息、输入基本个人数据等。这些功能最初在 CXone 中进行设置，然后您可以将其与 SDK 一起使用。

Mobile SDK 基础设施图

构建您的聊天 UI

作为集成商，您负责构建您的聊天 UI。这是利用某些功能（例如显示和处理文件或录制语音消息）所必需的。例如，您将需要添加一个按钮，以供联系人按下该按钮来访问设备的麦克风，从而录制消息。有关如何实施该 UI 的示例，您可以参考示例 应用 (Android 此链接将在新窗口中打开 iOS 此链接将在新窗口中打开)。

您可以使用第三方 UI 开发套件，例如 MessageKit。但是，这可能会受到限制，具体取决于您的用例。此外，NICE CXone 不拥有任何第三方 UI 包，也不提供对任何第三方 UI 包的支持。

开始开发之前

在使用移动 SDK 构建之前，请考虑以下事项：

  • 您在 CXone 中是否同时拥有管理员和坐席帐户？管理员能否协助您在 CXone平台 中设置必要的功能？
  • 您的移动 应用程序 适用于iOS (Apple)、Android 还是这二者？您的开发者是否熟悉 Swift 和 Kotlin 语言？
  • 您有现有聊天消息渠道，还是想创建一个新渠道？
  • 您是否会使用 OAuth 来对您的 应用程序 用户进行身份验证？如果是，您将使用哪个 OAuth 提供商？
  • 您想提供单线程还是多线程对话？
  • 您是否会使用弹出窗口或欢迎消息等主动操作？
  • 您是否要使用推送通知？您是否有现有 Firebase 或 Apple 开发者帐户？
  • 您想要设置哪些类型的富消息？您可以在哪些用例中利用这些交互式消息？
  • 您是否要跟踪用户数据？如何使用访问者事件来生成分析？

关键术语

  • 线程：聊天 应用程序 中的对话。由坐席或联系人关闭 与联络中心的坐席、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 的部分，您可以在其中管理有关数字渠道的所有内容。