启用第三方协同浏览和屏幕共享

协同浏览和屏幕共享是 Microsoft Dynamics 365 聊天频道中的升级通道。 协同浏览或屏幕共享升级通道允许您组织的代理与客户启动协同浏览或屏幕共享会话。 通过协同浏览,代理可以查看客户的 Web 浏览器并与之交互。 通过屏幕共享,代理可以查看客户的当前屏幕并与之交互。 客户可以获得一个额外的选项来连接到可以实时有效地解决问题的代理。

通过与第三方解决方案集成,可以在聊天通道中启用协同浏览和屏幕共享。 提供可扩展性,使任何提供商都能将其协同浏览和屏幕共享解决方案载入 Customer Service 全渠道。

注释

第三方共同浏览和屏幕共享功能在 Unified Service Desk 中不可用。

先决条件

  • 有效的数字消息或聊天订阅。
  • 更新了全渠道基础和全渠道聊天解决方案,启用了第三方协同浏览外部性。

第三方协同浏览和屏幕共享扩展性框架

为了启用第三方协同浏览和屏幕共享,Customer Service 全渠道应用程序提供了一个扩展性系统来支持此功能。 在此系统中,屏幕共享提供商可以使用的 Customer Service 全渠道解决方案中提供了一些实体。 下图说明了支持第三方协同浏览和屏幕共享功能的基本实体关系。

共同浏览功能的实体关系。

并非所有字段都需要为第三方协同浏览和屏幕共享提供商填写。 对于版本 1.0,支持独立软件供应商通过启用代理聊天小组件中的按钮将其协同浏览和屏幕共享功能引入 Customer Service 全渠道。 当用户选择此按钮时,它会在 Customer Service 全渠道中打开一个应用选项卡,其中包含独立软件供应商的应用程序网站。 若要启用此按钮,ISV 需要通过其协同浏览和屏幕共享解决方案提供所需的数据。

