订单状态预构建组件会检查客户的身份验证级别，然后向经过身份验证的客户提供有关用户最近或过去订单的信息。此组件使用零售身份验证预构建组件对用户进行身份验证。该组件还使用生成器进行通话后总结。
限制
除了常见的预构建组件限制之外，此预构建组件还具有以下限制：
- 此组件不会加密任何数据。
对话示例
以下示例对话展示了此预构建组件处理的常见场景。示例对话演示了使用电话服务调用组件时的行为，这会在对话开始时触发默认欢迎 intent 和第一个代理响应。
近期订单
最终用户通过未注册的号码致电；客服人员对用户进行身份验证，然后提供订单中配送的详细信息。用户确认他们希望系统向其注册的手机号码发送一条包含更多详细信息的短信。
| 用户输入 | 智能体回答 |
|---|---|
| 代理使用零售身份验证预构建组件对用户进行身份验证 | |
| 好的，John。您致电是为了咨询您最近的订单吗？该订单是 John Doe 于 2023 年 11 月 10 日下午 6:00 下单的，包含灯具、衬衫和其他 10 件商品。 | |
| 是 | |
| 您的订单包含 2 个运单，将于 2024 年 1 月 15 日前送达。 您想详细了解这些运单吗？ |
|
| 是 | |
| 包含牛仔裤、腰带和另外 2 件商品的第 1 批货物正在运输途中，将于 2024 年 1 月 12 日送达。 包含灯具、衬衫和另外 6 件商品的第 2 批货物已于 2023 年 11 月 12 日送达。 您是否希望通过短信接收有关商品的更多详细信息？ |
|
| 是 | |
| 我们已向您发送一条短信，其中包含一个链接，您可以通过该链接跟踪所有货件的状态。感谢您的来电。 |
重复订单
最终用户之前已通过身份验证。用户请求获取有关订单的信息，并提供订单的最后五位数字。代理识别出此用户下的多个订单具有相同的后五位数字，因此它会确认用户想要了解哪个订单的状态，并向用户提供订单状态。
| 用户输入 | 智能体回答 |
|---|---|
| 好的，Amber。您致电是为了咨询 Amber Doe 最近于 2023 年 11 月 10 日下午 6:00 下达的订单吗？该订单包含灯具、衬衫和其他 2 件商品。 | |
| 否 | |
| 能否请您提供要跟踪的订单 ID 的后 5 位数字？ | |
| 12355 | |
| 我们获取的订单 ID 的后五位数字是 12355，对吗？ | |
| 是的，没错 | |
| 太好了，我们已收集到订单 ID。 | |
| 根据我们的记录，我们找到了 2 个以相同 5 位数字 12355 结尾的订单。您要找的是哪个订单？ 是 2023 年 11 月 10 日下午 6:00 下单的订单 1，还是 2023 年 11 月 9 日晚上 8:00 下单的订单 2？ 如要选择订单 1，请说“1”；如要选择订单 2，请说“2”。否则，请说“否”。 |
|
| 订购 | |
| 您的订单包含 2 个运单，将于 2024 年 1 月 15 日前送达。 您想详细了解这些运单吗？ |
|
| 是 | |
| 包含牛仔裤的第 1 批货物正在运输途中，将于 2024 年 1 月 15 日送达。 包含灯具、衬衫和另外 1 件商品的第 2 批货物已取消。 您是否希望通过短信接收有关商品的更多详细信息？ |
|
| 没有了 | |
| 感谢您的来电。 |
命名规则
此预构建组件使用以下命名惯例：
| 功能 | 格式 | 示例 |
|---|---|---|
| Flow | [Component Name] | Order Status |
| 网络钩子 | prebuilt_components_[component_name]:[webhook_action] | prebuilt_components_order_status:get_order_details |
输入参数
输入参数是用于配置组件某些行为的参数。这些参数将由流程中的一个或多个条件使用，以确定组件的行为方式。必须在组件的起始页面上设置流级范围参数。会话级范围的参数可由调用流设置，也可在此组件的起始页面上设置。
此预构建组件接受以下输入参数：
| 参数名称 | 说明 | 输入格式 |
|---|---|---|
| $session.params.phone_number | （可选）用户的本地手机号码（不含国家/地区代码），用于识别用户。 | 字符串 |
| $session.params.all_recent_order_id | （可选）此参数会列出与经过身份验证的用户关联的订单 ID，并按订单下单日期降序排序。数组的第一个元素表示最近的订单。如果用户没有订单，则此参数的值为 null。 |
列表（字符串） |
| $session.params.email | （可选）与账号关联的邮箱。 | 字符串 |
| $session.params.user_first_name | （可选）用户的名字，用于问候和确认账号所有权。 | 字符串 |
| $flow.max_shipment | 指定一次向用户显示的配送数量。默认值为 2。 |
整数 |
| $flow.tracking_status_delivered | 指定 webhook 返回的值，用于指示订单状态为已送达。默认值为 "delivered"。 |
字符串 |
| $flow.tracking_status_cancelled | 指定 webhook 返回的值，该值表示订单状态已取消。默认值为 "cancelled"。 |
字符串 |
| $flow.tracking_status_returned | 指定 webhook 返回的值，用于指示退货订单状态。默认值为 "returned"。 |
字符串 |
| $flow.tracking_status_partially_returned | 指定 Webhook 返回的值，表示部分退货的订单状态。默认值为 "partially returned"。 |
字符串 |
| $flow.max_retry_alternate_profile | 指定从非注册手机号码或备用个人资料请求订单状态时允许的重试次数。默认值为 3。 |
整数 |
| $flow.max_retry_order_number | 指定提供订单号时允许的重试次数。默认值为 3。 |
整数 |
| $flow.max_retry_another_order_id | 指定在提供无效订单号后允许的重试次数。默认值为 3。 |
整数 |
如需为此组件配置输入参数，请展开以查看相关说明。
- 打开 Dialogflow CX 控制台。
- 选择您的 Google Cloud 项目。
- 选择您的代理。
- 选择构建标签页。
- 在流部分中点击导入的组件。
- 点击页面部分中的“Start Page”。
- 点击“Start Page”中的 true 路由。
- 在“路线”窗口中，根据需要修改参数预设值。
- 点击保存。
输出参数
输出参数是在退出组件后仍保持有效状态的会话参数。这些参数包含组件收集的重要信息。此预构建组件会为以下输出参数提供值：
| 参数名称 | 说明 | 输出格式 |
|---|---|---|
| phone_number | 用户的本地手机号码（不含国家/地区代码），用于识别用户。 | 字符串 |
| all_recent_order_id | 此参数会列出与经过身份验证的用户关联的订单 ID，并按订单下单日期降序排序。数组的第一个元素表示最近的订单。如果用户没有订单，则此参数的值为 null。 |
列表（字符串） |
| 电子邮件 | 与账号关联的邮箱。 | 字符串 |
| user_first_name | 用户的名字，用于问候和确认账号所有权。 | 字符串 |
| transfer_reason | 此参数表示流程退出（如果未成功）的原因。返回的值为以下值之一：agent：最终用户在对话期间的某个时间点请求了人工客服。denial_of_information：最终用户拒绝分享组件请求的信息。max_no_input：对话达到了无输入事件的最大重试次数。请参阅无输入内置事件。max_no_match：对话已达到不匹配事件的重试次数上限。请参阅不匹配内置事件。webhook_error：发生了 webhook 错误。请参阅 webhook.error 内置事件。webhook_not_found：网络钩子网址无法访问。请参阅 webhook.error.not-found 内置事件。 |
字符串 |
基本设置
如需设置此预构建组件，请执行以下操作：
- 导入预构建组件。
- 使用描述外部服务的配置来配置提供的灵活 webhook，请参阅 Webhook 设置。
Webhook 设置
如需使用此组件，您需要配置随附的灵活网络钩子，以便从外部服务中检索所需信息。
身份验证
如果您之前未配置身份验证所需的外部服务，则需要配置这些服务，以便为此组件启用用户身份验证。如需查看详细说明，请参阅零售身份验证 webhook 设置。
获取最近购买商品的
组件使用 prebuilt_components_order_status:get_order_details webhook 检索指定订单的订单详情。
API 请求参数
以下参数由组件提供，作为 API 请求的输入。
| 参数名称 | 说明 | 输入格式 |
|---|---|---|
| $flow.order_id | 要检索详细信息的订单 ID。 | 字符串 |
API 响应参数
系统会从 API 响应中提取以下参数，供组件使用。
| 参数名称 | 说明 | 输出格式 |
|---|---|---|
| order_date | 下单日期，采用 YYYY-MM-DD 格式。 |
字符串 |
| order_time | 下单时间，采用 HH:MM 格式。 |
字符串 |
| order_status | 指明订单的状态。示例值包括 "pending"、"processing"、"in-transit"、"on-hold"、"cancelled"、"delivered"、"returned"、"partially returned"。 |
字符串 |
| order_product_name | 订单中的商品名称列表。 | 列表（字符串） |
| order_product_quantity | 订单中每种商品的订购数量总计。 | 整数 |
| order_product_count | 订单中不重复商品的数量。 | 整数 |
| order_status_notification | 指明是否为此订单启用了通知。 | 布尔值 |
| return_eligibility_date | 订单中每件商品可退货的截止日期列表，采用 YYYY-MM-DD 格式。 |
列表（字符串） |
| order_customer_billing_name | 订单的客户结算名称中的名字。 | 字符串 |
| order_latest_delivery_date | 订单中所有配送方式的预计送达日期中的最晚日期，采用 YYYY-MM-DD 格式。 |
字符串 |
| order_shipment_multiple | 指明订单是否包含多个运单。 | 布尔值 |
| order_shipment_count | 订单中的配送数量。 | 整数 |
| order_shipment_product_count | 订单中每批货物的商品总数。 | 列表（整数） |
| order_shipment_product_name | 订单中每批货物的商品名称列表。 | 列表（字符串） |
| order_estimated_delivery_date | 订单中每单发货的预计送达日期列表，采用 YYYY-MM-DD 格式。 |
列表（字符串） |
| order_shipment_status | 列出订单中每批货物的状态。示例值包括 "pending"、"processing"、"in-transit"、"on-hold"、"cancelled"、"delivered"、"returned"、"partially returned"。 |
列表（字符串） |
如需为此组件配置“获取订单详情”Webhook，请展开查看说明。
- 打开 Dialogflow CX 控制台。
- 选择您的 Google Cloud 项目。
- 选择您的代理。
- 选择管理标签页。
- 点击 Webhooks。
- 选择 prebuilt_components_order_status:get_order_details webhook。
- 将 Dialogflow CX 网络钩子网址字段中的网址替换为您要集成的服务的端点。在下拉菜单中选择适当的方法。
- 查看并更新请求正文，为您的 webhook 形成正确的请求格式。
- 查看并更新响应配置，以从 webhook 的响应中提取特定字段。请勿修改参数名称，因为组件需要这些名称来访问返回的字段值。
- 根据需要查看并更新身份验证设置。
- 点击保存。
获取重复订单
当多个订单号的后五位数字相同时，组件会使用 prebuilt_components_retail_services:get_duplicate_order webhook 检索详细信息，以区分订单。
API 请求参数
以下参数由组件提供，作为 API 请求的输入。
| 参数名称 | 说明 | 输入格式 |
|---|---|---|
| $flow.duplicate_order_id | 包含用户的一个或多个订单共有的订单号后五位的列表。 | 列表（字符串） |
API 响应参数
系统会从 API 响应中提取以下参数，供组件使用。
| 参数名称 | 说明 | 输出格式 |
|---|---|---|
| all_order_date | 具有指定最后五位数字的重复订单的订单日期列表，采用 YYYY-MM-DD 格式。此数组中的每个元素都与 all_order_time 数组中的相同元素相对应。 |
布尔值 |
| all_order_time | 最后五位数字相同的重复订单的下单时间列表，采用 HH:MM 格式。此数组中的每个元素都与 all_order_date 数组中的相同元素相对应。 |
数值 |
如需为此组件配置“获取重复订单”Webhook，请展开以查看说明。
- 打开 Dialogflow CX 控制台。
- 选择您的 Google Cloud 项目。
- 选择您的代理。
- 选择管理标签页。
- 点击 Webhooks。
- 选择 prebuilt_components_retail_services:get_duplicate_order webhook。
- 将 Dialogflow CX 网络钩子网址字段中的网址替换为您要集成的服务的端点。在下拉菜单中选择适当的方法。
- 查看并更新请求正文，为您的 webhook 形成正确的请求格式。
- 查看并更新响应配置，以从 webhook 的响应中提取特定字段。请勿修改参数名称，因为组件需要这些名称来访问返回的字段值。
- 根据需要查看并更新身份验证设置。
- 点击保存。
发送短信
该组件使用 prebuilt_components_order_status:send_sms 网络钩子通过短信将订单详情发送到指定的手机号码。
API 请求参数
以下参数由组件提供，作为 API 请求的输入。
| 参数名称 | 说明 | 输入格式 |
|---|---|---|
| $session.params.phone_number | 用户的本地手机号码（不含国家/地区代码），用于识别用户。 | 字符串 |
| $flow.order_id | 要发送订单详情的订单 ID。 | 字符串 |
如需为此组件配置“发送短信”Webhook，请展开查看相关说明。
- 打开 Dialogflow CX 控制台。
- 选择您的 Google Cloud 项目。
- 选择您的代理。
- 选择管理标签页。
- 点击 Webhooks。
- 选择 prebuilt_components_order_status:send_sms webhook。
- 将 Dialogflow CX 网络钩子网址字段中的网址替换为您要集成的服务的端点。在下拉菜单中选择适当的方法。
- 查看并更新请求正文，为您的 webhook 形成正确的请求格式。
- 查看并更新响应配置，以从 webhook 的响应中提取特定字段。请勿修改参数名称，因为组件需要这些名称来访问返回的字段值。
- 根据需要查看并更新身份验证设置。
- 点击保存。
启用通知
该组件使用 prebuilt_components_order_status:enable_notification webhook 为用户的注册手机号码启用通知。
API 请求参数
以下参数由组件提供，作为 API 请求的输入。
| 参数名称 | 说明 | 输入格式 |
|---|---|---|
| $session.params.phone_number | 用户的本地手机号码（不含国家/地区代码），用于识别用户。 | 字符串 |
| $flow.order_notification | 指明是否应为用户启用通知。 | 布尔值 |
如需为此组件配置“启用通知”Webhook，请展开查看相关说明。
- 打开 Dialogflow CX 控制台。
- 选择您的 Google Cloud 项目。
- 选择您的代理。
- 选择管理标签页。
- 点击 Webhooks。
- 选择 prebuilt_components_order_status:enable_notification 网络钩子。
- 将 Dialogflow CX 网络钩子网址字段中的网址替换为您要集成的服务的端点。在下拉菜单中选择适当的方法。
- 查看并更新请求正文，为您的 webhook 形成正确的请求格式。
- 查看并更新响应配置，以从 webhook 的响应中提取特定字段。请勿修改参数名称，因为组件需要这些名称来访问返回的字段值。
- 根据需要查看并更新身份验证设置。
- 点击保存。
完成
您的代理及其 webhook 现在应该已设置完毕，可以进行测试了。