Switchboard Panels

From SwitchvoxExtendAPI

Custom Switchboard Panels are set up in 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.

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 is refreshed every time a call is received. That means that you can display a Web page that was built with 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.

EXTENSION

The extension of the current Switchboard user. This does not apply to who is calling, but is instead the extension who has launched this Switchboard panel.

SESSION_ID

A string of numbers and underscores representing the current user's switchboard session. There are no guarantees that this session_id is unique across logins or machines.

FIRST_LOAD

A boolean integer value indicating if this is the first time the panel is requesting the page. On startup, the panel will request the url without any associated call information with FIRST_LOAD set to 1. After subsequent calls, FIRST_LOAD will be set to 0.

PARTIAL_REG_CODE

The last four digits of your PBX's registration code.

FULL_REG_CODE_DIGEST

A hexidecimal md5 hash of the PBX's registration code.

INCOMING_DID

The incoming did of the current call. Example: 8585551212