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