IVR Input
From Taridium
| (7 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| - | IVR's or [[wikipedia:Interactive_voice_response|interactive voice response]] Input functions are setup under '''Applications''' → '''IVRs''' An IVR Input function allows you to gather [[wikipedia:DTMF|DTMF]] data from the caller and process it using a web application - All changes made, become effective instantly, so be careful when changing settings on a production system! | + | IVR's or [[wikipedia:Interactive_voice_response|interactive voice response]] Input functions are setup under '''Applications''' → '''IVRs''' → '''Input'''. An IVR Input function allows you to gather [[wikipedia:DTMF|DTMF]] data from the caller and process it using a web application. This function is available on ipbx 2.2.1 and higher versions. - All changes made, become effective instantly, so be careful when changing settings on a production system! For an example on how to use this function see also [[Create_an_IVR_Input_Function| Creating an IVR Input Function]]. |
== IVR Input Dialog == | == IVR Input Dialog == | ||
| Line 11: | Line 11: | ||
=== Extension === | === Extension === | ||
| - | A unique extension for your input function. This can be used for testing purposes or internal applications. | + | A unique extension for your input function. This can be used for testing purposes or internal applications. Note that we always recommend, wherever possible, to use the function itself when calling it from other applications. |
=== Query Prompt === | === Query Prompt === | ||
| Line 32: | Line 32: | ||
A validation URL that returns a response to ipbx. The following responses are considered a valid response: any string except for '''INVALID'''. The following responses are considered an '''invalid''' response: A) the string '''INVALID''' or a zero length reply. If for some reason your URL is unreachable or times out, the system will consider the validation to have failed. The default timeout is 2 seconds. Both HTTP and HTTPS are supported. See below for allowed [[#URL_Variables|URL Variables]]. | A validation URL that returns a response to ipbx. The following responses are considered a valid response: any string except for '''INVALID'''. The following responses are considered an '''invalid''' response: A) the string '''INVALID''' or a zero length reply. If for some reason your URL is unreachable or times out, the system will consider the validation to have failed. The default timeout is 2 seconds. Both HTTP and HTTPS are supported. See below for allowed [[#URL_Variables|URL Variables]]. | ||
| + | |||
| + | ==== Example ==== | ||
| + | |||
| + | <code> | ||
| + | https://webhost.taridium.net/validation.html?input=%%input%%&attempts=%%attempts%% | ||
| + | </code> | ||
=== Success Prompt === | === Success Prompt === | ||
| - | A prompt that will be played back if a successful validation has been performed. | + | A prompt that will be played back if a successful validation has been performed. Only applicable with a validation URL. |
=== Failure Prompt === | === Failure Prompt === | ||
| + | |||
| + | A prompt that will be played back if the validation has failed. Only applicable with a validation URL. | ||
=== Max Retries === | === Max Retries === | ||
| + | |||
| + | The maximum number of validation attempts. 1 retry indicates a maximum of two attempts. Only applicable with a validation URL. | ||
=== Hangup on Failure === | === Hangup on Failure === | ||
| + | |||
| + | Whether to hangup the call after the validation has failed. Only applicable with a validation URL. | ||
== Input Result == | == Input Result == | ||
| Line 47: | Line 59: | ||
=== Result URL === | === Result URL === | ||
| - | This is the URL that will be called after the input has been completed or timed out. Use the %%input%% variable to pass the value to your URL. | + | This is the URL that will be called after the input has been completed or timed out. Use the %%input%% variable to pass the value to your URL. The default timeout is 2 seconds. Both HTTP and HTTPS are supported. See below for allowed [[#URL_Variables|URL Variables]]. |
| + | |||
| + | ==== Example ==== | ||
| + | |||
| + | <code> | ||
| + | https://webhost.taridium.net/result.html?input=%%input%%&attempts=%%attempts%% | ||
| + | </code> | ||
== Upon Completion == | == Upon Completion == | ||
| Line 64: | Line 82: | ||
* %%channel%% the channel, if available | * %%channel%% the channel, if available | ||
* %%exten%% the dialed extension | * %%exten%% the dialed extension | ||
| - | * %%input%% the DTMF digits entered | + | * '''%%input%%''' the DTMF digits entered |
* %%attempts%% the number of attempts/retries | * %%attempts%% the number of attempts/retries | ||
Latest revision as of 21:21, 4 February 2011
IVR's or interactive voice response Input functions are setup under Applications → IVRs → Input. An IVR Input function allows you to gather DTMF data from the caller and process it using a web application. This function is available on ipbx 2.2.1 and higher versions. - All changes made, become effective instantly, so be careful when changing settings on a production system! For an example on how to use this function see also Creating an IVR Input Function.
Contents |
IVR Input Dialog
Like with an ordinary IVR, you will only able to create an input function if you have a prompt recorded or uploaded.
Input Name
A descriptive name for your input function.
Extension
A unique extension for your input function. This can be used for testing purposes or internal applications. Note that we always recommend, wherever possible, to use the function itself when calling it from other applications.
Query Prompt
The prompt to play back when the function is accessed.
Max Digits
The maximum number of input digits. Pressing the # key will complete the input.
Timeout
The maximum alloted time of no input until the system times out in seconds.
Input Validation
Input validation is performed if an validation URL has been specified.
Validation URL
A validation URL that returns a response to ipbx. The following responses are considered a valid response: any string except for INVALID. The following responses are considered an invalid response: A) the string INVALID or a zero length reply. If for some reason your URL is unreachable or times out, the system will consider the validation to have failed. The default timeout is 2 seconds. Both HTTP and HTTPS are supported. See below for allowed URL Variables.
Example
https://webhost.taridium.net/validation.html?input=%%input%%&attempts=%%attempts%%
Success Prompt
A prompt that will be played back if a successful validation has been performed. Only applicable with a validation URL.
Failure Prompt
A prompt that will be played back if the validation has failed. Only applicable with a validation URL.
Max Retries
The maximum number of validation attempts. 1 retry indicates a maximum of two attempts. Only applicable with a validation URL.
Hangup on Failure
Whether to hangup the call after the validation has failed. Only applicable with a validation URL.
Input Result
Result URL
This is the URL that will be called after the input has been completed or timed out. Use the %%input%% variable to pass the value to your URL. The default timeout is 2 seconds. Both HTTP and HTTPS are supported. See below for allowed URL Variables.
Example
https://webhost.taridium.net/result.html?input=%%input%%&attempts=%%attempts%%
Upon Completion
If set, this indicates where to continue with the call. This function has no effect if hangup on failure has been checked and the input was not successfully validated.
URL Variables
URLs can contain the following variables:
- %%accountcode%% the current ipbx account code
- %%calleridnumber%% the current caller ID number
- %%calleridname%% the current caller ID name
- %%calleridani%% the current caller ID ANI
- %%uniqueid%% the unique ID of the call as stored in the CDR records
- %%channel%% the channel, if available
- %%exten%% the dialed extension
- %%input%% the DTMF digits entered
- %%attempts%% the number of attempts/retries
