Zip code collection prebuilt component

This prebuilt component collects five-digit zip codes.

Limitations

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

  • Zip codes longer than five digits are not accepted.
  • Alphanumeric zip codes are not accepted.

Enable DTMF to allow users to input numeric values using the telephone keypad.

Additional features

The following additional functionalities are provided by this prebuilt component:

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.

Valid zip code

End-user provides a five-digit zip code; agent successfully collects it.

User input Agent response
Please say or enter the five digit zip code.
27656
You mentioned the zip code is 27656, is that correct?
yes
Great, I'm done with collecting the zip code.

Retry

End-user provides a five-digit zip code in the second attempt; agent successfully accepts it.

User input Agent response
Please say or enter the five digit zip code.
27656
You mentioned the zip code is 27657, is that correct?
no
Sorry I didn't get it right.
Please say or enter the five digit zip code.
27656
You mentioned the zip code is 27656, is that correct?
yes
Great, I'm done with collecting the zip code.

Invalid zip code

End-user provides an invalid zip code that is over five digits long; agent reprompts and successfully collects the corrected zip code.

User input Agent response
Please say or enter the five digit zip code.
276566
I heard 123456, which is not a valid five digit zip code.
Please say or enter the five digit zip code.
27656
You mentioned the zip code is 27656, is that correct?
yes
Great, I'm done with collecting the zip code.

Unrecognized input

Component exits the flow after the end-user provides unrecognized input three times.

User input Agent response
Please say or enter the five digit zip code.
It's fine
Sorry, I didn't get that. Can you please say or enter the five digit zip code again?
Good
Hmm, I still wasn't able to get that. Please make sure you're saying the five digit zip code. You can also use the keypad to enter the zip code.
Nice
Sorry, I'm having difficulty understanding your response.

Naming conventions

This prebuilt component uses the following naming conventions:

Feature Format Example
Flow [Component Name] Zip Code Collection
Component Specific Intent prebuilt_components_[component_name]_[intent_name] prebuilt_components_zip_code_collection_collect_zip_code
Parameter [param_name] zip_code

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
zip_code_collection_zip_code This parameter returns the zip code collected by the conversation flow string

Basic setup

To set up this prebuilt component:

  1. Import the prebuilt component.

Complete

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