End-User URL Control API - Revision history

Webmaster: /* Generic HTTP Authentication */

2012-03-12T14:10:08Z

Generic HTTP Authentication

← Older revision		Revision as of 14:10, 12 March 2012
Line 129:		Line 129:
	http://user:password@mypbx/user/c/?user=12345&call=5550000		http://user:password@mypbx/user/c/?user=12345&call=5550000

-	When using Generic HTTP Authentication the '''context''' variable can be passed for a custom dialplan context. This will default to '''inside''' or to the value set for $cfg['IPPSDPContext']. If required the '''user''' parameter can also be specified as channel such as user=SIP/~~400~~ instead of an extension.	+	When using Generic HTTP Authentication the '''context''' variable can be passed for a custom dialplan context. This will default to '''inside''' or to the value set for $cfg['IPPSDPContext']. If required the '''user''' parameter can also be specified as channel such as user=SIP/4002 instead of an extension.

2012-03-12T14:09:53Z

Generic HTTP Authentication

← Older revision		Revision as of 14:09, 12 March 2012
Line 129:		Line 129:
	http://user:password@mypbx/user/c/?user=12345&call=5550000		http://user:password@mypbx/user/c/?user=12345&call=5550000

-	When using Generic HTTP Authentication the '''context''' variable can be passed for a custom dialplan context. This will default to '''inside''' or to the value set for $cfg['IPPSDPContext'].	+	When using Generic HTTP Authentication the '''context''' variable can be passed for a custom dialplan context. This will default to '''inside''' or to the value set for $cfg['IPPSDPContext']. If required the '''user''' parameter can also be specified as channel such as user=SIP/400 instead of an extension.

2010-08-04T21:25:58Z

Caller ID Control

← Older revision		Revision as of 21:25, 4 August 2010
Line 59:		Line 59:
	Name and Number: ''John Doe <12345>''		Name and Number: ''John Doe <12345>''

-	If you want the call to appear as ''unknown'' to the called party, simply set the '''cid''' variable to ''unknown''.	+	If you want the call to appear as ''unknown'' to the called party, simply set the '''cid''' variable to ''unknown''. Note that the first call leg caller ID will be the number to be dialed.

	Please consider correct URL encoding of above examples:		Please consider correct URL encoding of above examples:

2010-05-13T21:10:04Z

Generic HTTP Authentication

← Older revision		Revision as of 21:10, 13 May 2010
Line 120:		Line 120:
	The following system configuration variables are applicable:		The following system configuration variables are applicable:

-	$cfg['IPPSEnabled'] // set this variable to TRUE to use HTTP authentication	+	$cfg['IPPSEnabled'] // set this variable to TRUE to use HTTP authentication
	$cfg['IPPSUser'] // the variable that sets the username		$cfg['IPPSUser'] // the variable that sets the username
	$cfg['IPPSPassword'] // the variable that sets the password		$cfg['IPPSPassword'] // the variable that sets the password

2010-05-13T21:09:51Z

Generic HTTP Authentication

← Older revision		Revision as of 21:09, 13 May 2010
Line 120:		Line 120:
	The following system configuration variables are applicable:		The following system configuration variables are applicable:

		+	$cfg['IPPSEnabled'] // set this variable to TRUE to use HTTP authentication
	$cfg['IPPSUser'] // the variable that sets the username		$cfg['IPPSUser'] // the variable that sets the username
	$cfg['IPPSPassword'] // the variable that sets the password		$cfg['IPPSPassword'] // the variable that sets the password

2010-04-06T21:22:17Z

HTML Output

← Older revision		Revision as of 21:22, 6 April 2010
Line 95:		Line 95:
	=== HTML Output ===		=== HTML Output ===

