Switchboard Panels
From SwitchvoxExtendAPI
| Line 45: | Line 45: | ||
====CALLER_ID_NUMBER==== | ====CALLER_ID_NUMBER==== | ||
| - | The phone number of the current call. Example: 8585551212 | + | The phone number of the current call. Example: 8585551212. |
====CALLER_ID_NAME==== | ====CALLER_ID_NAME==== | ||
| - | The text component of Caller-ID for the current call. Example: BOB JONES | + | The text component of Caller-ID for the current call. Example: BOB JONES. |
| - | + | ||
| - | + | ||
Revision as of 20:26, 27 April 2009
This Switchvox Extend tool is used from the Switchvox Admin Tool Suite:
https://your_switchvox/admin
Log into the Admin Suite and use the Switchboard Plugins page (PBX Features > Switchboard Plugins).
For more information about using the Admin Suite and the Switchboard Plugins, see the Switchvox Administrator Manual.
Contents |
Overview
Switchboard custom panels let you create panels in the Switchboard that display dynamic URLs. The URL can include variables for the current call, and it is refreshed every time a call is received, which means that you can display a URL that has information about the current caller.
In the screenshot below, a custom panel was created with this URL:
http://www.google.com/pda/search?mrestrict=xhtml&q=%CALLER_ID_NAME%
The PDA formatted version of Google search was used to fit better in the small panel, but otherwise this is a standard search string. Switchvox replaces %CALLER_ID_NAME% with that value, submits the query, and reloads the panel.
Settings
The following settings must be provided:
Panel Name
The panel name will appear as the title of your panel.
Panel Description
This description is only displayed here in the admin area, it is not shown to the user.
Panel URL
This is the web page to be loaded in the panel. For example:
http://www.example.com/mywebservice?caller_id=%CALLER_ID_NUMBER%
The URL can contain variables that are substituted with a value. Variables are surrounded by percent signs (%) and are always uppercase. See below for the list of variables.
Extensions allowed to use this panel
Extensions added to the list on the right will be allowed to use the panel. Note that the panel does not automatically show up in their Switchboard until they select it in the panels menu inside the Switchboard.
URL Variables
These variables are substituted with the appropriate value for the current call.
CALLER_ID_NUMBER
The phone number of the current call. Example: 8585551212.
CALLER_ID_NAME
The text component of Caller-ID for the current call. Example: BOB JONES.