取消訂購預先建構的元件

取消訂單預建元件會檢查使用者的驗證層級。使用者通過驗證後，元件會提供使用者最近或過去的訂單資訊。使用者可以選擇取消整筆訂單，或取消訂單中的特定商品。這個元件會使用零售驗證預先建構元件來驗證使用者。這個元件也會使用生成器，在通話後生成摘要。

限制

除了常見的預建元件限制外，這項預建元件還有下列限制：

• 這個元件不會加密任何資料。

對話範例

下列對話範例說明這項預建元件處理的常見情境。範例對話會示範使用電話呼叫元件時的行為，這會觸發預設歡迎意圖和對話開始時的第一個代理回覆。

取消近期訂單中的單一產品

使用者先前已通過驗證。服務專員會確認要取消最近一筆訂單中的哪些商品。服務專員會檢查原始付款方式，並與使用者確認取消詳情。

使用者輸入內容	代理回覆
	你來電詢問的是否為最近一筆訂單？訂單編號結尾為 12978，內含 5 個水壺和 1 件 T 恤，下單時間為 2023-11-09 晚上 8 點。
是
	我們在你的訂單中找到一些符合資格的產品。請告訴我你想取消哪項產品。 產品 1：Google 水瓶，產品 2：Google T 恤。 請說出或輸入你想選取的產品編號，或說「下一個」查看更多產品。
下一個
	我們在記錄中找不到任何其他項目。請從分享的清單中選擇。 產品 1：Google 水瓶，產品 2：Google T 恤。 請說出或輸入要選取的產品編號，或說「下一個」查看更多產品。
1
	確認一下，您想取消 Google 水瓶。請問是否正確？
是
	可以看到所選產品的可用數量為 5。請指定要取消的產品數量。
4
	請說明取消原因。你可以說「改變心意」、「不再需要」、「我想購買其他商品」、「延遲出貨」、「不小心買錯」、「想變更付款方式」或「其他」。
我想購買其他商品
	感謝告知。 是否要取消其他產品？
否
	如果使用錢包購物，退款會退回錢包或 Google 商店消費金帳戶。退款會在 3 到 5 個工作天內入帳。請注意，退款金額不含運費和處理費用。

取消整筆訂單

使用者先前已通過驗證。確認使用者想取消特定訂單，並收集取消原因。服務專員會檢查原始付款方式，並與使用者確認取消詳情。

使用者輸入內容	代理回覆
	你來電詢問的是否為最近一筆訂單？訂單編號末碼為 12345，內含 1 件襯衫，下單時間為 2023-11-10 下午 6 點。
否
	要取消其他訂單嗎？
是
	能否請你提供要追蹤的訂單 ID 末 5 碼？
12346
	我們取得的訂單 ID 末五碼是 12346，請問是否正確？
是
	好的，我們已收集到訂單 ID。 請問你要取消整筆訂單嗎？
是
	請說明取消原因。你可以說「改變心意」、「不再需要」、「我想購買其他商品」、「延遲出貨」、「不小心買錯」、「想變更付款方式」或「其他」。
不再需要
	感謝告知。 我們已產生取消要求。

命名慣例

這個預建元件採用下列命名慣例：

功能	格式	範例
Flow	[Component Name]	取消訂單
實體類型	prebuilt_components_[component_name]_[entity_type]	prebuilt_components_product_cancel_reason
Webhook	prebuilt_components_[component_name]:[webhook_action]	prebuilt_components_cancel_order:post_cancellation_details

輸入參數

輸入參數是用來設定元件的特定行為。流程中的一或多個條件會使用這些參數，決定元件的行為。流程範圍參數必須在元件的起始頁面上設定。以工作階段為範圍的參數可由呼叫流程設定，或在這個元件的起始頁面上設定。

這個預建元件接受下列輸入參數：

參數名稱	說明	輸入格式
$session.params.phone_number	(選用) 使用者的當地電話號碼 (不含國家/地區代碼)，用於識別使用者。	字串
$session.params.all_recent_order_id	(選用) 這個參數會列出與已驗證使用者相關聯的訂單 ID，並依訂單日期遞減排序。陣列的第一個元素代表最近的訂單。如果使用者沒有訂單，這個參數的值會是 null。	清單 (字串)
$session.params.email	(選用) 帳戶註冊的電子郵件地址。	字串
$session.params.user_first_name	(選用) 使用者的名字，用於問候及確認帳戶擁有權。	字串

這個預建元件允許使用下列選用參數，設定元件的行為，包括重試。

