Reference13r3:Concept App myPhoneKeys
Applies To
- innovaphone PBX version 13r3 and up
Overview
The goal of the app is that administrators are able to view and control innovaphone V13-desk phones remotely via an app.
Supported phones:
- IP10x (IP101 and IP102)
- IP11x (IP111 and IP112)
- IP1x0 (IP150 and IP160)
- IP2x2 (IP222 and IP232)
Features
- Device list filter by domain, on- and/or offline devices
- Device list search by name, device-type, IP- or MAC-address and firmware (case-insensitive)
- Auto-refresh of the phone-screen
- Function keys depending on the device-type
- Registrations keys with state-indication (registered, not configured, disabled, registration failed) and information.
- Keypad and keys depending on the device-type (look and feel of real device)
- Changeable keyboard (Qwerty, Qwertz, Azerty)
- Pre-defined actions and input-field
Licensing
Per user configured to use the myPhoneKeys-App an 'App(innovaphone-myphonekeys)'-license is needed.
Requirements
- innovaphone AppPlatform
- innovaphone myApps
- innovaphone Devices Api (Part of Devices App)
Configuration
- Download the myPhoneKeys App via the App Store
- Install the myPhoneKeys App on the App Platform
- Create an instance of the myPhoneKeys App on the App Platform
- Make sure the Instance is running
- Create a new myPhoneKeys App Object with the PBX Manager Plugin (optional: assign to the correct template(s))
- Assign the myPhoneKeys to authorized users using a Config Template (could be done in previous step too) or directly on the User Object
- Assign 'innovaphone-myphonekeys'-licenses to the authorized users.
- Assign the 'devices-api' to the myPhoneKeys App Object via the PBX Advanced UI ('Apps'-tab)
- Open the myPhoneKeys App
Technical Overview
The App Service receives incoming WebSocket Connections ('WebSocket'-checkbox ticket) from each myPhoneKeys App-Object in the PBX.
Over the granted 'Services'-API all further granted devices-apis (Apps-tab) are being connected to and read out (domains and phones/devices). The App service will so maintain a local, up-to-date list of domains and devices in-memory.
Each licensed myPhoneKeys-App will requests this list of domains and devices on start-up and will be notified of updates (device/domain added/changed/deleted).
After selecting a phone to be monitored, the myPhoneKeys-app will request some useful information over the sysclient-connection from the phones; the same sysclient-connection is used to instruct the phone (touchscreen, function keys, dialpad, ...) and show the screen of the phone.
Apps
myPhoneKeys (innovaphone-myphonekeys)
The only installed and configured App in the PBX.
Parameters:
URL:
http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-myphonekeys
- WebSocket
- to establish the connection with the Services
- Services
- gives access to API provided by other App Services (devices-api from the Devices-App)
- Selected Apps
- devices-api (this is the default-name given by the Install, but can be named differently)
Troubleshooting
- If an issue can be reproduced:
- Open the console output of your browser (F12) or right-click/Inspect in the native client version of the myPhoneKeys App.
- Clear the console output and reproduce the issue.
- Copy/Paste or save the output as a text file and send attached in the support ticket.
- If an issue is suspected on the App Service on the App Platform, please use the 'App'- and 'App WebSocket'-trace flags.