以下部分列出了支持此功能所需的实体数据。

  • 对话作实体 (msdyn_conversationaction)

    可以在对话中执行的作。 

    领域

    • 名称:按钮的标识符名称。
    • 事件名称(选项集:打开应用程序选项卡模板、发送消息、客户定义功能。对于第三方共同浏览/屏幕共享功能,请输入 打开应用程序选项卡模板
    • 事件参数(对于第三方共同浏览/屏幕共享按钮,请在此处输入应用程序选项卡模板名称。
    • 顺序(用于确定对话作的位置。管理员可以编辑。最小的数字在前。
    • 图标 (链接到按钮图标的 Web 资源 URL。

    字段分类和用法

    • 这是用于存储对话控件上可见的作按钮元数据的实体。
    • 从关系到区域设置实体(标签、工具提示、斜杠命令)的本地化字段是此对话作窗体中的子网格。 
    • 标签、顺序、工具提示、图标用于在UI中呈现按钮。 代理使用斜杠命令通过在聊天框中键入斜杠命令来触发对话作。  
    • 事件名称、Web 资源、事件参数和函数名称用于处理 onButtonClick作。 
  • 对话作区域设置实体 (msdyn_conversationactionlocale)

    与对话作关联的本地化信息。 

    领域

    • 标签 (在对话控件中向用户显示的按钮的标签。
    • 工具提示 (该按钮的工具提示。
    • 区域设置(该按钮的语言键。
    • 对话作 (FK 到对话作实体。
  • 提供程序实体 (msdyn_provider)

    将功能引入应用程序的第三方提供程序列表。 

    字段:名称(ISV 名称)

  • 渠道能力实体 (msdyn_channelcapability)

    通道可以启用的功能,例如协同浏览和屏幕共享。 

    领域

    • 名称(provider_channelcapability关系名称)
    • 升级通道模式(协同浏览、屏幕共享、音频、视频或无。对于第三方协同浏览和屏幕共享提供商,请使用“协同浏览”或“屏幕共享”。
    • 提供程序(提供程序实体的外键)
    • 对话作 (对话作的查找字段。如果未为某个功能创建按钮,则它可以为空。 对于第三方协同浏览和屏幕共享功能,请将渠道功能链接到对话作记录。 

字段分类和用法

“升级通道模式”属性说明此按钮可以执行哪些作。 例如,协同浏览、音频、视频。 当用户为对话作选择特定的升级渠道模式(例如,“cobrowse”)时,Customer Service 全渠道将处理此协同浏览事件并触发内部事件列表,如“为辅助渠道创建新会话”、“发送系统消息”和“更新状态”,这些事件应在 Customer Service 全渠道代码库中实现。  

一个提供程序可以带来多个通道功能,但对于一个对话作和一个提供程序,该功能应该是唯一的。 这是通过使用 Channel Capability 实体来处理的,如以下架构所示。

通道能力 供应商 升级通道模式 对话作
ISV_screensharing ISV 屏幕共享 CA1
ISV_cobrowse ISV 共同浏览 CA2

第三方协同浏览和屏幕共享按钮的 UI 渲染

标签、顺序、工具提示和图标用于在UI中呈现按钮。 用户还可以为其按钮提供斜杠命令键,但斜杠命令在系统中必须是唯一的。  用户在引入按钮时需要输入此数据。  

Name 标签 下单   Tooltip   斜杠命令 图标
ISVCobrowse ISV Co-browse 0 Start a Cobrowse session provided by ISV /cb /web资源/.../...SVG的

用于第三方协同浏览和屏幕共享的事件处理程序

对于第三方协同浏览,独立软件厂商需要输入对话作数据,以触发“打开应用选项卡模板”事件。  事件名称是选项集。 它可以是预定义的全渠道事件,可用于大多数情况,例如打开应用选项卡模板或发送消息。  在第三方协同浏览案例中,它使用“打开的应用程序选项卡模板”作为“事件名称”,而“事件参数”可以是“应用程序选项卡模板”名称。 此事件没有 Web 资源数据,因为应用选项卡模板框架处理 Web 资源。 

Name 事件名称 事件参数 能力   
ISV浏览 打开应用程序选项卡模板 ISVAppTab模板 共同浏览

用于第三方共同浏览和屏幕共享的应用程序选项卡模板

我们鼓励我们的集成第三方协同浏览提供商在 Customer Service 全渠道选项卡中制作其协同浏览和屏幕共享应用程序。当座席选择聊天小组件中的 共同浏览 按钮时,它会打开此选项卡。在此选项卡中,代理可以启动和结束协同浏览会话,并与客户共享会话邀请。 可以在解决方案中包含此窗体中的数据。 请按照以下步骤创建应用选项卡模板:

  1. 执行 管理应用程序选项卡模板中的 步骤以创建 Web 资源。

  2. 在“应用程序类型”字段中,选择 **webresource**

  3. 在“参数”部分中,添加 ISV 打开其 Web 资源所需的 Web 资源 URL 和查询参数。

    webresourcename: <URL path to the web resource>

名为 data 的单个 URL 参数包含一个 JSON 对象。 解码和解析时,此对象包含字段 conversationId 。 此 ID 可用于将任何数据附加回对话。

使用所需数据创建第三方协同浏览和屏幕共享解决方案

独立软件供应商应引入“ 第三方协同浏览扩展性框架” 部分和第三方 协同浏览部分的“应用选项卡模板 ”部分中指定的所有必需数据,以使此框架正常工作。

第三方提供商的数据输入要求如下:

  • 应用选项卡模板记录。

  • 对话作记录。 (如果您同时具有协同浏览和屏幕共享选项,则可以创建两条记录,每条记录一条。

  • 对话作区域设置记录。 (对于您创建的每个对话作,您应该至少有一个对话作区域设置记录。我们支持的基本语言是英语。

  • 提供程序记录。 

  • 通道能力记录。 (如果您同时具有协同浏览和屏幕共享选项,则可以创建两条记录,每条记录一条。

将记录作为您作为第三方提供商创建的解决方案的一部分包含在内,以便最终用户无需手动创建它们。

第三方协同浏览和屏幕共享的管理员体验

在聊天小组件的 对话选项 选项卡的 远程协助 部分中,全渠道管理员可以选择启用或禁用每个聊天小组件的第三方协同浏览和屏幕共享选项。 如果此组织中未安装协同浏览和屏幕共享提供程序,则将禁用这两个选项,如下所示。

共同浏览功能的管理员体验。

未为共同浏览功能安装屏幕共享会话。

注释

协同浏览提供程序和屏幕共享提供程序是单独控制的。 您可以通过创建包含所需提供程序和对话作数据的协同浏览通道功能记录来安装协同浏览提供程序,与屏幕共享提供程序相同。

当组织预配了这两个选项时(即,当它安装了两个不同的渠道功能时),管理员可以选择要使用的第三方协同浏览提供商。 此外,管理员可以选择是禁用还是启用这些选项。 下面是启用了两个选项并选择两个提供商的管理员的屏幕截图。

共览功能的远程协助。

座席聊天小部件中的协同浏览和屏幕共享按钮渲染

定义协同浏览和屏幕共享按钮后,它将呈现在对话控件的顶部,如下所示。

聊天小部件中的屏幕共享按钮渲染。

用于第三方协同浏览和屏幕共享的全渠道会话服务和数据流

当代理选择用于协同浏览或屏幕共享的按钮时,它会触发全渠道服务内的应用程序选项卡。 Customer Service 全渠道将事件作为升级渠道事件类型进行处理。 Customer Service 全渠道内部服务更新当前会话事件的状态。

第三方应用程序接管后,所有数据都由第三方应用程序服务器处理。 有关集成数据流,请参阅下图。

协同浏览的数据流。

一些重要事件(例如开始或结束会话事件)应报告给全渠道服务,以便整个服务了解当前代理的状态。 我们为第三方提供商提供此框架。 第三方提供商有责任在其代码库中实现它。 下一节将详细介绍如何实现它。

第三方应用程序预期的事件

第三方应用程序应发送事件,通知 Customer Service 全渠道协同浏览和屏幕共享会话中的不同里程碑。 目前,这些事件如下:

  • CobrowseConnectedEvent(连接共浏览会话时)
  • CobrowseEndedEvent(在协同浏览会话结束时)
  • ScreenShareConnectedEvent (连接屏幕共享会话时)
  • ScreenShareEndedEvent (屏幕共享会话结束时)

事件必须在第三方 Web 资源中分派到元素 window.top

 function triggerCobrowseStart() {
   if(document.createEvent) {
     let params = {};

     let evt = new CustomEvent('CobrowseConnectedEvent', {detail: params});
     window.top.dispatchEvent(evt);
   }
 }

CobrowseEndedEvent应将 和 ScreenShareEndedEvent 添加到 Web 资源的属性中onbeforeunload,以便在代理关闭 Customer Service 全渠道中的选项卡时结束会话。

<script>
function triggerCobrowseStop() {
  if(document.createEvent){

    let params = {};

    let evt= new CustomEvent('CobrowseEndedEvent', {detail:params});
    window.top.dispatchEvent(evt);
  }
}

</script>
</head>
<body onbeforeunload="return triggerCobrowseStop()">
</body>

预配和取消预配要求

若要为客户预配第三方协同浏览和屏幕共享解决方案,ISV 应提供包含所需数据的解决方案。 当客户安装解决方案时,他们只需最少的手动步骤或不需要手动步骤即可启用协同浏览和屏幕共享功能。 我们要求 ISV 对他们创建的数据负责,并根据需要遵循我们的指导。

若要为客户取消预配第三方协同浏览和屏幕共享解决方案,ISV 应删除该解决方案以及使用此框架创建的数据。 取消配置后,该组织中不应保留任何现有的旧数据或代码。

发布策略

下面是用于将应用程序发布到 AppSource 的链接:

AppSource 载入

入职指南

概述指南 PDF

协议 PDF

政策 PDF(包括福利表)

partner.microsoft.com 网站上的计划页面,其中包含证书信息的链接

客户/合作伙伴支持

第三方提供商责任和数据免责声明

确保发布指向 AppSource 的隐私策略链接,以便对将要处理的个人信息进行安全和隐私保护,并提供合规的数据保护方法。