參數名稱	說明	格式
$flow.max_retry_another_account_counter	指定選擇是否要繼續使用替代帳戶時，允許的重試次數。預設值為 2。	整數
$flow.max_retry_order_number	指定提供訂單編號末五碼時，允許的重試次數。預設值為 2。	整數
$flow.max_retry_another_order	指定在找不到訂單 ID 或訂單不符合取消資格時，選取其他訂單的重試次數。預設值為 2。	整數
$flow.max_retry_select_order_number	指定在多筆訂單末五碼相同的情況下，提供完整訂單號碼時允許的重試次數。預設值為 2。	整數
$flow.max_product_display_counter	指定單次對話中最多可顯示的產品數量。預設值為 2。	整數
$flow.max_product_display	指定整個對話中最多可顯示的產品數量。預設值為 9。	整數
$flow.max_retry_product_number_counter	指定選取要取消的產品時，允許的重試次數上限。預設值為 2。	整數
$flow.max_product_cancel_confirm_counter	指定確認所選產品時，允許的重試次數上限。預設值為 2。	整數
$flow.max_retry_select_quantity	指定選取要取消的產品數量時，允許的重試次數上限。預設值為 2。	整數
$flow.order_product_cancel_reason_others	指定 prebuilt_components_product_cancel_reason 實體的值，表示使用者選取了「其他」取消原因。預設值為 "others"。	字串
$flow.max_retry_cancel_reason	指定確認取消原因時允許的重試次數。預設值為 2。	整數
$flow.order_payment_mode_COD	指定 get_order_details Webhook 傳回的 order_payment_mode 欄位值，表示貨到付款 (COD) 付款方式。預設值為 "COD"。	字串
$flow.order_payment_mode_store_credit	指定 get_order_details Webhook 傳回的 order_payment_mode 欄位值，表示 Google 商店消費金付款方式。預設值為 "store_credit"。	字串

輸出參數

輸出參數是工作階段參數，在退出元件後仍會保持有效。這些參數包含元件收集的重要資訊。這個預建元件會提供下列輸出參數的值：

參數名稱	說明	輸出格式
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 網址。請參閱「webhook.error.not-found 內建事件」。	字串

生成器

這個元件會使用生成器，啟用對話的特定部分。

摘要

Summarization 生成器用於生成通話後摘要，說明元件處理的對話。

基本設定

如要設定這項預建元件，請按照下列步驟操作：

1. 匯入預先建構的元件。
2. 使用描述外部服務的設定，設定提供的彈性 Webhook，請參閱「Webhook 設定」。

Webhook 設定

如要使用這個元件，您必須設定內含的彈性 Webhook，從外部服務擷取所需資訊。

驗證

如果您先前未設定驗證所需的外部服務，則必須設定這些服務，才能為這個元件啟用使用者驗證功能。如需詳細操作說明，請參閱「零售驗證 Webhook 設定」。

提供符合條件的訂單詳細資料：

元件會使用 prebuilt_components_cancel_order:get_order_details Webhook 擷取指定訂單的詳細資料。

API 要求參數

元件會提供下列參數，做為 API 要求的輸入內容。

參數名稱	說明	輸入格式
$flow.order_id	要擷取詳細資料的訂單 ID。	字串

API 回應參數

系統會從 API 回應中擷取下列參數，供元件使用。

參數名稱	說明	輸出格式
order_date	下單日期，格式為 YYYY-MM-DD。	字串
order_time	下單時間，格式為 HH:MM。	字串
order_product_count	訂單中不重複產品的數量。	整數
order_payment_mode	指出下單時使用的付款模式。	字串
cancelable_product_id	訂單中可取消產品的產品 ID 清單。	清單 (字串)
cancelable_product_name	訂單中可取消產品的名稱清單。	清單 (字串)
cancelable_product_brand_name	訂單中可取消產品的品牌名稱清單。	清單 (字串)
cancelable_product_quantity	訂單中可取消產品的數量清單。	清單 (字串)

取得重複訂單詳細資料

元件會使用 prebuilt_components_retail_services:get_duplicate_order_details 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 陣列中的相同元素。	清單 (字串)

取消後詳細資料

元件會使用 prebuilt_components_cancel_order:post_cancellation_details Webhook 提交取消要求。

API 要求參數

元件會提供下列參數，做為 API 要求的輸入內容。

參數名稱	說明	輸入格式
$session.params.phone_number	使用者的當地電話號碼 (不含國家/地區代碼)，用於識別使用者。	字串
$flow.order_id	要提交支援單的訂單 ID。	字串
$flow.cancel_product_id_list	使用者想取消的產品 ID 清單。	清單 (字串)
$flow.cancel_product_quantity_list	使用者想取消的產品數量清單，對應 $flow.cancel_product_id_list 中的每個元素。	清單 (字串)
$flow.cancel_reason_list	每項取消產品的取消原因清單，對應 $flow.cancel_product_id_list 中的每個元素。	清單 (字串)
$flow.order_refund_mode	退款的付款模式。有效值由 prebuilt_components_cancel_mode_of_refund 實體定義。	字串

API 回應參數

系統會從 API 回應中擷取下列參數，供元件使用。

參數名稱	說明	輸出格式
order_cancellation_ticket_id	已提交取消要求的支援單 ID。	字串

完成

代理和 Webhook 應已設定完成，可以開始測試。