IVR Input - Revision history

Webmaster at 21:21, 4 February 2011

2011-02-04T21:21:39Z

← Older revision		Revision as of 21:21, 4 February 2011
Line 1:		Line 1:
-	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!	+	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 ==

Webmaster at 20:29, 4 February 2011

2011-02-04T20:29:31Z

← Older revision		Revision as of 20:29, 4 February 2011
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. 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!	+	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!

	== IVR Input Dialog ==		== IVR Input Dialog ==

Webmaster: /* Extension */

2011-02-04T20:28:55Z

Extension

← Older revision		Revision as of 20:28, 4 February 2011
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 ===

Webmaster at 20:27, 4 February 2011

2011-02-04T20:27:07Z

← Older revision		Revision as of 20:27, 4 February 2011
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''' 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!

	== IVR Input Dialog ==		== IVR Input Dialog ==

Webmaster at 20:26, 4 February 2011

2011-02-04T20:26:26Z

← Older revision		Revision as of 20:26, 4 February 2011
Line 41:		Line 41:
	=== 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 53:		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 ==

Webmaster: /* Example */

2011-02-04T20:22:00Z

Example

← Older revision		Revision as of 20:22, 4 February 2011
Line 35:		Line 35:
	==== Example ====		==== Example ====

-	https://webhost.taridium.net/validation.html?input=%%input%%&attempts=%%attempts%%	+	<code>
		+	https://webhost.taridium.net/validation.html?input=%%input%%&attempts=%%attempts%%
		+	</code>

	=== Success Prompt ===		=== Success Prompt ===

Webmaster: /* Validation URL */

2011-02-04T20:18:20Z

Validation URL

← Older revision		Revision as of 20:18, 4 February 2011
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 ====
		+
		+	https://webhost.taridium.net/validation.html?input=%%input%%&attempts=%%attempts%%

	=== Success Prompt ===		=== Success Prompt ===

Webmaster: /* URL Variables */

2011-02-04T20:17:08Z

URL Variables

← Older revision		Revision as of 20:17, 4 February 2011
Line 64:		Line 64:
	* %%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

Webmaster at 20:16, 4 February 2011

2011-02-04T20:16:52Z

← Older revision		Revision as of 20:16, 4 February 2011
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 ===

Webmaster at 20:16, 4 February 2011

2011-02-04T20:16:19Z

← Older revision		Revision as of 20:16, 4 February 2011
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.	+	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 ===		=== Success Prompt ===
		+
		+	A prompt that will be played back if a successful validation has been performed.

	=== Failure Prompt ===		=== Failure Prompt ===