End-User URL Control API
From Taridium
(New page: This optional ipbx module is installed under Advanced Setup → Modules. Registered modules are displayed with '''registered module'''. The End-User URL control allows you to control cal...) |
|||
| Line 1: | Line 1: | ||
| - | This optional ipbx module is installed under Advanced Setup → Modules. Registered modules are displayed with '''registered module'''. | + | 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. | ||
| - | + | [[Image:warning.gif]] 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. | |
| + | |||
| + | |||
| + | == Enabling URL Control == | ||
| + | |||
| + | This assumes that you have the URL Control module installed. See [[Ipbx_enterprise_pbx#Optional_Modules|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 | ||
| + | |||
| + | == 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 as long as the request originates from the address. | ||
Revision as of 14:18, 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.
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.
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
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 as long as the request originates from the address.
