Grandstream VPK (Virtual Multi-Purpose Keys) Guide
Grandstream Networks, Inc.
Supported Devices
The following table shows Grandstream products supporting the VPK feature:
Model | Supported | Firmware |
---|---|---|
GXP21XX Series | ||
GXP2130 | Yes | 1.0.7.25 or higher |
GXP2140 | Yes | 1.0.7.25 or higher |
GXP2160 | Yes | 1.0.7.25 or higher |
GXP2135 | Yes | 1.0.7.25 or higher |
GXP2170 | Yes | 1.0.7.25 or higher |
Introduction
Grandstream GXP21XX IP phones have introduced a new VPK (“Virtual Multi-Purpose Keys”) feature to add more flexibility and provide a better user experience using Multi-Purpose Keys modes. With the new VPK feature design, line keys can be assigned with multiple functions. Users also have the ability to add more VPKs, which will be displayed on different screens. The screens are dynamically added to match the extra VPKs and incrementally indexed on the top of the main screen (1 to 4) until reaching the maximum number of supported VPKs.
Using VPK, users can monitor extensions, use speed dial numbers, send DTMF during calls, and more from their phone screens directly. Switching between screens shows configured VPKs and brings more flexibility to the user's experience.
If using standard MPK on a GXP2160 IP phone, which supports 6 line keys, customers can use 1 LINE key for the main SIP accounts and the 5 others (not including built-in MPKs) can be used for monitoring/speed dial or any other available features using that account. While using the VPK feature on the same GXP2160, customers can configure the same LINE key with up to 4 features virtually mapped on different screens. For example, Line 1 key can be configured as LINE on the first screen, BLF on screen 2, Speed Dial on screen 3, and Call Park on screen 4.
Below screenshot shows the 4 screen pages of the GXP2160:
Figure 1: VPK Pages
Fixed and Dynamic VPK
Fixed VPK
Fixed VPKs are the hard line keys on each phone model; their default mode is “Line” and support all other modes (BLF, Speed Dial…). Each phone model has a specific number of hard line keys limiting the number of supported Fixed VPKs. For instance, GXP2170 has 12 Line keys, allowing it to support 12 Fixed VPKs.
Dynamic VPK
Dynamic VPKs are virtual keys that can be added by users. Each phone model has a specific number of allowed Dynamic VPKs, depending on the number of hard line keys and screens. For instance, GXP2170 has 12 hard keys, and the number of supported VPKs (Fixed and Dynamic) is 48 VPK = 12 (Fixed VPK) x 4 (screens). Available Dynamic VPKs are 36 VPK = 48 VPK - 12 hard keys. The screens are dynamically added to match the extra VPKs and incrementally indexed on the top of the main screen (1 to 4) until reaching the maximum number of supported VPKs.
Note: Dynamic VPKs support all available modes (BLF, Speed Dial, Call Park, transfer…) except LINE, Shared Line, and NONE modes.
Fixed/Dynamic VPK per Phone Model
The table below shows how many Fixed/Dynamic VPKs each GXP model supports.
GXP2130 | GXP2140 | GXP2160 | GXP2135 | GXP2170 | |
---|---|---|---|---|---|
Fixed VPK | 3 | 4 | 6 | 8 | 12 |
Dynamic VPK | 9 | 12 | 18 | 24 | 36 |
Total VPK | 12 | 16 | 24 | 32 | 48 |
Table 1: Fixed/Dynamic VPK per Phone Model
Note: Even if a fixed VPK has its mode set to “None”, the number of allowed Dynamic VPKs will not change.
VPK Configuration
To configure, add, edit, or delete a VPK, follow these steps:
- Access the Web GUI of the GXP phone.
- Go to Settings → Programmable Keys → Virtual Multi-Purpose Keys.
Figure 2: Virtual Multi-Purpose Keys page
Configure Fixed or Dynamic VPKs as follows:
a. Fixed VPK:
- Press the Edit VPK button.
- Select the mode to use from the Mode dropdown list.
- Select the Account# from the Accounts dropdown list.
- Enter a description text in the Description field (optional).
- Enter the value sequence for each mode in the Value field if required.
- Press the Save button to save your configuration (the Reset button allows to reset all fields to default values).
- Press Save VPK to apply changes to the VPK.
Note: Fixed VPKs can only be edited. Adding or deleting Fixed VPK is not allowed.
b. Dynamic VPK
- Press Add VPK to create a new Dynamic VPK.
- Select the mode to use from the Mode dropdown list.
- Select the Account# from the Accounts dropdown list.
- Enter a description text in the Description field (optional).
- Enter the value sequence for each mode in the Value field if required.
- Press the Save button to save your configuration (the Reset button allows to reset the VPK to default value).
- Press Save VPK to apply changes to the VPK.
Note: Once added and saved, Edit VPK and Delete VPK buttons will appear. Customers can press the Edit VPK button to edit or Delete VPK to remove the selected VPK.
Example for Fixed VPK: A customer's GXP2170 has a SIP account registered on Account 1 and needs to monitor extension 1000. The following values need to be used: Mode: Busy Lamp Field (BLF), Accounts: Account 1 (selected), Description: BLF_1000 (optional), Value: 1000.
Figure 3: Fixed VPK – Edit
Figure 4: Add VPK
Example for Dynamic VPK: A customer's GXP2170 has a SIP account registered on Account 1 and wants to add a Speed Dial for extension 1001. Below values need to be used: Mode: Speed Dial, Accounts: Account 1 (selected), Description: SP_1001 (optional), Value: 1001.
Figure 5: Dynamic VPK
VPK Modes and Indication
Fixed VPK supports all available modes (20 modes), while Dynamic VPK does not support Line, Shared Line, and None modes (17 modes).
The following table provides a description of each mode, as well as state, icon, and LED status.
VPK Mode | Description | State | Icon | LED Status |
---|---|---|---|---|
Speed Dial | Speed Dial mode allows setting a key for one-touch dialing; the configured number will be dialed once VPK is pressed. Select the Account to dial from and enter the Speed Dial number to be dialed in the Value field, or enter the IP address to set the Direct IP call as Speed Dial. | Account Unregistered Account Registered |
? |
OFF ON |
Busy Lamp Field (BLF) | Busy Lamp Field (BLF) mode allows monitoring the status (available, ringing, busy) of an extension. Select the Account to monitor the BLF status. Enter the extension number in the Value field to be monitored. | Offline, Unknown Terminated Proceeding Ringing (Early) Trying Confirmed |
? ? ? ? ? |
OFF GREEN RED Flashing RED Flashing RED RED |
Speed Dial Via Active Account | Speed Dial via active account mode allows setting a key for one-touch dialing; the configured number will be dialed once VPK is pressed using the specified account if available, otherwise, the first available account will be used to dial out. Select the Account to dial from and enter the Speed Dial number to be dialed in the Value field, or enter the IP address to set the Direct IP call as Speed Dial. | No state changes | ? | OFF |
Dial DTMF | Dial DTMF allows customers to send digits while in communication. For instance, when dialing an IVR, users can set a Dial DTMF Key to send digits to the IVR. Enter a series of DTMF digits in the Value field to be dialed during the call. | No state changes | #️⃣ | OFF |
Voice Mail | Allows access to the user's voice mail by pressing the configured VPK. Select Account and enter the Voice Mail access number in the Value field. | Account not registered Account Registered (No new voice mail) Account Registered (voice mail available) |
? ? |
OFF OFF OFF |
Call Return | Allows users to dial the last answered call by pressing the configured VPK. The Value field should be left blank. | No state changes | ? | OFF |
Transfer | This option is not binding to the account and the call will be returned based on the account with the last answered call. Allows setting a destination number to transfer calls to it (blind transfer) by pressing the configured VPK. Select Account, and enter the number in the Value field to be transferred during the call. | Account Unregistered Account Registered |
➡️ |
OFF OFF |
Call Park | This feature allows parking/picking up calls and can also be used to monitor parking lots via VPK button's LED. Select Account, and enter the call park extension in the Value field to park/pick up the call. Notes: • If Value field has a leading star code like *xx, the phone will not send SUBSCRIBE to the server, and VPK will be used to only park/retrieve calls. • If Value field is set with parking lots (e.g., 701, 702…), VPK will be used as Monitored Call Park; the phone will send SUBSCRIBE to monitor configured parking lots and park/retrieve calls. |
Account Unregistered Account Registered |
?️ ?️ |
OFF OFF |
Intercom | Allows setting a VPK as an intercom button to a specific destination with auto-answer instruction. When the call is initiated, SIP INVITE sent towards the destination extension (via SIP server) will include Alert-info header with Auto-answer=0 parameter. Select Account, and enter the extension number in the Value field to perform the intercom. | Account Unregistered Account Registered |
(()) (()) |
OFF OFF |
LDAP Search | This option is to narrow the LDAP search scope. Enter the LDAP search base in the Description field. It could be the same or different from the Base in LDAP configuration under Advanced Settings. The Base in LDAP configuration will be used if the Description field is left blank. Enter the LDAP Name/Number filter in the Value field. For example: If users set VPK as “LDAP Search” for “Account 1”, and set filters: Description -> ou=video,ou=SZ,dc=grandstream,dc=com, Value -> sn=Li. Since the Base for LDAP server configuration is “dc=grandstream,dc=com”, “ou=video,ou=SZ” is added to narrow the LDAP search scope. “sn=Li” is the example to filter the last name. | No State | OFF | |
Multicast Paging | Multicast paging is a feature that allows the user to make calls to a group of phones listening to the same Paging IP address. Multicast paging calls will be automatically answered on listening phones, and conversation will be in one-way audio path (originator can speak, while listening phones will be able to hear only). Enter Line key description in Description field and multicast sending address in Value field. | No State | OFF | |
Record | Allows users to record ongoing calls. Recording needs to be supported on the server to use this feature. | Idle Recording |
? |
OFF Flashing REC |
Call Log | This Key is a shortcut to Call History. | No state | OFF | |
Menu | This Key is a shortcut to the Menu button. | No state | OFF | |
Presence Watcher | Presence watcher allows monitoring presence/registration status of an extension. This feature needs to be supported by SIP server to use it. Select the Account to monitor the presence status. Enter the extension number in the Value field to be monitored. | Offline, Unknown Available |
? |
OFF GREEN |
Monitored Call Park | This feature allows parking/picking up calls and monitoring the parked call via VPK button's LED. Select account from Account field, and enter the call park extension in the Value field. Note: The phone sends SUBSCRIBE to the server to retrieve the status of monitored parking lots. |
Offline, Unknown Available Call Parked |
?️ ?️ |
OFF GREEN RED |
Eventlist BLF | Eventlist BLF allows monitoring a list of extensions similar to BLF. The administrator needs to configure Eventlist BLF on the server side and provide the Eventlist BLF URI on the phone. Select the Account to monitor the Eventlist BLF status. Enter the extension number in the Value field to be monitored and make sure to specify “Eventlist BLF URI” (Account X → SIP Settings → Advanced Features). | Offline, Unknown Terminated Proceeding Ringing (Early) Trying Confirmed |
? ? ? ? |
OFF GREEN RED Flashing RED Flashing RED RED |
Line | Regular line key to open up a line and switch line. The Description and Value fields can be left blank. Note: Line mode is supported on Fixed VPK only. |
Unregistered (No IM, Voice mail, No Call Forward) Registered + Idle (No IM, Voice mail, No Call Forward) Unregistered + IM (No Voice mail) Registered + IM (No Voice mail) Unregistered + Voice Mail (No IM) Registered + Voice Mail (No IM) Unregistered + Call Forward All (No IM, No Voice Mail) Registered + Call Forward All (No IM, No Voice Mail) Unregistered + Call Forward Delay + Call Forward Busy (No IM, No Voice Mail) Registered + Call Forward Delay + Call Forward Busy (No IM, No Voice Mail) Unregistered + Call Forward Delay (No IM, No Voice Mail, No Call Forward Busy) Registered + Call Forward Delay (No IM, No Voice Mail, No Call Forward Busy) Unregistered + Call Forward Busy (No IM, No Voice Mail, No Call Forward Delay) Registered + Call Forward Busy (No IM, No Voice Mail, No Call Forward Delay) Registered + Ringing Registered + On Hold Registered + Connected + Incoming Call Registered + Connected + Outgoing Call |
? ? ? ? |
OFF OFF OFF OFF OFF OFF OFF OFF OFF OFF OFF OFF OFF OFF Flashing RED Flashing GREEN GREEN GREEN |
Shared Line | Share line for Shared Line Appearance feature. Select the Account registered as Shared line for the line key. The Description and Value fields can be left blank. Note: You may refer to this guide for more detail about Shared Line configuration: BS SCA conf Guide |
Unregistered Registered + Not support SCA Call-info header Registered + Not support SCA or SCA Failed Registered + Idle Registered + Seized Registered + Processing Registered + Alert Registered + Hold by user Registered + Hold by the other party Registered + Connected |
? ? ? ? |
OFF OFF OFF OFF RED Flashing GREEN Flashing RED Flashing GREEN Flashing RED GREEN |
Screen Examples
The following screenshots show the GXP2170 screen's first two pages:
Figure 6: Screen Example - Page 1
Figure 7: Screen Example - Page 2