-	URL Control can also return a simple HTML call progress page by setting the '''progress''' argument to '''1'''. E.g. http://mypbx/user/c/?call=5550000&progress=1 - HTML output will pause until the successful/failed status is returned.	+	URL Control can also return a simple HTML call progress page by setting the '''progress''' argument to '''1''' (text) or '''2''' (graphic). E.g. http://mypbx/user/c/?call=5550000&progress=1 - HTML output will pause until the successful/failed status is returned.

	'''Successful Call'''		'''Successful Call'''

2010-04-06T20:58:54Z

Call Number (Click to Call)

← Older revision		Revision as of 20:58, 6 April 2010
Line 46:		Line 46:

	=== Call Number (Click to Call) ===		=== Call Number (Click to Call) ===
-	* http://mypbx/user/c/?key=OB94AU&call=5550000 to call number 555-0000 - Numbers should be specified without spaces, dots, brackets etc. and in the same way as you would dial a number from an on-system phone.	+	* Example: http://mypbx/user/c/?key=OB94AU&call=5550000 to call number 555-0000 - Numbers should be specified without spaces, dots, brackets etc. and in the same way as you would dial a number from an on-system phone.

	If you specify an authorized client IP address you can omit the '''key''' argument. E.g. http://mypbx/user/c/?call=5550000		If you specify an authorized client IP address you can omit the '''key''' argument. E.g. http://mypbx/user/c/?call=5550000

2010-03-03T15:26:06Z

Generic HTTP Authentication

← Older revision		Revision as of 15:26, 3 March 2010
Line 112:		Line 112:
	== Generic HTTP Authentication ==		== Generic HTTP Authentication ==

-	While URL Control can be used in ~~an dedicated~~ user context one can also use plain HTTP authentication to place arbitrary calls from any extension to another. This applies only to the call functionality and cannot be used for any other commands, since there is no specific user associated to the login/authentication. There is no need to use the '''key''' argument or come from a specific IP address. See [[End-User_URL_Control#Call_Number_.28Click_to_Call.29\|Call Number (Click to Call)]] for details on IP address based authentication.	+	While URL Control can be used in a user context, one can also use plain HTTP authentication to place arbitrary calls from any extension to another. This applies only to the call functionality and cannot be used for any other commands, since there is no specific user associated to the login/authentication. There is no need to use the '''key''' argument or come from a specific IP address. See [[End-User_URL_Control#Call_Number_.28Click_to_Call.29\|Call Number (Click to Call)]] for details on IP address based authentication.

	{\| align="center" style="text-align:center; width:500px; background-color:#FDCBCB; border:none; padding:3px;"		{\| align="center" style="text-align:center; width:500px; background-color:#FDCBCB; border:none; padding:3px;"

2009-10-10T18:18:22Z

Call Number (Click to Call)

← Older revision		Revision as of 18:18, 10 October 2009
Line 64:		Line 64:

	http://mypbx/user/c/?keyOB94AU&call=5550000&cid=John+Doe+%3C12345%3E		http://mypbx/user/c/?keyOB94AU&call=5550000&cid=John+Doe+%3C12345%3E
		+
		+	Further click to call settings can be configured under [[Advanced_Setup:_Configuration#Click_to_Call\|Advanced Setup]].

	== Return Values ==		== Return Values ==

2009-10-10T18:11:50Z

Caller ID Control

← Older revision		Revision as of 18:11, 10 October 2009
Line 56:		Line 56:
	Optionally specify an arbitrary caller ID for the second call leg using the '''cid''' parameter. You can either specify a number or a number ''and'' name:		Optionally specify an arbitrary caller ID for the second call leg using the '''cid''' parameter. You can either specify a number or a number ''and'' name:

-	Number: 12345	+	Number: ''12345''
-	Name and Number John Doe <12345>	+	Name and Number: ''John Doe <12345>''

	If you want the call to appear as ''unknown'' to the called party, simply set the '''cid''' variable to ''unknown''.		If you want the call to appear as ''unknown'' to the called party, simply set the '''cid''' variable to ''unknown''.