Mobile SDK

当前版本：
API 参考：

为了帮助您开始实施移动 SDK，您必须从 NICE 购买基本实施包。 NICE 的合作伙伴将指导您完成实施过程。

Mobile SDK允许您将CXone Mpower 数字聊天集成到您的企业移动电话应用程序中。 这可使 应用程序 用户通过数字Closed 与Digital Experience相关的任何渠道、联系或技能。聊天渠道与您的联系中心坐席和机器人聊天。 SDK 可简化实施数字聊天的过程；开发者无需处理业务逻辑实施。 开发人员的主要任务是直观地显示和管理您在CXone Mpower中设置的功能，例如推送通知或富消息Closed 数字消息传递中的元素，如按钮、图像、菜单和选项选取器。。

SDK支持iOS和Android 应用程序。 iOS 应用程序必须用 Swift 此链接将在新窗口中打开 编写，Android 应用程序必须用 Kotlin 此链接将在新窗口中打开 编写。 此外，SDK 要求最低Android版本为 7.0，最低iOS版本为 15.0。

使用 Mobile SDK：

要快速了解 SDK 的优势，您可以查看 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 版本通常随CXone Mpower主要营销版本一起更新，例如 25.2、25.3 等。 在GitHub中，每个发布版本都根据下述语义版本控制进行了标记。

NICE 支持 SDK 的当前主要版本和以前的一个主要版本。 例如，如果当前版本是 2.2，则NICE支持 v2.2 和 1.3（最新 1.xx 版本）。

您有责任使您的 应用程序 保持最新，因为 SDK 也会更新。 以上“SDK 资源”部分提供了最新资源的链接。 在 SDK 存储库中，您可以使用标签查找 SDK 的早期版本。 另请注意，SDK 向后兼容最近两个主要版本。

版本变更

当 SDK 版本因版本而异时，版本号表示更改类型。 该符号解释如下：

  • 2.0.0：第一个数字表示 API 的主要更改。

  • 2.1.0：第二个数字表示非重大变更。 通常，新功能作为非破坏性更改添加。

  • 2.0.1：第三个数字表示错误修复。 它们始终向后兼容。

错误修复

NICE 专业服务人员将与您合作修复错误。 您可以通过他们（或实施合作伙伴）提交错误，他们会向您传达修复程序以及 SDK 更改日志。

此外，任何错误都会在当前支持的版本中修复。 例如，如果当前版本是 3.0，则支持的两个版本为 3.0 和 2.3（2.x 的最新版本）。 如果您在 v2.1 中发现了错误，NICE 会为 2.3 和 3.0 修复该错误，但不会在 2.1 或 2.2 中修复该错误。

Mobile SDK 如何适合 Digital Experience

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

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

Mobile SDK 基础设施图

构建您的聊天 UI

Mobile SDK带有默认的 UI/UX 模块。 您可以选择将其作为标准实现包的一部分来实现。 此默认模块会自动处理所有聊天功能，从而减少您进一步开发的需求，例如：

但是，您可能希望进行某些其他配置，例如潜在的本地化、推送通知和OAuth身份验证。 如果要支持除英语以外的任何语言，则必须提供文本字符串的翻译。 如果实现非英语语言，请务必测试 UI 的所有区域，以确保正确处理显示。

如果您的开发人员在标准 UI/UX 之上进行了其他自定义，NICE将不会为这些更改提供支持。

Mobile SDK示例应用展示了默认的 UI/UX。 UI/UX 模块的文档位于模块本身中，供开发人员查看。

最后，您还可以选择使用或开发自己的 UI;您没有义务使用默认的 UI/UX。 如果您使用自己的 UI（或第三方 UI 包），NICE 将不会为其提供支持。

开始开发之前

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

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

关键术语

  • 线程：聊天 应用程序 中的对话。 由坐席或联系人Closed 与联络中心的坐席、IVR 或机器人交互的人员。发送的第一条消息开始一个线程。 对话中的每条连续消息均被添加到该线程中。 线程是包含每条消息的对象。 消息由消息的作者构建。 threadId 标识整个会话，会话中的所有消息都有一个消息 ID。 当对话结束时，线程也结束。

  • 单线程：一种 应用程序 设计，其中联系人一次只能进行一个对话。

  • 多线程：一种 应用程序 设计，其中联系人可以一次进行多个对话。

  • 渠道：在 Digital Experience 的上下文中，渠道是指消息传递类型或用于通信的 平台。 例如，您可以有一个 WhatsApp 实时消息渠道。 Mobile SDK 可使您向您的 Mobile 应用程序 添加聊天消息渠道。 渠道是在 CXone Mpower平台 中创建的。 这决定了渠道的设置以及渠道 ID。 当 应用程序 用户打开聊天时，您可以使用此 ID 启动聊天渠道。

  • ChannelId：在 CXone Mpower 的 Digital 部分中创建的数字聊天渠道的 ID。 您可以在 CXone Mpower 的聊天渠道设置中找到它（ACD > Digital > 联络点数字 > 聊天 > 初始化和测试）。

  • BrandId：这类似于 Digital Experience 的租户Closed 用于管理CXone Mpower系统的技术支持、计费和全局设置的高级组织分组。 ID。 其用于初始化聊天。 您可以在 CXone Mpower 的聊天渠道设置中找到它（ACD > Digital > 联络点数字 > 聊天 > 初始化和测试）。

  • CustomerId：聊天最终用户的唯一 ID。 SDK 在初始化聊天时创建此 ID。 如果您设置了 OAuth，则每个联系人在所有设备上的此 ID 都保持不变。 如果您没有设置 OAuth，则此 ID 对于每个设备都是不同的；此 ID 变得像访客登录名。

  • 区域或环境：您的 CXone Mpower 部署在世界范围内的位置。 这可以是：澳大利亚 (AU1)、加拿大 (CA1)、欧洲 (EU1)、日本 (JP1)、北美 (NA1) 或英国 (UK1)。 开发者必须使用托管您 CXone Mpower 系统所在的相同区域，否则聊天连接将被拒绝。

  • 联系人、客户和用户：这些术语均指 Mobile 应用程序 的最终用户。 在线帮助一般使用术语联系人。 在 SDK 文档和代码注释中，您可能会看到客户和用户。

  • CXone Mpower：核心 平台，您可以在其中管理和访问 CXone Mpower 提供的所有客户体验工具。 根据您想要在 Mobile 应用程序 中提供的聊天功能，具​​有必要用户帐户权限的管理员必须在 CXone Mpower 中完成多项设置任务。

  • Digital Experience：CXone Mpower 的部分，您可以在其中管理有关数字渠道的所有内容。