Account statement prebuilt component

The account statement prebuilt component checks a customer's authentication level, then sends the account statement for a specified period of time to an authenticated customer. If the customer has multiple accounts, the component confirms the specific account the customer would like to retrieve an account statement for. This component uses the Authentication prebuilt component to authenticate users and uses a customized version of Date of birth collection to collect start and end dates for the statement period.

Limitations

In addition to the common prebuilt component limitations, this prebuilt component has the following limitations:

  • This component does not encrypt any data.

Sample dialogs

The following sample dialogs demonstrate common scenarios handled by this prebuilt component. The sample dialogs demonstrate behavior when the component is called via telephony, which triggers the Default Welcome Intent and the first agent response at the start of the conversation.

Single account

End-user has a single account. The agent collects the statement start and end dates, whether the user would like to encrypt the statement, and sends the account statement to the user.

User input Agent response
Agent authenticates user using Authentication prebuilt component
Thank you, you have been successfully authenticated.
Please wait while we are fetching your account details.

We have found an account number ending with 1001 associated with your number.

Please provide the account statement start date, starting with the month, followed by day and then year. Please note that the account statement period will be provided only for the last 90 days.
Agent collects statement start date using Date of birth prebuilt component
Great, we have collected your statement start date.

Please provide the account statement end date, starting with the month, followed by day and then year. Please note that the account statement period will be provided only for the last 90 days.
Agent collects statement end date using Date of birth prebuilt component
Thank you. Please confirm if you are looking for the account statement between 2023-07-12 to 2023-07-24?
Yes
Please wait while we are fetching your statement details.

We found transactions from 2023-07-12 to 2023-07-24. Would you like to receive it via email, SMS or WhatsApp?
SMS
Do you want to encrypt the document before we share it with you?
No thanks
You will receive the statement within 15 minutes on your registered mobile.

Multiple accounts

End-user has multiple accounts; the agent confirms which account the user is requesting an account statement for. The agent collects the statement start and end dates, whether the user would like to encrypt the statement, and sends the account statement to the user.

User input Agent response
Agent authenticates user using Authentication prebuilt component
Thank you, you have been successfully authenticated.
Please wait while we are fetching your account details.

We have found that there are 2 accounts associated with your number.

Can you please help us with the last 4 digits of the account you are referring to?
2002
The last four digits of the account number that we got are 2002, is that correct?
yes
Please provide the account statement start date, starting with the month, followed by day and then year. Please note that the account statement period will be provided only for the last 90 days.
Agent collects statement start date using Date of birth prebuilt component
Great, we have collected your statement start date.

Please provide the account statement end date, starting with the month, followed by day and then year. Please note that the account statement period will be provided only for the last 90 days.
Agent collects statement end date using Date of birth prebuilt component
Thank you. Please confirm if you are looking for the account statement between 2023-07-18 to 2023-07-22?
Yes
Please wait while we are fetching your statement details.

We found transactions from 2023-07-18 to 2023-07-22. Would you like to receive it via email, SMS or WhatsApp?
WhatsApp
Do you want to encrypt the document before we share it with you?
Yes
Password details will be shared on your registered WhatsApp.

You will receive the statement within 15 minutes on your registered WhatsApp.

Naming conventions

This prebuilt component uses the following naming conventions:

Feature Format Example
Flow [Component Name] Account Statement
Component Specific Intent prebuilt_components_[component_name]_[intent_name] prebuilt_components_account_number_collection_four_digit_account_number
Entity Type prebuilt_components_[component_name]_[entity_type] prebuilt_components_account_statement_channelall
Webhook prebuilt_components_[component_name]:[webhook_action] prebuilt_components_account_statement:request_statement

Input parameters

Input parameters are parameters that are used to configure certain behaviors of the component. The parameters will be used by one or more conditions within the flow to determine how the component should behave. Flow-scoped parameters must be set on the start page of the component as described below. Session-scoped parameters may be set either by a calling flow, or on the start page of this component.

This prebuilt component accepts the following input parameters:

