APIs - Revision history

Webmaster: /* HTTP GET Arguments and Polling */

2010-12-14T13:52:33Z

HTTP GET Arguments and Polling

← Older revision		Revision as of 13:52, 14 December 2010
Line 37:		Line 37:
	Example HTTP Requests:		Example HTTP Requests:

-	http://~~213~~.~~156~~.~~130~~.88/ipps/channelinfo.php?channel=SIP/4003	+	http://127.0.0.1/ipps/channelinfo.php?channel=SIP/4003
-	http://myuser:pass@~~213~~.~~156~~.~~130~~.88/ipps/channelinfo.php?channel=SIP/4003,SIP/5011	+	http://myuser:pass@127.0.0.1/ipps/channelinfo.php?channel=SIP/4003,SIP/5011

	==== Returned Errors ====		==== Returned Errors ====

2010-12-14T13:52:17Z

HTTP GET Arguments and Polling

← Older revision		Revision as of 13:52, 14 December 2010
Line 112:		Line 112:
	Example HTTP Requests:		Example HTTP Requests:

-	http://~~213~~.~~156~~.~~130~~.88/ipps/queueactive.php?queue_name=MC&res_cc=1	+	http://127.0.0.1/ipps/queueactive.php?queue_name=MC&res_cc=1
-	http://myuser:pass@~~213~~.~~156~~.~~130~~.88/ipps/queueactive.php?queue_name=MC&res_cc=1	+	http://myuser:pass@127.0.0.1/ipps/queueactive.php?queue_name=MC&res_cc=1

	NOTE: Although page render times have been established at levels below 30		NOTE: Although page render times have been established at levels below 30

2010-04-06T20:57:54Z

URL Control and Click to Call

← Older revision		Revision as of 20:57, 6 April 2010
Line 178:		Line 178:
	== URL Control and Click to Call ==		== URL Control and Click to Call ==

-	See the [[~~URL Control Module~~\|URL Control Module Module Section]].	+	See the [[End-User_URL_Control_API\|URL Control Module Module Section]].

2010-04-06T20:57:19Z

← Older revision		Revision as of 20:57, 6 April 2010
Line 175:		Line 175:

	See the [[CTI\|CTI Module Section]].		See the [[CTI\|CTI Module Section]].
		+
		+	== URL Control and Click to Call ==
		+
		+	See the [[URL Control Module\|URL Control Module Module Section]].

2010-03-03T15:20:17Z

Returned Errors

← Older revision		Revision as of 15:20, 3 March 2010
Line 45:		Line 45:

	ERROR: NO CHANNEL SUPPLIED		ERROR: NO CHANNEL SUPPLIED
-	If no channel name is supplied	+
		+	If no channel name is supplied

	ERROR: SSL QUERY REQUIRED		ERROR: SSL QUERY REQUIRED
-	Only applicable if $cfg['IPPSRequireSSL'] has been set to TRUE	+
		+	Only applicable if $cfg['IPPSRequireSSL'] has been set to TRUE

	ERROR: AUTHENTICATION FAILED		ERROR: AUTHENTICATION FAILED
-	Only applicable if authentication username and/or password has been set	+
		+	Only applicable if authentication username and/or password has been set

	==== Returned Fields ====		==== Returned Fields ====

2010-02-24T21:16:41Z

HTTP GET Arguments and Polling

← Older revision		Revision as of 21:16, 24 February 2010
Line 31:		Line 31:

	'''channel''' name of channel(s) (comma separated if merged results requested)		'''channel''' name of channel(s) (comma separated if merged results requested)
-	This is the literal name of the channel as specified in the ipbx configuration.	+	This is the technology and the literal name of the channel as specified in the ipbx configuration.

	'''useid''' force reply of channel name as first field in returned data		'''useid''' force reply of channel name as first field in returned data

2010-02-24T21:10:02Z

IPPS Interfaces

← Older revision		Revision as of 21:10, 24 February 2010
Line 9:		Line 9:
	== IPPS Interfaces ==		== IPPS Interfaces ==

-	IPPS allows applications to interact with ipbx using simple URLs. For security reasons IPPS is disabled by default. In order to enable IPPS, you need to to set the $cfg['IPPSEnabled'] to TRUE.	+	IPPS allows applications to interact with ipbx using simple URLs. For security reasons IPPS is disabled by default. In order to enable IPPS, you need to to set the variable '''$cfg['IPPSEnabled']''' to '''TRUE'''.

	=== IPPS Authentication and SSL Access ===		=== IPPS Authentication and SSL Access ===

2010-02-24T21:09:32Z

IPPS Interfaces

← Older revision		Revision as of 21:09, 24 February 2010
Line 9:		Line 9:
	== IPPS Interfaces ==		== IPPS Interfaces ==

-	IPPS allows applications to interact with ipbx using simple URLs.	+	IPPS allows applications to interact with ipbx using simple URLs. For security reasons IPPS is disabled by default. In order to enable IPPS, you need to to set the $cfg['IPPSEnabled'] to TRUE.

	=== IPPS Authentication and SSL Access ===		=== IPPS Authentication and SSL Access ===

2010-02-24T21:04:06Z

Returned Fields

← Older revision		Revision as of 21:04, 24 February 2010
Line 55:		Line 55:
	==== Returned Fields ====		==== Returned Fields ====

-	Data will only be returned if calls are active. Otherwise expect either the channel name or ~~simply~~ the keyword '''down''', depending on whether the '''useid''' GET argument has been set. Every line of the page body represents a channel. Data is returned as comma separated values. Some values are optional or depend on call status or other information.	+	Data will only be returned if calls are active. Otherwise expect either the channel name and/or the keyword '''down''', depending on whether the '''useid''' GET argument has been set. Every line of the page body represents a channel. Data is returned as comma separated values. Some values are optional or depend on call status or other information.

	'''CHANNEL_NAME''': The supplied channel name in the format of Technology/Resource. This value is always returned if you are		'''CHANNEL_NAME''': The supplied channel name in the format of Technology/Resource. This value is always returned if you are

2010-02-24T21:02:03Z

Sample Data