口座の取引明細の事前構築済みコンポーネントは、お客様の認証レベルを確認し、指定された期間にわたって口座の取引明細を認証済みユーザーに送信します。お客様に複数のアカウントがある場合、コンポーネントはお客様が口座の取引明細の取得を希望している特定のアカウントを確認します。このコンポーネントは、Authentication 事前構築済みコンポーネントを使用してユーザーを認証し、カスタマイズされた生年月日収集バージョンを使用して明細書の期間の開始日と終了日を収集します。
制限事項
一般的な事前構築済みコンポーネントの制限に加えて、この事前構築済みコンポーネントには次の制限があります。
- このコンポーネントはデータを暗号化しません。
サンプル ダイアログ
次のサンプル ダイアログは、この事前構築されたコンポーネントによって処理される一般的なシナリオを示しています。サンプル ダイアログは、コンポーネントがテレフォニー経由で呼び出されたときの動作を示しています。呼び出しにより、Default Welcome Intent と会話開始時の最初のエージェント レスポンスがトリガーされます。
単一アカウント
エンドユーザーのアカウントは 1 つです。エージェントは、明細書の開始日と終了日、ユーザーが明細書の暗号化を希望するかどうかを収集し、アカウントの明細書をユーザーに送信します。
| ユーザー入力 | エージェントの応答 |
|---|---|
| エージェントが事前構築済みの 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 のいずれで受け取りますか？ |
|
| ドキュメントを共有する前に暗号化しますか？ | |
| はい | |
| パスワードの詳細は登録携帯電話で共有されます。 明細書は登録携帯電話に 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 です。 |
ブール値 |
| $session.params.card_auth_enabled | 認証タイプで説明されているように、ユーザーをカード所有者として認証する必要があるかどうかを示します。この値は、check auth level ページのページ エントリのフルフィルメントのパラメータ プリセットで構成されます。デフォルト値は false です。 |
ブール値 |
| $session.params.phone_number | （省略可）認証に使用するお客様の登録電話番号。 | 文字列 |
| $session.params.account_count | （省略可）認証されたユーザーに関連付けられているアカウントの数。 | integer |
| $session.params.last_four_digit_of_account_number | （省略可）明細書を提供する必要がある顧客アカウント番号の末尾 4 桁。お客様がお持ちのアカウントが 1 つの場合、この情報は認証後に自動的に取得されます。お客様が複数のアカウントを持っている場合は、具体的なアカウント番号をお客様から収集します。 | 文字列 |
| $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 コンソールを開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Build] タブを選択します。
- [Flows] セクションでインポートされたコンポーネントをクリックします。
- [Pages] セクションで [Start Page] をクリックします。
- スタートページで true ルートをクリックします。
- [Route] ウィンドウで、必要に応じて [Parameter Presets] 値を編集します。
- [Save] をクリックします。
出力パラメータ
出力パラメータは、コンポーネントを終了した後もアクティブな状態を継続するセッション パラメータです。これらのパラメータには、コンポーネントによって収集される重要な情報が含まれます。この事前構築されたコンポーネントは、次の出力パラメータの値を提供します。
| パラメータ名 | 説明 | 出力形式 |
|---|---|---|
| auth_level | 発信者の認証レベルを示します。 | integer |
| phone_number | ユーザーの識別に使用されるユーザーの電話番号（国コードなし）。 | 文字列 |
| account_count | 登録されている電話番号に関連付けられているアカウントの数。これらのアカウントには、自分のアカウントとユーザーが委任状を保有するアカウントが含まれます。 | integer |
| last_four_digit_of_account_number | ユーザーが 1 つのアカウントを持っている場合は、アカウント番号の末尾 4 桁が返されます。ユーザーが複数のアカウントを持っている場合、このパラメータの値は、ユーザーが口座の取引明細情報を受け取るために選択したアカウント番号の末尾 4 桁です。 | 文字列 |
| 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 の設定
このコンポーネントを使用するには、付属の柔軟な Webhook を構成して外部サービスから必要な情報を取得する必要があります。
認証
認証に必要な外部サービスをまだ構成していない場合は、このコンポーネントのユーザーの認証を有効にするようにそれらを構成する必要があります。詳細な手順については、Authentication Webhook の設定をご覧ください。
アカウントを検証
prebuilt_components_account_services:validate_account Webhook は、ユーザーの登録電話番号と指定されたアカウント番号の末尾 4 桁に基づいてアカウントが存在することを確認するためにコンポーネントによって使用されます。
アカウントが存在する場合、Webhook はアカウント残高も返します。
API リクエスト パラメータ
以下のパラメータは、コンポーネントによって API リクエストへの入力として提供されます。
| パラメータ名 | 説明 | 入力形式 |
|---|---|---|
| $session.params.phone_number | ユーザーの識別に使用されるユーザーの電話番号（国コードなし）。 | 文字列 |
| $session.params.last_four_digit_of_account_number | ユーザーが選択し、アカウントの取引明細情報の受信を確認したアカウント番号の末尾 4 桁。 | 文字列 |
API レスポンス パラメータ
以下のパラメータは、コンポーネントで使用される API レスポンスから取得されます。
| パラメータ名 | 説明 | 出力形式 |
|---|---|---|
| account_found | 提供された末尾 4 桁のアカウントが、ユーザーの登録済みアカウントに存在するかどうかを示します。 | ブール値 |
| 残高 | アカウントの現在の差引残高（存在する場合）。 | 数値 |
このコンポーネントの [アカウントを検証] Webhook を構成するには、展開して手順を確認してください。
- Dialogflow CX コンソールを開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Manage] タブを選択します。
- [Webhooks] をクリックします。
- prebuilt_components_account_services:validate_account Webhook を選択します。
- 会話エージェント（Dialogflow CX）Webhook URL フィールドの URL を、統合するサービスのエンドポイントに置き換えます。プルダウンで適切なメソッドを選択します。
- Webhook に適したリクエスト形式になるように、リクエスト本文を確認して更新します。
- レスポンス構成を確認して更新し、Webhook のレスポンスから特定のフィールドを抽出します。パラメータ名は、コンポーネントが返されたフィールド値にアクセスするために必要であるため、変更しないでください。
- 必要に応じて [Authentication] の設定を確認し、更新します。
- [Save] をクリックします。
トランザクションを取得する
prebuilt_components_account_statement:get_transactions Webhook は、コンポーネントによって、ユーザーの登録済み電話番号、アカウント番号の末尾 4 桁、明細書の期間を指定して、アカウントの取引を取得するために使用されます。
API リクエスト パラメータ
以下のパラメータは、コンポーネントによって API リクエストへの入力として提供されます。
| パラメータ名 | 説明 | 入力形式 |
|---|---|---|
| $session.params.phone_number | ユーザーの識別に使用されるユーザーの電話番号（国コードなし）。 | 文字列 |
| $session.params.last_four_digit_of_account_number | ユーザーが選択し、アカウントの取引明細情報の受信を確認したアカウント番号の末尾 4 桁。 | 文字列 |
| $flow.statement_start_date | リクエストされた明細書の開始日は「YYYY-MM-DD」形式です。 | 文字列 |
| $flow.statement_end_date | （省略可）リクエストされた明細書の開始日を「YYYY-MM-DD」形式で指定します。ユーザーまたは発信者が終了日の指定を承認しなかった場合、値はデフォルトで現在の日付になります。 | 文字列 |
API レスポンス パラメータ
以下のパラメータは、コンポーネントで使用される API レスポンスから取得されます。
| パラメータ名 | 説明 | 出力形式 |
|---|---|---|
| transactions_count | 特定の明細期間内の指定されたアカウントに対して検出された取引の数。 | integer |
このコンポーネントの [取引を取得] Webhook を構成するには、展開して手順を確認してください。
- Dialogflow CX コンソールを開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Manage] タブを選択します。
- [Webhooks] をクリックします。
- prebuilt_components_account_statement:get_transactions Webhook を選択します。
- 会話エージェント（Dialogflow CX）Webhook URL フィールドの URL を、統合するサービスのエンドポイントに置き換えます。プルダウンで適切なメソッドを選択します。
- Webhook に適したリクエスト形式になるように、リクエスト本文を確認して更新します。
- レスポンス構成を確認して更新し、Webhook のレスポンスから特定のフィールドを抽出します。パラメータ名は、コンポーネントが返されたフィールド値にアクセスするために必要であるため、変更しないでください。
- 必要に応じて [Authentication] の設定を確認し、更新します。
- [Save] をクリックします。
明細書をリクエストする
prebuilt_components_account_statement:request_statement Webhook は、コンポーネントによって、ユーザーの登録済み電話番号、アカウント番号の最後の 4 桁、明細書の期間を指定して、アカウントの明細書を送信するために使用されます。
API リクエスト パラメータ
以下のパラメータは、コンポーネントによって API リクエストへの入力として提供されます。
| パラメータ名 | 説明 | 入力形式 |
|---|---|---|
| $session.params.phone_number | ユーザーの識別に使用されるユーザーの電話番号（国コードなし）。 | 文字列 |
| $session.params.last_four_digit_of_account_number | ユーザーが選択し、アカウントの取引明細情報の受信を確認したアカウント番号の末尾 4 桁。 | 文字列 |
| $flow.statement_start_date | リクエストされた明細書の開始日は「YYYY-MM-DD」形式です。 | 文字列 |
| $flow.statement_end_date | （省略可）リクエストされた明細書の開始日を「YYYY-MM-DD」形式で指定します。ユーザーまたは発信者が終了日の指定を承認しなかった場合、値はデフォルトで現在の日付になります。 | 文字列 |
| $flow.channel_medium | メッセージを受信するためにユーザーが選択したチャネル。有効な値は、ユーザーがメールアドレスを持っているかどうかに応じて、カスタム エンティティ prebuilt_components_account_statement_channelphn と prebuilt_components_account_statement_channelall によって定義されます。デフォルトでは、email、mobile、WhatsApp がサポートされています。 |
文字列 |
| $flow.encryption_status | 指定したチャネルに送信する前に、ユーザーがドキュメントを暗号化することを望んでいるかどうかを示します。終了日の指定を承認しなかったユーザーまたは発信者によって値が指定されなかった場合、値はデフォルトで true になります。 |
ブール値 |
このコンポーネントの明細書をリクエストする Webhook を構成するには、展開して手順を確認してください。
- Dialogflow CX コンソールを開きます。
- ご自身の Google Cloud プロジェクトを選択します。
- エージェントを選択します。
- [Manage] タブを選択します。
- [Webhooks] をクリックします。
- prebuilt_components_account_statement:request_statement Webhook を選択します。
- 会話エージェント（Dialogflow CX）Webhook URL フィールドの URL を、統合するサービスのエンドポイントに置き換えます。プルダウンで適切なメソッドを選択します。
- Webhook に適したリクエスト形式になるように、リクエスト本文を確認して更新します。
- レスポンス構成を確認して更新し、Webhook のレスポンスから特定のフィールドを抽出します。パラメータ名は、コンポーネントが返されたフィールド値にアクセスするために必要であるため、変更しないでください。
- 必要に応じて [Authentication] の設定を確認し、更新します。
- [Save] をクリックします。
完了
これで、エージェントとその Webhook が設定され、テストの準備が整いました。