# Address
## **Function**
This module collects address information. Select **Street Address**, **City/State**, or **ZIP code** to choose which information will be collected from end users.
When selected, each option adds a default prompt that you can edit further as needed.
### Street option
When Street is selected, this module will display the **Search City, State or Zip** field. This field requires you to enter one of the following:
* City and state
* Zip code
This field accepts strings and variables.
### Limitations
An Address module can collect only one piece of address information at a time.
### Recommendations
#### Street option: Collecting City and State
The **Search City, State or Zip** field can be completed with end user input by doing the following:
1. Add a separate Address module with City/State selected. Give the module a unique name.
2. Connect the first module to a second Address module with Street selected.
3. In the **Search City, State or Zip** field, select the plus icon, then add the first module's name to enter it as a variable.
#### Collecting all address information options
To collect all address information (other than name), add and connect the following modules in order:
1. **Zip code:** [Digits](https://docs.plumvoice.com/fuse/input/digits) 
2. **City and State:** Address, select City/State option
3. **Street:** Address, select Street option and [configure as shown above](#street-option-collecting-city-and-state)
Street is handled last to ensure accuracy. Multiple cities can have streets with the same name.
When the address is read back to the caller, the variable type `address` should be used. See [Text-to-speech Variable Types](https://docs.plumvoice.com/fuse/variables#text-to-speech-variable-types) for more information.
{% hint style="info" %}
**Note:** Speech recognition is enabled by default for the Address 
module. It cannot be turned off. This is indicated by a green microphone icon in the text field.
{% endhint %}
## **Module Settings**
### [Barge In](https://docs.plumvoice.com/fuse/module-settings#barge-in)
| | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 
| This setting allows callers to interrupt a prompt before it finishes playing.
When enabled, DTMF input interrupts the prompt and progresses the call forward in the call-flow. If speech recognition is enabled on the ensuing module in the call-flow, then end-users can also interrupt the prompt with a spoken utterance, too. Disabling barge-in forces callers to listen to the entire prompt.
A barge-in enabled module will have a dashed line on top of the text box. See example here.
|
### [Private](https://docs.plumvoice.com/fuse/module-settings#private)
| | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 
| This setting controls the logging function of a module.
Enabling the 'Private' setting instructs the module to not record, report, or retain the information input to that module for reporting or any other purposes. When enabled any information entered into a module during a call will be lost immediately when the call terminates.
The 'Private' setting is critical for businesses that need to maintain PCI-DSS or HIPAA compliance.
The module icon, in the upper left-hand corner, becomes grayed-out when this setting is enabled. See more details here.
|
### [**Canada**](https://docs.plumvoice.com/fuse/module-settings#canada)
| | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 
| This setting allows end-users to enter either an American or Canadian address.
Enabling the ‘Canada’ setting extends the capability to include Canadian data in addition to, but not in lieu of U.S. data. There is no ‘Canada only’ option or functionality.
When active, the ‘City/State’ menu item changes to ‘City/State or Province’, and the ‘State’ menu item changes to ‘State or Province’.
|
{% hint style="info" %}
**Note**: At present, Fuse cannot collect street data for Canadian addresses, only city and/or provinces.
{% endhint %}
### [**Show Custom Errors**](https://docs.plumvoice.com/fuse/module-settings#show-custom-errors)
| | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 
| Enabling this setting overrides the default, global error options set in the Application Settings > User Input Settings.
This allows users to establish custom error handling in order to act on errors in a specific way in that module.
Instead of progressing to the next module in the call-flow, custom error handling allows users to re-prompt the same module, to provide a custom error message, to re-direct the call based on the error, or any other desired behavior.
Adding multiple errors (
) to a module functions behave the same way as a counter.
The first error follows the path for the first error listed, if a second error occurs in the same module it follows the second listed error, and so on until all errors are exhausted or an error directs the end-user away from that module.
No Input occurs when the caller does not provide an input based on the timeout settings.
This is based on the “Initial input timeout” in User Input Settings
No Match occurs when the caller input does not match the module's criteria for the input module.
|
### [Timeout Length](https://docs.plumvoice.com/fuse/module-settings#timeout-length)
| | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 
| This allows users to set the maximum time, in seconds, that elapse before returning a timeout error. This applies modules that fetch outside scripts, like the SOAP, REST, or subdialog modules.
The default value for Timeout Length is 30 seconds.
Acceptable number values range from 1 to 120.
|
### **Advanced Settings**
Advanced Fuse users may want to use shadow variables that are available with input modules. For more information on this functionality, please visit the [Shadow Variables](https://docs.plumvoice.com/fuse/variables/shadow-variables) page.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.plumvoice.com/fuse/input/address.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.