アカウント ステートメントのビルド済みコンポーネントは、お客様の認証レベルをチェックし、指定された期間のアカウント ステートメントを認証済みのお客様に送信します。お客様が複数のアカウントを持っている場合、コンポーネントは、アカウント明細書を取得する特定のアカウントを確認します。このコンポーネントは、Authentication ビルド済みコンポーネントを使用してユーザーを認証し、カスタマイズされたバージョンの生年月日コレクションを使用して開始と明細書期間の終了日。
制限事項
一般的な事前構築済みコンポーネントの制限に加えて、この事前構築済みコンポーネントには次の制限があります。
- このコンポーネントはデータを暗号化しません。
サンプル ダイアログ
次のサンプル ダイアログは、この事前構築されたコンポーネントによって処理される一般的なシナリオを示しています。サンプル ダイアログは、コンポーネントがテレフォニー経由で呼び出されたときの動作を示しています。これにより、Default Welcome Intent と会話開始時の最初のエージェント レスポンスがトリガーされます。
単一アカウント
エンドユーザーは単一のアカウントを持っています。エージェントは、明細書の暗号化の開始日と終了日をユーザーが暗号化するかどうかを収集し、アカウントの明細書をユーザーに送信します。
| ユーザー入力 | エージェントの応答 |
|---|---|
| エージェントが事前構築済みの Authentication コンポーネントを使用してユーザーを認証します。 | |
| 認証が完了しました。 | |
| アカウントの詳細を取得するまでお待ちください。 番号に関連付けられている 1001 で終わるアカウント番号が見つかりました。 以下で始まるアカウント明細書の開始日をお知らせください。月、日、年の順です。アカウントの明細は過去 90 日間のものに限られます。 |
|
| エージェントは、生年月日のビルド済みコンポーネントを使用して明細書の開始日を収集します。 | |
| 明細書の開始日を収集しました。 アカウント明細書の日付を月、日、年の順に記載してください。アカウントの明細は過去 90 日間のものに限られます。 |
|
| ビルド日のビルド済みコンポーネントを使用して明細書の終了日を収集する | |
| ありがとうございました。2023 年 7 月 12 日から 2023 年 7 月 24 日までのアカウントの明細書をお探しですか？ | |
| はい | |
| 明細書の詳細を取得している間お待ちください。 2023 年 7 月 12 日～ 2023 年 7 月 24 日のトランザクションが見つかりました。メール、SMS、WhatsApp などのメールのどちらで受け取りますか？ |
|
| SMS | |
| ドキュメントを共有できる前に暗号化しますか？ | |
| 同意しない | |
| 明細書は、登録済みのモバイルから 15 分以内に届きます。 |
複数のアクセス方法
エンドユーザーは複数のアカウントを持っています。エージェントは、ユーザーがアカウント ステートメントをリクエストするアカウントを確認します。エージェントは、明細書の暗号化の開始日と終了日をユーザーが暗号化するかどうかを収集し、アカウントの明細書をユーザーに送信します。
| ユーザー入力 | エージェントの応答 |
|---|---|
| エージェントが事前構築済みの Authentication コンポーネントを使用してユーザーを認証します。 | |
| ありがとうございます。認証が完了しました。 | |
| アカウントの詳細を取得する間、お待ちください。 番号に関連付けられているアカウントが 2 つあります。 言及しているアカウントの最後の 4 桁をお知らせください。 |
|
| 2002 | |
| 受け取ったアカウント番号の最後の 4 桁は 2002 ですか？ | |
| はい | |
| アカウント ステートメントの開始日（月、日、年）を指定してください。アカウントの明細は過去 90 日間のものに限られます。 | |
| エージェントは、生年月日のビルド済みコンポーネントを使用して明細書の開始日を収集します。 | |
| 明細書の開始日を収集しました。 アカウント明細書の日付を月、日、年の順に記載してください。アカウントの明細は過去 90 日間のものに限られます。 |
|
| ビルド日のビルド済みコンポーネントを使用して明細書の終了日を収集する | |
| ありがとうございました。2023 年 7 月 18 日から 2023 年 7 月 22 日までのアカウント明細書をお探しですか？ | |
| はい | |
| 明細書の詳細を取得している間お待ちください。 2023 年 7 月 18 日から 2023 年 7 月 22 日までのトランザクションが見つかりました。メール、SMS、WhatsApp などのメールのどちらで受け取りますか？ |
|
| ドキュメントを共有できる前に暗号化しますか？ | |
| はい | |
| パスワードの詳細は登録済みの WhatsApp で共有されます。 明細書は登録済みの WhatsApp で 15 分以内に送信されます。 |
命名規則
この事前構築済みコンポーネントでは、次の命名規則が使用されています。
| 特徴 | 形式 | 例 |
|---|---|---|
| フロー | [コンポーネント名] | アカウントの明細 |
| コンポーネント固有のインテント | prebuilt_components_[component_name]_[intent_name] | prebuilt_components_account_number_collection_four_digit_account_number |
| エンティティ タイプ | prebuilt_components_[component_name]_[entity_type] | prebuilt_components_account_statement_channelall |
| Webhook | prebuilt_components_[component_name]:[webhook_action] | prebuilt_components_account_statement:request_statement |
入力パラメータ
入力パラメータは、コンポーネントの特定の動作を構成するために使用されるパラメータです。このパラメータは、コンポーネントの動作を決定するためにフロー内の 1 つ以上の条件によって使用されます。フロースコープのパラメータは、後述するように、コンポーネントのスタートページで設定する必要があります。セッション スコープのパラメータは、呼び出しフローまたはこのコンポーネントのスタートページで設定できます。
この事前構築済みコンポーネントは、次の入力パラメータを受け入れます。
| パラメーター名 | 説明 | 入力形式 |
|---|---|---|
| $session.params.auth_level | （省略可）発信者の認証レベルを示します。 | integer |
| $session.params.auth_level_req | ユーザーがアカウント ステートメントにアクセスする前に、必要な認証レベルを示します。この値は、check auth level ページのページ エントリのフルフィルメントのパラメータ プリセットで構成します。デフォルト値は 1 です。 |
整数 |
| $session.params.account_auth_enabled | 認証タイプで説明されているように、ユーザーをアカウント所有者として認証する必要があるかどうかを示します。この値は、check auth level ページのページ エントリのフルフィルメントのパラメータ プリセットで構成されます。デフォルト値は true です。 |
boolean |
| $session.params.card_auth_enabled | 認証タイプで説明されているように、ユーザーをカード所有者として認証する必要があるかどうかを示します。この値は、check auth level ページのページ エントリのフルフィルメントのパラメータ プリセットで構成されます。デフォルト値は false です。 |
boolean |
| $session.params.phone_number | （省略可）認証に使用するお客様の登録電話番号。 | string |
| $session.params.account_count | （省略可）認証済みユーザーに関連付けられているアカウントの数。 | integer |
| $session.params.last_four_digit_of_account_number | （省略可）明細書を入力する必要があるお客様アカウント番号の下 4 桁。お客様が単一のアカウントを持っている場合、この情報は認証後に自動的に取得されます。お客様が複数のアカウントを持っている場合は、特定のアカウント番号がお客様から取得されます。 | string |
| $session.params.account_statement_max_days | ステートメントの開始日に許可される現在の日付までの最大日数を指定します。デフォルトでは、この値は -90 であり、ステートメントの開始日が現在の日付から 90 日以内であれば開始できます。このパラメータは、スタートページの true ルートで構成されます。 |
integer |
| $flow.max_retry_count | 有効なステートメント終了日の入力をエンドユーザーに求める際に許可される再試行回数を指定します。デフォルト値は 3 です。 |
integer |
| $flow.max_retry_confirm_period_counter | エンドユーザーとともにステートメント期間を確認するときに許可される再試行回数を指定します。デフォルト値は 3 です。 |
integer |
| $flow.max_retry_statement_counter | 指定されたステートメント期間がトランザクションを取得しない場合に許可される再試行回数を指定します。デフォルト値は 3 です。 |
integer |
このコンポーネントの入力パラメータを構成するには、開いて手順を確認します。
- Dialogflow CX Console を開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [ビルド] タブを選択します。
- [フロー] セクションでインポートされたコンポーネントをクリックします。
- [ページ] セクションで [スタートページ] をクリックします。
- スタートページで [true ルート] をクリックします。
- [ルート] ウィンドウで、必要に応じて [パラメータのプリセット] 値を編集します。
- [Save] をクリックします。
出力パラメータ
出力パラメータは、コンポーネントを終了した後もアクティブな状態を継続するセッション パラメータです。これらのパラメータには、コンポーネントによって収集される重要な情報が含まれます。この事前構築されたコンポーネントは、次の出力パラメータの値を提供します。
| パラメーター名 | 説明 | 出力形式 |
|---|---|---|
| auth_level | 発信者の認証レベルを示します。 | integer |
| phone_number | ユーザーの識別に使用されるユーザーの電話番号（国コードなし）。 | string |
| account_count | 登録されている電話番号に関連付けられているアカウントの数。これらのアカウントには、自分のアカウントとユーザーが委任状を保有するアカウントが含まれます。 | integer |
| last_four_digit_of_account_number | ユーザーが 1 つのアカウントを持っている場合は、アカウント番号の最後の 4 桁が返されます。ユーザーが複数のアカウントを持っている場合、このパラメータの値は、ユーザーがアカウント明細書情報を受け取るように選択したアカウント番号の最後の 4 桁です。 | string |
| 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 の組み込みイベントをご覧ください。 |
string |
基本設定
この事前構築済みコンポーネントを設定するには:
- 事前構築済みコンポーネントをインポートします。
- Dialogflow 外部サービスを記述する構成を使用して、付属の フレキシブル Webhook を構成します。以下の Webhook の設定をご覧ください。
Webhook の設定
このコンポーネントを使用するには、付属の Flexible Webhook を構成して外部サービスから必要な情報を取得する必要があります。
Authentication
認証に必要な外部サービスをまだ構成していない場合は、このコンポーネントのユーザーの認証を有効にするようにそれらを構成する必要があります。詳細な手順については、Authentication Webhook の設定をご覧ください。
アカウントを検証
prebuilt_components_account_services:validate_account Webhook は、ユーザーの登録電話番号と指定されたアカウント番号の末尾 4 桁に基づいてアカウントが存在することを確認するためにコンポーネントによって使用されます。
アカウントが存在する場合、Webhook はアカウント残高も返します。
API リクエストのパラメータ
以下のパラメータは、コンポーネントによって API リクエストへの入力として提供されます。
| パラメーター名 | 説明 | 入力形式 |
|---|---|---|
| $session.params.phone_number | ユーザーの識別に使用されるユーザーの電話番号（国コードなし）。 | string |
| $session.params.last_four_digit_of_account_number | ユーザーが選択してアカウント明細書情報を受け取ることが確認されたアカウント番号の最後の 4 桁。 | string |
API レスポンス パラメータ
以下のパラメータは、コンポーネントで使用される API レスポンスから取得されます。
| パラメーター名 | 説明 | 出力形式 |
|---|---|---|
| account_found | 提供された末尾 4 桁のアカウントが、ユーザーの登録済みアカウントに存在するかどうかを示します。 | boolean |
| 残高 | アカウントの現在の差引残高（存在する場合）。 | 数値 |
このコンポーネントの [アカウントを検証] Webhook を構成するには、展開して手順を確認してください。
- Dialogflow CX Console を開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Manage] タブを選択します。
- [Webhooks] をクリックします。
- prebuilt_components_account_services:validate_account webhook を選択します。
- Dialogflow Webhook URL フィールドの URL を、統合するサービスのエンドポイントに置き換えます。プルダウンで適切なメソッドを選択します。
- Webhook に適したリクエスト形式になるように、[リクエスト本文] を確認して更新します。
- レスポンス構成を確認して更新し、Webhook のレスポンスから特定のフィールドを抽出します。パラメータ名は、コンポーネントが返されたフィールド値にアクセスするために必要であるため、変更しないでください。
- 必要に応じて [認証] の設定を確認し、更新します。
- [保存] をクリックします。
トランザクションを取得する
prebuilt_components_account_statement:get_transactions Webhook は、ユーザーが登録した電話番号、アカウント番号の最後の 4 桁、明細書期間に基づいて、アカウントのトランザクションを取得するためにコンポーネントで使用されます。
API リクエスト パラメータ
以下のパラメータは、コンポーネントによって API リクエストへの入力として提供されます。
| パラメーター名 | 説明 | 入力形式 |
|---|---|---|
| $session.params.phone_number | ユーザーの識別に使用されるユーザーの電話番号（国コードなし）。 | string |
| $session.params.last_four_digit_of_account_number | ユーザーが選択してアカウント明細書情報を受け取ることが確認されたアカウント番号の最後の 4 桁。 | string |
| $flow.statement_start_date | リクエストされた明細書の開始日は「YYYY-MM-DD」形式です。 | string |
| $flow.statement_end_date | （省略可）リクエストされた明細書の開始日を「YYYY-MM-DD」形式で指定します。ユーザーまたは発信者が終了日の指定を承認しなかった場合、値はデフォルトで現在の日付になります。 | string |
API レスポンス パラメータ
以下のパラメータは、コンポーネントで使用される API レスポンスから取得されます。
| パラメーター名 | 説明 | 出力形式 |
|---|---|---|
| transactions_count | 指定されたステートメント期間中に指定されたアカウントで検出されたトランザクションの数。 | integer |
このコンポーネントの [取引を取得] Webhook を構成するには、展開して手順を確認してください。
- Dialogflow CX Console を開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Manage] タブを選択します。
- [Webhooks] をクリックします。
- prebuilt_components_account_statement:get_transactions Webhook を選択します。
- Dialogflow Webhook URL フィールドの URL を、統合するサービスのエンドポイントに置き換えます。プルダウンで適切なメソッドを選択します。
- Webhook に適したリクエスト形式になるように、[リクエスト本文] を確認して更新します。
- レスポンス構成を確認して更新し、Webhook のレスポンスから特定のフィールドを抽出します。パラメータ名は、コンポーネントが返されたフィールド値にアクセスするために必要であるため、変更しないでください。
- 必要に応じて [認証] の設定を確認し、更新します。
- [保存] をクリックします。
リクエスト ステートメント
prebuilt_components_account_statement:request_statement Webhook は、コンポーネントによって、ユーザーの登録済み電話番号、アカウント番号の最後の 4 桁、明細書の期間を指定して、アカウントの明細書を送信するために使用されます。
API リクエスト パラメータ
以下のパラメータは、コンポーネントによって API リクエストへの入力として提供されます。
| パラメーター名 | 説明 | 入力形式 |
|---|---|---|
| $session.params.phone_number | ユーザーの識別に使用されるユーザーの電話番号（国コードなし）。 | string |
| $session.params.last_four_digit_of_account_number | ユーザーが選択してアカウント明細書情報を受け取ることが確認されたアカウント番号の最後の 4 桁。 | string |
| $flow.statement_start_date | リクエストされた明細書の開始日は「YYYY-MM-DD」形式です。 | string |
| $flow.statement_end_date | （省略可）リクエストされた明細書の開始日を「YYYY-MM-DD」形式で指定します。ユーザーまたは発信者が終了日の指定を承認しなかった場合、値はデフォルトで現在の日付になります。 | string |
| $flow.channel_medium | メッセージを受信するためにユーザーが選択したチャネル。有効な値は、ユーザーがメールアドレスを持っているかどうかに応じて、カスタム エンティティ prebuilt_components_account_statement_channelphn と prebuilt_components_account_statement_channelall によって定義されます。デフォルトでは、email、mobile、WhatsApp がサポートされています。 |
string |
| $flow.encryption_status | 指定したチャネルに送信する前に、ユーザーがドキュメントを暗号化することを望んでいるかどうかを示します。終了日の指定を承認しなかったユーザーまたは発信者によって値が指定されなかった場合、値はデフォルトで true になります。 |
ブール値 |
このコンポーネントのリクエスト ステートメント Webhook を構成するには、展開して手順をご覧ください。
- Dialogflow CX Console を開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Manage] タブを選択します。
- [Webhooks] をクリックします。
- prebuilt_components_account_statement:request_statement Webhook を選択します。
- Dialogflow Webhook URL フィールドの URL を、統合するサービスのエンドポイントに置き換えます。プルダウンで適切なメソッドを選択します。
- Webhook に適したリクエスト形式になるように、[リクエスト本文] を確認して更新します。
- レスポンス構成を確認して更新し、Webhook のレスポンスから特定のフィールドを抽出します。パラメータ名は、コンポーネントが返されたフィールド値にアクセスするために必要であるため、変更しないでください。
- 必要に応じて [認証] の設定を確認し、更新します。
- [Save] をクリックします。
完了
これで、エージェントとその Webhook が設定され、テストの準備が整いました。