注文ステータスの事前構築済みコンポーネントは、お客様の認証レベルを確認し、認証済みユーザーにユーザーの最新または過去の注文に関する情報を提供します。このコンポーネントは、Retail 認証の事前構築済みコンポーネントを使用してユーザーを認証します。このコンポーネントは、呼び出し後の要約に生成ツールも使用します。
制限事項
一般的な事前構築済みコンポーネントの制限に加えて、この事前構築済みコンポーネントには次の制限があります。
- このコンポーネントはデータを暗号化しません。
サンプル ダイアログ
次のサンプル ダイアログは、この事前構築されたコンポーネントによって処理される一般的なシナリオを示しています。サンプル ダイアログは、コンポーネントがテレフォニーを使用して呼び出されたときの動作を示しています。呼び出しにより、Default Welcome Intent と会話開始時の最初のエージェント レスポンスがトリガーされます。
最近の注文
エンドユーザーが未登録の電話番号から電話をかけてきた場合、エージェントはユーザーを認証してから、注文の配送に関する詳細情報を提供します。ユーザーは、詳細情報を含む SMS を登録済みの電話番号に送信することを確認します。
| ユーザー入力 | エージェントの応答 |
|---|---|
| エージェントが事前構築済みの Retail 認証コンポーネントを使用してユーザーを認証します。 | |
| お電話いただき、ありがとうございます。2023 年 11 月 10 日午後 6 時に注文されたランプ、シャツ、その他 10 個の商品を含む John Doe 様の最新の注文についてお問い合わせですか？ | |
| はい | |
| ご注文に関する配送は 2 件あり、2024 年 1 月 15 日までに配達される予定です。 これらの配送の詳細情報をご希望ですか？ |
|
| はい | |
| ジーンズ、ベルト、その他 2 品を含む配送 1 は輸送中であり、2024 年 1 月 12 日までに配達される予定です。 ランプ、シャツ、その他 6 品を含む配送 2 は 2023 年 11 月 12 日に配達されました。 商品の詳細を記載した SMS の受け取りを希望されますか？ |
|
| はい | |
| すべての配送のステータスを追跡するためのリンクが記載された SMS をお送りしました。お電話いただき、ありがとうございます。 |
重複する注文
エンドユーザーは認証済みです。ユーザーは注文に関する情報をリクエストし、注文の末尾 5 桁を指定します。エージェントは、このユーザーが行った複数の注文が同じ末尾の 5 桁を共有していることを識別しているため、ユーザーがステータスについて尋ねることを希望している注文を確認し、注文ステータスをユーザーに伝えます。
| ユーザー入力 | エージェントの応答 |
|---|---|
| お電話いただき、ありがとうございます。2023 年 11 月 10 日午後 6 時に注文されたランプ、シャツ、その他 2 点の商品を含む Amber Doe 様の最新の注文についてお問い合わせですか？ | |
| いいえ | |
| 追跡することをご希望の注文 ID の末尾 5 桁をお知らせください。 | |
| 12355 | |
| お伺いした注文 ID の末尾 5 桁は 12355 です。よろしいですか？ | |
| はい、そうです | |
| ありがとうございます。注文 ID の収集が完了しました。 | |
| 記録によると、末尾が同じ 5 桁の 12355 である注文が 2 つ見つかりました。どの注文をお探しですか？ 2023 年 11 月 10 日午後 6 時に行われた注文番号 1 のご注文、または 2023 年 11 月 9 日午後 8 時に行われた注文番号 2 のご注文ですか？ 注文番号 1 を選択するには「1」、注文番号 2 を選択するには「2」とおっしゃってください。それ以外の場合は「いいえ」とお答えください。 |
|
| 注文 1 | |
| ご注文に関する配送は 2 件あり、2024 年 1 月 15 日までに配達される予定です。 これらの配送の詳細情報をご希望ですか？ |
|
| はい | |
| ジーンズを含む配送 1 は輸送中であり、2024 年 1 月 15 日までに配達される予定です。 ランプ、シャツ、その他 1 品を含む配送 2 はキャンセルされています。 商品の詳細を記載した SMS の受け取りを希望されますか？ |
|
| いいえ、結構です | |
| お電話いただき、ありがとうございます。 |
命名規則
この事前構築済みコンポーネントでは、次の命名規則が使用されています。
| 機能 | 形式 | 例 |
|---|---|---|
| フロー | [コンポーネント名] | 注文ステータス |
| Webhook | prebuilt_components_[component_name]:[webhook_action] | prebuilt_components_order_status:get_order_details |
入力パラメータ
入力パラメータは、コンポーネントの特定の動作を構成するために使用されるパラメータです。このパラメータは、コンポーネントの動作を決定するためにフロー内の 1 つ以上の条件によって使用されます。フロースコープのパラメータは、コンポーネントのスタートページで設定する必要があります。セッション スコープのパラメータは、呼び出しフローまたはこのコンポーネントのスタートページで設定できます。
この事前構築済みコンポーネントは、次の入力パラメータを受け入れます。
| パラメータ名 | 説明 | 入力形式 |
|---|---|---|
| $session.params.phone_number | （省略可）ユーザーの識別に使用される、国コードなしのユーザーの電話番号。 | 文字列 |
| $session.params.all_recent_order_id | （省略可）このパラメータは、認証済みユーザーに関連付けられている注文 ID を、注文の日付の降順で並べ替えてリストします。配列の最初の要素は最新の注文を表します。ユーザーの注文がない場合、このパラメータの値は null です。 |
リスト（文字列） |
| $session.params.email | （省略可）アカウントに登録されているメールアドレス。 | 文字列 |
| $session.params.user_first_name | （省略可）ユーザーの名。挨拶とアカウントの所有権の確認に使用します。 | 文字列 |
| $flow.max_shipment | ユーザーに一度に表示する配送の数を指定します。デフォルト値は 2 です。 |
integer |
| $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 です。 |
integer |
| $flow.max_retry_order_number | 注文番号を指定するときに許可される再試行回数を指定します。デフォルト値は 3 です。 |
integer |
| $flow.max_retry_another_order_id | 無効な注文番号を入力した後に許可される再試行回数を指定します。デフォルト値は 3 です。 |
integer |
このコンポーネントの入力パラメータを構成するには、開いて手順を確認します。
- Dialogflow CX Console を開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Build] タブを選択します。
- [Flows] セクションでインポートされたコンポーネントをクリックします。
- [Pages] セクションで [Start Page] をクリックします。
- スタートページで true ルートをクリックします。
- [Route] ウィンドウで、必要に応じて [Parameter Presets] 値を編集します。
- [Save] をクリックします。
出力パラメータ
出力パラメータは、コンポーネントを終了した後もアクティブな状態を継続するセッション パラメータです。これらのパラメータには、コンポーネントによって収集される重要な情報が含まれます。この事前構築されたコンポーネントは、次の出力パラメータの値を提供します。
| パラメータ名 | 説明 | 出力形式 |
|---|---|---|
| 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 URL にアクセスできませんでした。webhook.error.not-found の組み込みイベントをご覧ください。 |
文字列 |
基本設定
この事前構築済みコンポーネントを設定するには:
- 事前構築済みコンポーネントをインポートします。
- 外部サービスを記述する構成を使用して、付属の柔軟な Webhook を構成します。Webhook の設定をご覧ください。
Webhook の設定
このコンポーネントを使用するには、付属の Flexible Webhook を構成して外部サービスから必要な情報を取得する必要があります。
認証
認証に必要な外部サービスをまだ構成していない場合は、このコンポーネントのユーザーの認証を有効にするようにそれらを構成する必要があります。詳細な手順については、Retail 認証 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 | 注文内の各商品に対して注文された商品の合計数。 | integer |
| order_product_count | 1 つの注文に含まれる一意の商品の数。 | integer |
| 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 | 注文内の配送数。 | integer |
| 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 Console を開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Manage] タブを選択します。
- [Webhooks] をクリックします。
- prebuilt_components_order_status:get_order_details Webhook を選択します。
- Dialogflow CX Webhook URL フィールドの URL を、統合するサービスのエンドポイントに置き換えます。プルダウンで適切なメソッドを選択します。
- Webhook に適したリクエスト形式になるように、リクエスト本文を確認して更新します。
- レスポンス構成を確認して更新し、Webhook のレスポンスから特定のフィールドを抽出します。パラメータ名は、コンポーネントが返されたフィールド値にアクセスするために必要であるため、変更しないでください。
- 必要に応じて [Authentication] の設定を確認し、更新します。
- [Save] をクリックします。
重複する注文を取得する
prebuilt_components_retail_services:get_duplicate_order Webhook は、複数の注文番号の末尾 5 桁が同じ場合に注文を区別できるよう、詳細情報を取得するためにコンポーネントによって使用されます。
API リクエスト パラメータ
以下のパラメータは、コンポーネントによって API リクエストへの入力として提供されます。
| パラメータ名 | 説明 | 入力形式 |
|---|---|---|
| $flow.duplicate_order_id | ユーザーの 1 つ以上の注文で共有されている注文番号の末尾 5 桁を含むリスト。 | リスト（文字列） |
API レスポンス パラメータ
以下のパラメータは、コンポーネントで使用される API レスポンスから取得されます。
| パラメータ名 | 説明 | 出力形式 |
|---|---|---|
| all_order_date | 指定された末尾 5 桁を持つ重複した注文の注文日のリスト（YYYY-MM-DD 形式）。この配列内の各要素は、all_order_time 配列内の同じ要素に対応しています。 |
ブール値 |
| all_order_time | 指定された末尾 5 桁を持つ重複した注文の注文時刻のリスト（HH:MM 形式）。この配列内の各要素は、all_order_date 配列内の同じ要素に対応しています。 |
数値 |
このコンポーネントの [重複した注文を取得する] Webhook を構成するには、開いて手順を確認してください。
- Dialogflow CX Console を開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Manage] タブを選択します。
- [Webhooks] をクリックします。
- prebuilt_components_retail_services:get_duplicate_order Webhook を選択します。
- Dialogflow CX Webhook URL フィールドの URL を、統合するサービスのエンドポイントに置き換えます。プルダウンで適切なメソッドを選択します。
- Webhook に適したリクエスト形式になるように、リクエスト本文を確認して更新します。
- レスポンス構成を確認して更新し、Webhook のレスポンスから特定のフィールドを抽出します。パラメータ名は、コンポーネントが返されたフィールド値にアクセスするために必要であるため、変更しないでください。
- 必要に応じて [Authentication] の設定を確認し、更新します。
- [Save] をクリックします。
SMS を送信
prebuilt_components_order_status:send_sms Webhook は、SMS を使用して指定された電話番号に注文の詳細情報を送信するためにコンポーネントによって使用されます。
API リクエスト パラメータ
以下のパラメータは、コンポーネントによって API リクエストへの入力として提供されます。
| パラメータ名 | 説明 | 入力形式 |
|---|---|---|
| $session.params.phone_number | ユーザーの識別に使用されるユーザーの電話番号（国コードなし）。 | 文字列 |
| $flow.order_id | 注文の詳細情報を送信する対象の注文 ID。 | 文字列 |
このコンポーネントの [SMS を送信] Webhook を構成するには、開いて手順を確認してください。
- Dialogflow CX Console を開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Manage] タブを選択します。
- [Webhooks] をクリックします。
- prebuilt_components_order_status:send_sms Webhook を選択します。
- Dialogflow CX Webhook URL フィールドの URL を、統合するサービスのエンドポイントに置き換えます。プルダウンで適切なメソッドを選択します。
- Webhook に適したリクエスト形式になるように、リクエスト本文を確認して更新します。
- レスポンス構成を確認して更新し、Webhook のレスポンスから特定のフィールドを抽出します。パラメータ名は、コンポーネントが返されたフィールド値にアクセスするために必要であるため、変更しないでください。
- 必要に応じて [Authentication] の設定を確認し、更新します。
- [Save] をクリックします。
通知を有効にする
prebuilt_components_order_status:enable_notification Webhook は、ユーザーの登録済み電話番号への通知を有効にするためにコンポーネントによって使用されます。
API リクエスト パラメータ
以下のパラメータは、コンポーネントによって API リクエストへの入力として提供されます。
| パラメータ名 | 説明 | 入力形式 |
|---|---|---|
| $session.params.phone_number | ユーザーの識別に使用されるユーザーの電話番号（国コードなし）。 | 文字列 |
| $flow.order_notification | ユーザーに対して通知を有効にする必要があるかどうかを示します。 | ブール値 |
このコンポーネントの [通知を有効にする] Webhook を構成するには、開いて手順を確認してください。
- Dialogflow CX Console を開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Manage] タブを選択します。
- [Webhooks] をクリックします。
- prebuilt_components_order_status:enable_notification Webhook を選択します。
- Dialogflow CX Webhook URL フィールドの URL を、統合するサービスのエンドポイントに置き換えます。プルダウンで適切なメソッドを選択します。
- Webhook に適したリクエスト形式になるように、リクエスト本文を確認して更新します。
- レスポンス構成を確認して更新し、Webhook のレスポンスから特定のフィールドを抽出します。パラメータ名は、コンポーネントが返されたフィールド値にアクセスするために必要であるため、変更しないでください。
- 必要に応じて [Authentication] の設定を確認し、更新します。
- [Save] をクリックします。
完了
これで、エージェントとその Webhook が設定され、テストの準備が整いました。