Parameter Name Description Input Format
$session.params.auth_level (optional) Indicates the authentication level of the caller. integer
$session.params.auth_level_req Indicates the level of authentication needed before a user can access their account statement. This value is configured in the parameter presets of the page entry fulfillment in the check auth level page. By default this value is 1. integer
$session.params.phone_number (optional) Customer's registered phone number used for authentication. string
$session.params.account_count (optional) Number of accounts associated with the authenticated user. integer
$session.params.last_four_digit_of_account_number (optional) Last four digits of the customer account number for which the statement needs to be provided. If the customer has a single account, this information is retrieved automatically post authentication. If the customer has multiple accounts, the specific account number is collected from the customer. string
$session.params.account_statement_max_days Specifies the maximum number of days before the current date allowed for a statement start date. By default, this value is -90, indicating that statement start dates may start no more than 90 days before the current date. This parameter is configured in the start page true route. integer
$flow.max_retry_count Specifies the number of retries allowed when prompting the end-user to provide a valid statement end date. The default value is 3. integer
$flow.max_retry_confirm_period_counter Specifies the number of retries allowed when confirming the statement period with the end-user. The default value is 3. integer
$flow.max_retry_statement_counter Specifies the number of retries allowed when the provided statement period does not retrieve any transactions. The default value is 3. integer

To configure the input parameters for this component, expand for instructions.

  1. Open the Dialogflow CX Console.
  2. Choose your Google Cloud project.
  3. Select your agent.
  4. Select the Build tab.
  5. Click the imported component in the Flows section.
  6. Click the Start Page in the Pages section.
  7. Click the true Route in the Start Page.
  8. In the Route window, edit the Parameter Presets values as needed.
  9. Click Save.

Output parameters

Output parameters are session parameters that will remain active after exiting the component. These parameters contain important information collected by the component. This prebuilt component provides values for the following output parameters:

Parameter Name Description Output Format
auth_level Indicates the authentication level of the caller. integer
phone_number User's local phone number, without the country code, used to identify the user. string
account_count The number of accounts associated with the registered telephone number. These accounts include self-accounts and accounts for which the user has power of attorney. integer
last_four_digit_of_account_number If a user has a single account, the last four digits of the account number are returned. If a user has more than one account, the value of this parameter is the last four digits of the account number the user selected to receive account statement information for. string
transfer_reason This parameter indicates the reason the flow exited, if it was not successful. The returned value is one of:

agent: the end-user requested a human agent at some point during the conversation.

denial_of_information: the end-user declined to share information requested by the component.

max_no_input: the conversation reached the maximum number of retries for no-input events. See no-input built-in events.

max_no_match: the conversation reached the maximum number of retries for no-match events. See no-match built-in events.

webhook_error: a webhook error occurred. See webhook.error built-in event.

webhook_not_found: a webhook URL was unreachable. See webhook.error.not-found built-in event.
string

Basic setup

To set up this prebuilt component:

  1. Import the prebuilt component.
  2. Configure the provided flexible webhooks with configuration describing your Dialogflow-external services, see Webhook setup below.

Webhook setup

In order to use this component, you will need to configure the included flexible webhooks to retrieve needed information from your external services.

Authentication

If you have not previously configured external services required for authentication, you will need to configure them to enable authentication of users for this component. See Authentication webhook setup for detailed instructions.

Validate account

The prebuilt_components_account_statement:validate_account webhook is used by the component to verify that an account exists based on the user's registered phone number and the last four digits of the account number provided.

API request parameters

The following parameters are provided by the component as inputs to the API request.

Parameter Name Description Input Format
$session.params.phone_number User's local phone number, without the country code, used to identify the user. string
$session.params.last_four_digit_of_account_number The last four digits of the account number the user selected and confirmed to receive account statement information for. string

API response parameters

The following parameters are pulled from the API response to be used by the component.

Parameter Name Description Output Format
account_found Indicates whether an account with the provided last four digits exists for the user's registered account. boolean

