[[["易于理解","easyToUnderstand","thumb-up"],["解决了我的问题","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["很难理解","hardToUnderstand","thumb-down"],["信息或示例代码不正确","incorrectInformationOrSampleCode","thumb-down"],["没有我需要的信息/示例","missingTheInformationSamplesINeed","thumb-down"],["翻译问题","translationIssue","thumb-down"],["其他","otherDown","thumb-down"]],["最后更新时间 (UTC)：2025-08-18。"],[[["\u003cp\u003eThis prebuilt component authenticates retail users to either Level 0 (ANI Match) by matching their phone number to a registered account, or Level 1 (Basic) by verifying a one-time password (OTP).\u003c/p\u003e\n"],["\u003cp\u003eThe component supports users with registered phone numbers and emails, allowing for OTP delivery to either channel, however OTP will only be sent to registered channels.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes the Telephone number collection prebuilt component to collect and validate user phone numbers.\u003c/p\u003e\n"],["\u003cp\u003eThe component includes flexible webhooks for fetching user details and sending OTPs, and you must configure them to link to your external services.\u003c/p\u003e\n"],["\u003cp\u003eThe component uses input parameters, such as \u003ccode\u003eauth_level_req\u003c/code\u003e to set the level required for authentication and output parameters, such as \u003ccode\u003eauth_level\u003c/code\u003e which indicates the level the end-user is authenticated to.\u003c/p\u003e\n"]]],[],null,["# Retail authentication prebuilt component\n\nThe retail authentication\n[prebuilt component](/dialogflow/cx/docs/concept/prebuilt-component) collects\ninformation from the user to authenticate them to the required authentication level.\nThis component covers authentication requirements which are common, but not\nexclusive, to the retail industry. This component uses the\n[Telephone number collection](/dialogflow/cx/docs/concept/prebuilt-component/telephone-number-collection)\nprebuilt component to collect and validate user details.\n\nAuthentication levels\n---------------------\n\nThere are multiple levels of authentication required by different prebuilt\ncomponents, with higher levels requiring more user information to authenticate\nthe user. The retail authentication component allows users to authenticate to\nLevel 0 (ANI Match) or Level 1 (Basic) as described in the Authentication Level table.\n\nSupported user types\n--------------------\n\nThe retail authentication component provides support for users with a registered\nphone number and email.\n\nLimitations\n-----------\n\nIn addition to the\n[common prebuilt component limitations](/dialogflow/cx/docs/concept/prebuilt-component#limits),\nthis prebuilt component has the following limitations:\n\n- OTPs will only be sent to a mobile number or email address previously registered to the user. The component won't use OTP to authenticate customers calling from an alternate phone number that is not registered with their account. When a user calls from an alternate phone number, security questions will be used to authenticate the caller.\n- This component does not encrypt any data.\n\nSample dialogs\n--------------\n\nThe following sample dialogs demonstrate common scenarios handled by this\nprebuilt component. The sample dialogs demonstrate behavior when the component is\ncalled using telephony, which triggers the Default Welcome Intent and the first\nagent response at the start of the conversation.\n\n### Level 0 authentication success: ANI match\n\nUser calls from a phone number registered to an existing account, confirms their\naccount, and is successfully authenticated to Level 0.\n\n### Level 1 authentication success: OTP\n\nUser calls from an unrecognized phone number. The component collects the user's\nregistered phone number, then sends and asks user to confirm an OTP sent to the\nchannel of the user's choice. User is able to provide a valid OTP and is\nsuccessfully authenticated to Level 1.\n\nNaming conventions\n------------------\n\nThis prebuilt component uses the following naming conventions:\n\nInput parameters\n----------------\n\nInput parameters are parameters that are used to configure certain behaviors of\nthe component. The parameters will be used by one or more conditions within the\nflow to determine how the component should behave. Flow-scoped parameters must\nbe set on the start page of the component as described below. Session-scoped\nparameters may be set either by a calling flow, or on the start\npage of this component.\n\nThis prebuilt component accepts the following input parameters:\n\n#### To configure the input parameters for this component, expand for instructions.\n\n1. Open the [Dialogflow CX console](https://dialogflow.cloud.google.com/cx/projects).\n2. Choose your Google Cloud project.\n3. Select your agent.\n4. Select the **Build** tab.\n5. Click the imported component in the **Flows** section.\n6. Click the Start Page in the **Pages** section.\n7. Click the **true** Route in the Start Page.\n8. In the Route window, edit the **Parameter Presets** values as needed.\n9. Click **Save**.\n\nOutput parameters\n-----------------\n\nOutput parameters are session parameters that will remain active after exiting\nthe component. These parameters contain important information collected by the\ncomponent. This prebuilt component provides values for the following output\nparameters:\n\nBasic setup\n-----------\n\nTo set up this prebuilt component:\n\n1. [Import the prebuilt component](/dialogflow/cx/docs/concept/prebuilt-component#import).\n2. Configure the provided [flexible webhooks](/dialogflow/cx/docs/concept/webhook#flexible) with configuration describing your external services, see Webhook setup below.\n\nWebhook setup\n-------------\n\nIn order to use this component, you will need to configure the included\n[flexible webhooks](/dialogflow/cx/docs/concept/webhook#flexible) to retrieve\nneeded information from your external services.\n\n### Verify user details\n\nThe `prebuilt_components_retail_authentication:verify_user_details` webhook is\nused by the component to fetch user account details based on the provided telephone\nnumber.\n\n#### API request parameters\n\nThe following parameters are provided by the component as inputs to the API request.\n\n#### API response parameters\n\nThe following parameters are pulled from the API response to be used by the component.\n\n#### To configure the Verify user details webhook for this component, expand for instructions.\n\n1. Open the [Dialogflow CX console](https://dialogflow.cloud.google.com/cx/projects).\n2. Choose your Google Cloud project.\n3. Select your agent.\n4. Select the **Manage** tab.\n5. Click **Webhooks**.\n6. Select the prebuilt_components_retail_authentication:verify_user_details webhook.\n7. Replace the URL in the Conversational Agents (Dialogflow CX) **Webhook URL** field with the endpoint for the service you want to integrate with. Select the proper **Method** in the dropdown.\n8. Review and update the **Request body** to form the proper request format for your webhook.\n9. 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.\n10. Review and update the **Authentication** settings as needed.\n11. Click **Save**.\n\n### Send OTP\n\nThe `prebuilt_components_retail_authentication:send_otp` webhook is used\nby the component to send a one-time password (OTP) to a registered channel\nselected by the end-user.\n\n#### API request parameters\n\nThe following parameters are provided by the component as inputs to the API request.\n\n#### API response parameters\n\nThe following parameters are pulled from the API response to be used by the component.\n\n#### To configure the Send OTP webhook for this component, expand for instructions.\n\n1. Open the [Dialogflow CX console](https://dialogflow.cloud.google.com/cx/projects).\n2. Choose your Google Cloud project.\n3. Select your agent.\n4. Select the **Manage** tab.\n5. Click **Webhooks**.\n6. Select the prebuilt_components_retail_authentication:send_otp webhook.\n7. Replace the URL in the Conversational Agents (Dialogflow CX) **Webhook URL** field with the endpoint for the service you want to integrate with. Select the proper **Method** in the dropdown.\n8. Review and update the **Request body** to form the proper request format for your webhook.\n9. 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.\n10. Review and update the **Authentication** settings as needed.\n11. Click **Save**.\n\n### Complete\n\nYour agent and its webhooks should now be set up and ready to test."]]
