使用 Salesforce Lightning Web Component (LWC) 与聊天对话的客服助手界面模块集成。
准备工作
如需将 Agent Assist 界面模块与 Salesforce 集成,您需要能够访问以下资源:
-
按照建议的安装说明操作,完成相应操作系统的安装。
-
已知使用
npm
安装 Salesforce CLI 会导致兼容性问题。为避免这些问题,请使用pkg
(macOS)、exe
(Windows) 或TAR
(Linux) 安装选项之一。 -
按照说明安装
gcloud
命令,并使用gcloud auth login
进行身份验证。 Salesforce 界面
- 在您的实例网址或 Salesforce 登录页面中登录,并注意以下事项:
- 您的 Salesforce “我的网域”网址。请按以下步骤查找我的网域网址:
- 前往菜单栏 > 设置菜单。
- 点击 Setup(设置)。
- 在快速查找中搜索我的网域。域名采用以下格式:
MY-DOMAIN-NAME.develop.my.salesforce.com
。
- 您的 Salesforce 组织 ID。请按以下步骤查找组织 ID:
- 前往菜单栏 > 设置菜单。
- 点击 Setup(设置)。
- 输入 Quick Find 搜索“公司信息”。 注意:这些集成步骤仅在 Salesforce Developer Edition 中经过测试。如果您使用其他版本,功能许可和 Salesforce 界面可能会有所不同。
- 您的 Salesforce “我的网域”网址。请按以下步骤查找我的网域网址:
- 在您的实例网址或 Salesforce 登录页面中登录,并注意以下事项:
-
- 按照说明设置集成。
- 在运行部署脚本之前,请使用
deploy.sh
或在项目根目录的.env
文件中配置以下环境变量:AUTH_OPTION
:将此项设置为SalesforceLWC
。SALESFORCE_DOMAIN
:与YOUR_SUBDOMAIN.develop.lightning.force.com
类似的域名。您已在 Salesforce 界面前提条件中记下此值。请注意,您不应添加https://
。SALESFORCE_ORGANIZATION_ID
:您已在 Salesforce 界面前提条件中记下此值。
第 1 步:设置项目
如需开始集成 Agent Assist 界面模块,请按以下步骤操作。
运行以下代码以克隆 Agent Assist 集成代码库并打开您的项目:
git clone https://github.com/GoogleCloudPlatform/agent-assist-integrations cd salesforce/aa-lwc
运行以下命令,下载稍后将部署为静态资源的 JS 文件:
npm run generate-static-resources npm install
第 2 步:设置环境
您可以在特定环境(例如生产环境或开发环境)中集成 Agent Assist 界面模块。Salesforce 将这些环境称为“组织 (org)”。
在 Salesforce 控制台中配置组织
在 Salesforce 控制台中,按照以下步骤操作,为 Agent Assist 集成配置组织。
- 依次前往菜单栏 > 设置菜单,然后点击设置。在快速查找中搜索“全渠道设置”,然后点击全渠道设置。
- 勾选 Enable Omni-Channel(启用全渠道)。
- 在新窗口或标签页中,选择自动将客服人员登录到全渠道。
- 点击保存。
- 依次前往菜单栏 > 设置菜单,然后点击设置。在快速查找中搜索“社区”,然后依次点击数字体验 > 设置。
- 勾选启用体验工作区。
- 点击保存。
使用 Salesforce CLI 配置组织
按照以下步骤操作,使用 Salesforce CLI 配置组织以实现 Agent Assist 集成。
运行以下代码,并使用您通常使用的 Salesforce 登录详细信息对 CLI 进行身份验证。
npm run login
运行以下代码,将 LWC 部署到组织。
npm run deploy
第 3 步:创建外部客户端应用
Salesforce LWC 使用客户端凭据 OAuth 2.0 流程对您进行身份验证。外部客户端应用可启用客户端凭据流程。使用应用的使用方密钥和使用方密钥来配置 Salesforce LWC,以便通过 Salesforce 验证用户身份。
- 依次前往菜单栏 > 设置菜单,然后点击设置。在快速查找中输入“外部客户端应用管理器”进行搜索。
- 依次点击外部客户端应用管理器 > 新建外部客户端应用 > 创建,然后输入以下信息。
- 关联的应用名称:
lwc auth
- API 名称:
lwc_auth
- 联系电子邮件地址:
your_email@example.com
- API (Enable OAuth Settings) > Enable OAuth:已选中
- API (Enable OAuth Settings) > Callback 网址:
https://login.salesforce.com/services/oauth2/callback
- API (Enable OAuth Settings) > Selected OAuth Scopes:访问身份网址服务
- API (Enable OAuth Settings) > Enable Client Credentials Flow:已选择
- 关联的应用名称:
- 点击创建。
- 依次点击外部客户端应用管理器 > 新建外部客户端应用 > 创建,然后输入以下信息。
- 依次前往菜单栏 > 设置菜单,然后点击设置。在快速查找中输入“外部客户端应用管理器”进行搜索。
- 依次点击关联应用的名称 > 修改。
- 依次前往 OAuth 政策 > OAuth 流程和外部客户端应用增强。
- 确保选中启用客户端凭证流程。
- 在以此身份运行部分,输入您的登录用户名。
- 点击保存。
- 依次前往菜单栏 > 设置菜单,然后点击设置。在快速查找中输入“外部客户端应用管理器”进行搜索。
- 依次点击关联应用的名称 > 修改。
- 依次前往 OAuth 设置 > 应用设置 > Consumer Key 和 Secret。
- 输入发送到您电子邮件地址的验证码。
- 将使用方密钥和使用方密钥复制到安全的地方。您将在后续步骤中用到这些信息。
- 依次前往菜单栏 > 设置菜单,然后点击设置。在快速查找中搜索“CORS”,然后点击修改。
- 请参阅为 OAuth 端点启用 CORS。
- 点击保存。
如需详细了解关联的应用,请参阅以下 Salesforce 资源。
第 4 步:配置聊天客户端
如需将 Agent Assist 界面模块与 Salesforce 搭配使用,您需要在客服桌面上安装聊天客户端。
配置应用内消息和网站消息
请按照以下步骤配置即时通讯工具。
- 依次前往菜单栏 > 设置菜单,然后点击设置。输入快速查找搜索内容“可信网址”,然后点击新建可信网址。
- 输入 API 名称:
ui_connector
。 - 输入您使用 Agent Assist 集成后端部署的界面连接器 Cloud Run 服务端点的网址。您可以在 Cloud Run 控制台中找到此网址。例如:
https://UI_CONNECTOR_SUBDOMAIN.us-central1.run.app
。 - 选择 CSP 指令中的所有选项。
- 点击保存并新建。
- 输入 API 名称:
twilio_flex
。 - 输入网址
https://flex.twilio.com
。 - 选择 CSP 指令中的所有选项。
- 点击保存并新建。
- 输入 API 名称:
salesforce_domain
。 - 输入您的 Salesforce 网域的网址,格式如下:
https://YOUR_SUBDOMAIN.my.salesforce.com
。 - 选择 CSP 指令中的所有选项。
- 点击保存。
- 输入 API 名称:
- 依次前往菜单栏 > 设置菜单,然后点击设置。在快速查找中搜索“队列”,然后点击新建。
- 请输入以下信息:
- 标签:消息队列
- 队列名称:Messaging_Queue
- 路由配置:Messaging_Routing_Configuration
- 点击 Supported Objects,然后添加“Messaging User, Messaging Session”。
- 点击 Queue Members,然后添加“User: Your Login User”。
- 点击保存。
- 请输入以下信息:
- 依次前往菜单栏 > 设置菜单,然后点击设置。在快速查找中搜索“权限集”。
- 点击 Messaging Agents Permission Set。
- 依次点击服务状态访问权限 > 修改。
- 选择状态忙碌和在线 - 即时通讯。
- 依次点击添加 > 保存。
- 依次前往菜单栏 > 设置菜单,然后点击设置。在快速查找中搜索“用户”,然后点击用户。
- 点击您的用户名,然后验证 Service Cloud 用户是否已启用。
- 在页面上找到权限集许可分配。
- 点击修改分配关系,然后选中面向应用内和网站用户的消息。
- 点击保存。
- 在页面上找到权限集分配。
- 点击修改分配,然后选择消息代理权限集。
- 依次点击添加 > 保存。
- 依次前往菜单栏 > 设置菜单,然后点击设置。在快速查找中搜索“消息传递设置”,然后点击新渠道。
- 选择 Messaging for In-App and Web。
- 输入名称:即时通讯渠道。
- 点击保存。
- 将路由类型设置为“全渠道队列”,并将队列设置为“消息队列”。
- 点击保存,然后前往消息设置。
- 点击即时通讯渠道的名称,然后点击启用。
- 阅读完毕后,接受条款及条件。
- 依次前往菜单栏 > 设置菜单,然后点击设置。在快速查找中搜索“嵌入式服务部署”,然后点击新建部署。
- 依次点击面向应用内和网站的讯息 > 下一步 > 网站 > 下一步。
- 填写以下详细信息:
- 名称:消息传递嵌入式服务部署
- 开发者名称:Messaging_Embedded_Service_Deployment
- 网域:example.com
- 渠道:消息渠道
- 点击保存。等待部署完成。
- 在嵌入式服务部署设置中,点击发布。
- 依次点击刷新和测试消息。
测试应用内消息和网站消息
请按照以下步骤测试您的即时通讯工具。
- 点击测试消息传递。
- 新标签页加载完毕后,点击对话气泡即可开始新的测试对话。
- 发送消息,例如
"Test"
。 - 前往 Salesforce 浏览器标签页。
- 在设置工具栏中,点击应用启动器菜单,然后选择服务控制台。
- 在实用工具栏中点击全渠道。
- 将状态设置为在线 - 消息。
- 接受传入的消息。系统会在服务控制台中为对话打开一个新标签页。您无法查看聊天记录。
- 前往菜单栏 > 设置菜单。
- 点击修改页面。
- 从“组件”菜单中,将增强型对话拖动到对话窗格中。
- 依次点击保存 > 启用 > 设为组织默认 > 桌面 > 返回 。
- 刷新页面。
- 在实用工具栏中点击全渠道。
- 将状态设置为在线 - 消息。
- 回复“测试”消息,以验证消息传递是否正常运行。
如果您遇到问题并需要更多信息,请参阅全面的 Salesforce 应用内消息和网站消息设置指南。
第 5 步:安装 Salesforce LWC
按照以下步骤使用 Lightning Experience 编辑器将 Salesforce LWC 添加到消息会话页面中。从第 4 步开始继续测试对话。
- 前往菜单栏 > 设置菜单,然后点击修改网页。
在组件侧边栏中,将
agentAssistContainerModule
移入侧边栏。点击您在上一步中放置的组件。
填写表单字段,如下所示,以添加配置详细信息。
- 端点:代理集成后端界面连接器的网址,例如 Cloud Run 控制台中的网址,如:
https://UI-CONNECTOR-ENDPOINT.GCP-REGION.run.app
- 功能:对话配置文件中启用的 Agent Assist 功能,例如
CONVERSATION_SUMMARIZATION
、KNOWLEDGE_ASSIST_V2
、SMART_REPLY
和AGENT_COACHING
conversationProfile
:Agent Assist 对话配置文件资源名称(例如:projects/GCP-PROJECT-ID/locations/GCP-REGION/conversationProfiles/CONVERSATION-PROFILE-ID
)- consumerKey:第 3 步中的关联应用使用方密钥
- consumerSecret:第 3 步中的关联应用使用方密钥
- 端点:代理集成后端界面连接器的网址,例如 Cloud Run 控制台中的网址,如: