End-User URL Control API

From Taridium

Revision as of 14:20, 11 March 2009 (view source) Webmaster (Talk | contribs) ← Older edit		Revision as of 14:26, 11 March 2009 (view source) Webmaster (Talk | contribs) (→Action Commands) Newer edit →
Line 25:		Line 25:
	* http://mypbx/user/c/?key=OB94AU&call=5550000 to call number 555-0000		* http://mypbx/user/c/?key=OB94AU&call=5550000 to call number 555-0000
-	If you specify an authorized client IP address you can omit the key portion as long as the request originates from the address.	+	If you specify an authorized client IP address you can omit the key portion. E.g. http://mypbx/user/c/?call=5550000
		+
		+	== Return Values ==
		+
		+	=== Error Values ===
		+
		+	ERROR: AUTH FAILED
		+	Returned if authentication fails (invalid key) or IP address cannot be matched.
		+
		+	ERROR: FAILED PLACING CALL
		+	Returned if the call could not be placed successfully. See also notes below on placed calls.
		+
		+	=== Successful Values ===
		+
		+	OK: UPDATED FORWARDING SETTINGS
		+	The forwarding settings have been updated successfully.
		+
		+	OK: UPDATED FOLLOWME SETTINGS
		+	The followme settings have been updated successfully.
		+
		+	OK: UPDATED VM SETTINGS
		+	The voicemail settings have been updated successfully.
		+
		+	OK: CALL PLACED
		+	The call has been placed successfully. Returned once the first leg of the call, to the user, has been placed successfully. Note this value will also be returned if the second leg of the call fails.

---

Revision as of 14:26, 11 March 2009

This optional ipbx module is installed under Advanced Setup → Modules. Registered modules are displayed with registered module.

The URL control module allows you to control certain user settings via a simple URL. It also allows you to initiate a call (call origination) to your extension and bridge the call to any destination reachable within your default user settings (or custom extensions).

Do not expose this functionality on the public internet! If your server is reachable via a public IP address, make sure you take the appropriate precautions to prevent abuse.

Contents 1 Enabling URL Control 2 Action Commands 3 Return Values 3.1 Error Values 3.2 Successful Values

Enabling URL Control

This assumes that you have the URL Control module installed. See Optional Modules

Log into the end user panel e.g. http://mypbx/user and enable URL Control under the Features section. Once enabled the system will automatically generate a 6 character key that identifies the user/extension. You can also, optionally specify an IP address that will identify the user/extension instead of the key.

Action Commands

Examples on how to use URL control:

• http://mypbx/user/c/?key=OB94AU&fwd=1 to switch call forwarding on
• http://mypbx/user/c/?key=OB94AU&fwd=0 to switch call forwarding off
• http://mypbx/user/c/?key=OB94AU&fwdnr=5550000 to set the call forwarding number to 555-0000 - This will automatically enable call forwarding.
• http://mypbx/user/c/?key=OB94AU&follow=1 to switch follow-me on
• http://mypbx/user/c/?key=OB94AU&follow=0 to switch follow-me off
• http://mypbx/user/c/?key=OB94AU&vm=1 to switch voicemail on
• http://mypbx/user/c/?key=OB94AU&vm=0 to switch voicemail off
• http://mypbx/user/c/?key=OB94AU&call=5550000 to call number 555-0000

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

Return Values

Error Values

 ERROR: AUTH FAILED

Returned if authentication fails (invalid key) or IP address cannot be matched.

 ERROR: FAILED PLACING CALL

Returned if the call could not be placed successfully. See also notes below on placed calls.

Successful Values

 OK: UPDATED FORWARDING SETTINGS

The forwarding settings have been updated successfully.

 OK: UPDATED FOLLOWME SETTINGS

The followme settings have been updated successfully.

 OK: UPDATED VM SETTINGS  

The voicemail settings have been updated successfully.

 OK: CALL PLACED

The call has been placed successfully. Returned once the first leg of the call, to the user, has been placed successfully. Note this value will also be returned if the second leg of the call fails.