To configure the Validate account webhook for this component, expand for instructions.

  1. Open the Dialogflow CX Console.
  2. Choose your Google Cloud project.
  3. Select your agent.
  4. Select the Manage tab.
  5. Click Webhooks.
  6. Select the prebuilt_components_account_statement:validate_account webhook.
  7. Replace the URL in the Dialogflow Webhook URL field with the endpoint for the service you want to integrate with. Select the proper Method in the dropdown.
  8. Review and update the Request body to form the proper request format for your webhook.
  9. Review and update the Response configuration to extract specific fields from your webhook's response. Do not modify the parameter names, as these are required by the component to access the returned field values.
  10. Review and update the Authentication settings as needed.
  11. Click Save.

Get transactions

The prebuilt_components_account_statement:get_transactions webhook is used by the component to retrieve the transactions for an account given the user's registered phone number, the last four digits of the account number, and the statement period.

API request parameters

The following parameters are provided by the component as inputs to the API request.

Parameter Name Description Input Format
$session.params.phone_number User's local phone number, without the country code, used to identify the user. string
$session.params.last_four_digit_of_account_number The last four digits of the account number the user selected and confirmed to receive account statement information for. string
$flow.statement_start_date The requested statement start date in "YYYY-MM-DD" format. string
$flow.statement_end_date (optional) The requested statement start date in "YYYY-MM-DD" format. If no value is provided by the user or caller declines to provide an end date, the value defaults to the current date. string

API response parameters

The following parameters are pulled from the API response to be used by the component.

Parameter Name Description Output Format
transactions_count The number of transactions found for the specified account in the given statement period. integer

To configure the Get transactions webhook for this component, expand for instructions.

  1. Open the Dialogflow CX Console.
  2. Choose your Google Cloud project.
  3. Select your agent.
  4. Select the Manage tab.
  5. Click Webhooks.
  6. Select the prebuilt_components_account_statement:get_transactions webhook.
  7. Replace the URL in the Dialogflow Webhook URL field with the endpoint for the service you want to integrate with. Select the proper Method in the dropdown.
  8. Review and update the Request body to form the proper request format for your webhook.
  9. Review and update the Response configuration to extract specific fields from your webhook's response. Do not modify the parameter names, as these are required by the component to access the returned field values.
  10. Review and update the Authentication settings as needed.
  11. Click Save.

Request statement

The prebuilt_components_account_statement:request_statement webhook is used by the component to send a statement for an account to a selected channel given the user's registered phone number, the last four digits of the account number, and the statement period.

API request parameters

The following parameters are provided by the component as inputs to the API request.

Parameter Name Description Input Format
$session.params.phone_number User's local phone number, without the country code, used to identify the user. string
$session.params.last_four_digit_of_account_number The last four digits of the account number the user selected and confirmed to receive account statement information for. string
$flow.statement_start_date The requested statement start date in "YYYY-MM-DD" format. string
$flow.statement_end_date (optional) The requested statement start date in "YYYY-MM-DD" format. If no value is provided by the user or caller declines to provide an end date, the value defaults to the current date. string
$flow.channel_medium The channel the user has selected to receive the message on. Valid values are defined by the prebuilt_components_account_statement_channelphn and prebuilt_components_account_statement_channelall custom entities, depending on whether the user has a registered email. By default email, mobile and WhatsApp are supported. string
$flow.encryption_status Indicates whether the user wants the document encrypted before sending to the specified channel. If no value is provided by the user or caller declines to provide an end date, the value defaults to true. boolean

To configure the Request statement webhook for this component, expand for instructions.

  1. Open the Dialogflow CX Console.
  2. Choose your Google Cloud project.
  3. Select your agent.
  4. Select the Manage tab.
  5. Click Webhooks.
  6. Select the prebuilt_components_account_statement:request_statement webhook.
  7. Replace the URL in the Dialogflow Webhook URL field with the endpoint for the service you want to integrate with. Select the proper Method in the dropdown.
  8. Review and update the Request body to form the proper request format for your webhook.
  9. Review and update the Response configuration to extract specific fields from your webhook's response. Do not modify the parameter names, as these are required by the component to access the returned field values.
  10. Review and update the Authentication settings as needed.
  11. Click Save.

Complete

Your agent and its webhooks should now be set up and ready to test.