[[["易于理解","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\u003eThe Order Status component provides authenticated customers with information about their recent or past orders, using Retail authentication for user verification.\u003c/p\u003e\n"],["\u003cp\u003eThis component is designed to interact with external services through flexible webhooks, allowing for the retrieval of order details, identification of duplicate orders, and sending of SMS updates.\u003c/p\u003e\n"],["\u003cp\u003eThe component can handle multiple order inquiries, including those with duplicate order IDs, by prompting the user to specify which order they are referencing.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes a set of input parameters, both session and flow-scoped, to customize the behavior of the component, such as setting retry limits and defining order status values.\u003c/p\u003e\n"],["\u003cp\u003eThe component also defines output parameters that remain active after exiting the component, providing valuable data like order details and user contact information.\u003c/p\u003e\n"]]],[],null,["# Order status prebuilt component\n\nThe order status\n[prebuilt component](/dialogflow/cx/docs/concept/prebuilt-component)\nchecks a customer's authentication level, then provides information about the\nuser's most recent or past orders to an authenticated customer. This component\nuses the\n[Retail authentication](/dialogflow/cx/docs/concept/prebuilt-component/authentication-retail)\nprebuilt component to authenticate users. The component also uses\n[Generators](/dialogflow/cx/docs/concept/generative/generators) for post-call\nsummarization.\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- 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### Recent order\n\nEnd-user calls from an unregistered number; the agent authenticates the user,\nthen provides detailed information about the shipments in the order. The user\nconfirms that they would like an SMS sent to their registered phone number\nwith additional details.\n\n### Duplicate orders\n\nEnd-user has been previously authenticated. The user requests information about\nan order and provides the last five digits of the order. The agent identifies that\nmultiple orders placed by this user share the same last five digits, so it\nconfirms which order the user would like to hear the status of and provides the\norder status to the user.\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. 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.\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### Authentication\n\nIf you have not previously configured external services required for\nauthentication, you will need to configure them to enable authentication of\nusers for this component. See [Retail authentication webhook setup](/dialogflow/cx/docs/concept/prebuilt-component/authentication-retail#webhook-setup)\nfor detailed instructions.\n\n### Get order details\n\nThe `prebuilt_components_order_status:get_order_details` webhook is used\nby the component to retrieve order details for a specified order.\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 Get order 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_order_status:get_order_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### Get duplicate orders\n\nThe `prebuilt_components_retail_services:get_duplicate_order` webhook is used\nby the component to retrieve detailed information in order to distinguish between\norders when multiple order numbers have the same last five digits.\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 Get duplicate orders 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_services:get_duplicate_order 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 SMS\n\nThe `prebuilt_components_order_status:send_sms` webhook is used\nby the component to send order details to the specified phone number using SMS.\n\n#### API request parameters\n\nThe following parameters are provided by the component as inputs to the API request.\n\n#### To configure the Send SMS 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_order_status:send_sms 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### Enable notifications\n\nThe `prebuilt_components_order_status:enable_notification` webhook is used\nby the component to enable notifications for a user's registered phone number.\n\n#### API request parameters\n\nThe following parameters are provided by the component as inputs to the API request.\n\n#### To configure the Enable notifications 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_order_status:enable_notification 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."]]
