IVR Input
From Taridium
| Line 31: | Line 31: | ||
=== Validation URL === | === 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. | + | 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]]. |
=== Success Prompt === | === Success Prompt === | ||
Revision as of 20:16, 4 February 2011
IVR's or interactive voice response Input functions are setup under Applications → IVRs An IVR Input function allows you to gather 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!
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.
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.
Success Prompt
A prompt that will be played back if a successful validation has been performed.
Failure Prompt
Max Retries
Hangup on Failure
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.
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
