innovaphone wiki - User contributions [en]

Howto:How to configure a nightly automatic phone restart via Devices app expert config

2026-10-15T16:25:11Z

Kpe: /* Problem description */

==Titel==
Nightly automatic phone restart via Devices app expert config

==Problem description==
Beeing able to restart a device automatically on a scheduled time

==Applies To==
IP Phones and Gateways that are registered to the Devices App

==Concept==

The expert configuration of the Devices app only runs '''once''': after a device restart, or when the expert configuration is changed. That means it cannot schedule anything itself.

So the expert config only sets the phone’s '''update server URL (UP1)''' to a small script stored in the Files app. The phone downloads that script every 15 minutes. A <code>times</code> command inside the script makes sure the reset only happens in the chosen night hour.

=== Step 1 – Create the script <code>nightly.txt</code> ===
Upload this file to a shared folder in the Files app:
mod cmd UP1 times /allow 0 /initial 61
reset
{| class="wikitable"
!Line
!Meaning
|-
|<code>times /allow 0</code>
|The script only runs between '''00:00 and 00:59'''. At any other time, processing stops right after this line.
|-
|<code>/initial 61</code>
|Nothing runs during the first 61 minutes after a boot. After the reset at 00:xx, the next allowed hour is already over, so the phone does not loop.
|-
|<code>reset</code>
|'''Immediate''' restart, even during an active call. Use <code>ireset</code> instead to wait until the phone is idle.
|}
Get the '''fileskey''' from the info (“i”) button of the shared folder in the Files app.

=== Step 2 – Devices app: expert configuration ===
Create a device configuration of type '''Expert configuration''', assign it to the provisioning category of the phones, and enter:
config change UP1 /url https://<apps-host>/<domain>/files/UI/<folder>/nightly.txt&fileskey=<fileskey> /poll 15 /no-dhcp
config write
config activate

* <code>/poll 15</code>: the phone polls the script every 15 minutes.
* <code>/no-dhcp</code>: a URL handed out by DHCP cannot overwrite this URL.
* Do '''not''' add <code>iresetn</code>, <code>vars create</code> or <code>times</code> to the expert config. They can cause a reboot loop or stop the expert config from running.

=== Step 3 – Prerequisites ===

* The phone has a valid time from NTP. Without it, <code>times</code> cancels every execution.
* The phone trusts the HTTPS certificate of the apps host.
* The URL works in a browser and shows the two lines of the script.

=== Step 4 – Verify (optional) ===

* Add <code>/trace</code> to the <code>config change UP1</code> line.
* In the phone’s Advanced UI, go to '''Maintenance → Diagnostics → Tracing''', enable '''HTTP Client''' and open '''trace(continuous)'''. There you can see the script being fetched and the server’s answer.
* To test during the day, temporarily use the current hour and a small <code>/initial</code> value (e.g. <code>/allow 16,17 /initial 1</code>). The phone then restarts about every 15 minutes within those hours.
* After testing, set the script back to <code>/allow 0 /initial 61</code> and remove <code>/trace</code>.

== Related Articles ==
*[[Reference16r1:Concept_App_Service_Devices#Expert_configuration]]
*[[Reference13r3:Concept_Update_Server#Times_command]]
*[[Reference13r3:Concept_Update_Server#Check_command]]
*[[Reference13r3:Maintenance/Diagnostics/Tracing]]

[[Category:Howto|{{PAGENAME}}]]

Howto:How to configure a nightly automatic phone restart via Devices app expert config

2026-10-15T16:24:15Z

Kpe: /* Related Articles */

==Titel==
Nightly automatic phone restart via Devices app expert config

==Problem description==
Beeing able to restart a device automatically via a scheduled time

==Applies To==
IP Phones and Gateways that are registered to the Devices App

==Concept==

The expert configuration of the Devices app only runs '''once''': after a device restart, or when the expert configuration is changed. That means it cannot schedule anything itself.

So the expert config only sets the phone’s '''update server URL (UP1)''' to a small script stored in the Files app. The phone downloads that script every 15 minutes. A <code>times</code> command inside the script makes sure the reset only happens in the chosen night hour.

=== Step 1 – Create the script <code>nightly.txt</code> ===
Upload this file to a shared folder in the Files app:
mod cmd UP1 times /allow 0 /initial 61
reset
{| class="wikitable"
!Line
!Meaning
|-
|<code>times /allow 0</code>
|The script only runs between '''00:00 and 00:59'''. At any other time, processing stops right after this line.
|-
|<code>/initial 61</code>
|Nothing runs during the first 61 minutes after a boot. After the reset at 00:xx, the next allowed hour is already over, so the phone does not loop.
|-
|<code>reset</code>
|'''Immediate''' restart, even during an active call. Use <code>ireset</code> instead to wait until the phone is idle.
|}
Get the '''fileskey''' from the info (“i”) button of the shared folder in the Files app.

=== Step 2 – Devices app: expert configuration ===
Create a device configuration of type '''Expert configuration''', assign it to the provisioning category of the phones, and enter:
config change UP1 /url https://<apps-host>/<domain>/files/UI/<folder>/nightly.txt&fileskey=<fileskey> /poll 15 /no-dhcp
config write
config activate

* <code>/poll 15</code>: the phone polls the script every 15 minutes.
* <code>/no-dhcp</code>: a URL handed out by DHCP cannot overwrite this URL.
* Do '''not''' add <code>iresetn</code>, <code>vars create</code> or <code>times</code> to the expert config. They can cause a reboot loop or stop the expert config from running.

=== Step 3 – Prerequisites ===

* The phone has a valid time from NTP. Without it, <code>times</code> cancels every execution.
* The phone trusts the HTTPS certificate of the apps host.
* The URL works in a browser and shows the two lines of the script.

=== Step 4 – Verify (optional) ===

* Add <code>/trace</code> to the <code>config change UP1</code> line.
* In the phone’s Advanced UI, go to '''Maintenance → Diagnostics → Tracing''', enable '''HTTP Client''' and open '''trace(continuous)'''. There you can see the script being fetched and the server’s answer.
* To test during the day, temporarily use the current hour and a small <code>/initial</code> value (e.g. <code>/allow 16,17 /initial 1</code>). The phone then restarts about every 15 minutes within those hours.
* After testing, set the script back to <code>/allow 0 /initial 61</code> and remove <code>/trace</code>.

== Related Articles ==
*[[Reference16r1:Concept_App_Service_Devices#Expert_configuration]]
*[[Reference13r3:Concept_Update_Server#Times_command]]
*[[Reference13r3:Concept_Update_Server#Check_command]]
*[[Reference13r3:Maintenance/Diagnostics/Tracing]]

[[Category:Howto|{{PAGENAME}}]]

Howto:How to configure a nightly automatic phone restart via Devices app expert config

2026-10-15T16:19:53Z

Kpe:

==Titel==
Nightly automatic phone restart via Devices app expert config

==Problem description==
Beeing able to restart a device automatically via a scheduled time

==Applies To==
IP Phones and Gateways that are registered to the Devices App

==Concept==

The expert configuration of the Devices app only runs '''once''': after a device restart, or when the expert configuration is changed. That means it cannot schedule anything itself.

So the expert config only sets the phone’s '''update server URL (UP1)''' to a small script stored in the Files app. The phone downloads that script every 15 minutes. A <code>times</code> command inside the script makes sure the reset only happens in the chosen night hour.

=== Step 1 – Create the script <code>nightly.txt</code> ===
Upload this file to a shared folder in the Files app:
mod cmd UP1 times /allow 0 /initial 61
reset
{| class="wikitable"
!Line
!Meaning
|-
|<code>times /allow 0</code>
|The script only runs between '''00:00 and 00:59'''. At any other time, processing stops right after this line.
|-
|<code>/initial 61</code>
|Nothing runs during the first 61 minutes after a boot. After the reset at 00:xx, the next allowed hour is already over, so the phone does not loop.
|-
|<code>reset</code>
|'''Immediate''' restart, even during an active call. Use <code>ireset</code> instead to wait until the phone is idle.
|}
Get the '''fileskey''' from the info (“i”) button of the shared folder in the Files app.

=== Step 2 – Devices app: expert configuration ===
Create a device configuration of type '''Expert configuration''', assign it to the provisioning category of the phones, and enter:
config change UP1 /url https://<apps-host>/<domain>/files/UI/<folder>/nightly.txt&fileskey=<fileskey> /poll 15 /no-dhcp
config write
config activate

* <code>/poll 15</code>: the phone polls the script every 15 minutes.
* <code>/no-dhcp</code>: a URL handed out by DHCP cannot overwrite this URL.
* Do '''not''' add <code>iresetn</code>, <code>vars create</code> or <code>times</code> to the expert config. They can cause a reboot loop or stop the expert config from running.

=== Step 3 – Prerequisites ===

* The phone has a valid time from NTP. Without it, <code>times</code> cancels every execution.
* The phone trusts the HTTPS certificate of the apps host.
* The URL works in a browser and shows the two lines of the script.

=== Step 4 – Verify (optional) ===

* Add <code>/trace</code> to the <code>config change UP1</code> line.
* In the phone’s Advanced UI, go to '''Maintenance → Diagnostics → Tracing''', enable '''HTTP Client''' and open '''trace(continuous)'''. There you can see the script being fetched and the server’s answer.
* To test during the day, temporarily use the current hour and a small <code>/initial</code> value (e.g. <code>/allow 16,17 /initial 1</code>). The phone then restarts about every 15 minutes within those hours.
* After testing, set the script back to <code>/allow 0 /initial 61</code> and remove <code>/trace</code>.

== Related Articles ==
*[[Devices app – Expert configuration: https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept App Service Devices&action=edit&redlink=1#Expert configuration|Devices app – Expert configuration: https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_Devices#Expert_configuration]]
*[[Update server – times command: https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept Update Server&action=edit&redlink=1#Times command|Update server – times command: https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Update_Server#Times_command]]
*[[Update server – reset commands: https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept Update Server&action=edit&redlink=1#Check command|Update server – reset commands: https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Update_Server#Check_command]]
*[[Tracing: https://wiki.innovaphone.com/index.php?title=Reference13r3:Maintenance/Diagnostics/Tracing&action=edit&redlink=1|Tracing: https://wiki.innovaphone.com/index.php?title=Reference13r3:Maintenance/Diagnostics/Tracing]]

[[Category:Howto|{{PAGENAME}}]]

Howto:How to configure a nightly automatic phone restart via Devices app expert config

2026-10-15T16:18:05Z

Kpe:

==Titel==
Nightly automatic phone restart via Devices app expert config

==Problem description==
Beeing able to restart a device automatically via a scheduled time

==Applies To==
IP Phones and Gateways that are registered to the Devices App

==More Information==

tekst

== Related Articles ==
*[[Devices app – Expert configuration: https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept App Service Devices&action=edit&redlink=1#Expert configuration|Devices app – Expert configuration: https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_Devices#Expert_configuration]]
*[[Update server – times command: https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept Update Server&action=edit&redlink=1#Times command|Update server – times command: https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Update_Server#Times_command]]
*[[Update server – reset commands: https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept Update Server&action=edit&redlink=1#Check command|Update server – reset commands: https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Update_Server#Check_command]]
*[[Tracing: https://wiki.innovaphone.com/index.php?title=Reference13r3:Maintenance/Diagnostics/Tracing&action=edit&redlink=1|Tracing: https://wiki.innovaphone.com/index.php?title=Reference13r3:Maintenance/Diagnostics/Tracing]]

[[Category:Howto|{{PAGENAME}}]]

Howto:How to configure a nightly automatic phone restart via Devices app expert config

2026-10-15T16:16:54Z

Kpe: Created page with "==Titel== Nightly automatic phone restart via Devices app expert config ==Problem description== Beeing able to restart a device automatically via a scheduled time ==Applies To== IP Phones and Gateways that are registered to the Devices App ==More Information== == Related Articles == *Devices app – Expert configuration: https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_Devices#Expert_configuration *Update server – times command:..."

==Titel==
Nightly automatic phone restart via Devices app expert config

==Problem description==
Beeing able to restart a device automatically via a scheduled time

==Applies To==
IP Phones and Gateways that are registered to the Devices App

==More Information==

== Related Articles ==
*[[Devices app – Expert configuration: https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Service_Devices#Expert_configuration]]
*[[Update server – times command: https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Update_Server#Times_command]]
*[[Update server – reset commands: https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_Update_Server#Check_command]]
*[[Tracing: https://wiki.innovaphone.com/index.php?title=Reference13r3:Maintenance/Diagnostics/Tracing]]

[[Category:Howto|{{PAGENAME}}]]

Reference16r1:Concept innovaphone App Platform Container

2026-09-30T07:53:27Z

Kpe: /* Offline creation */

The innovaphone App Platform Container provides a myApps App Platform instance that includes the AP Manager, Webserver and PostgreSQL. This container offers a ready-to-use environment for myApps applications and the innovaphone PBX.

== Applies To ==

* innovaphone App Platform Container

==Requirements==
* A container runtime supporting the OCI (Open Container Initiative) image format — e.g. Docker, Kubernetes, containerd, or CRI-O
* A host on a x86_64 (amd64) or arm64 (aarch64) platform
* innovaphone App Platform Container

The container image is built and published as a standard OCI-compliant, multi-architecture image. It can be run directly with Docker or deployed on Kubernetes (or any other OCI-compatible platform). The runtime automatically selects the correct image variant (amd64 or arm64) matching the host platform — no additional configuration or platform flags are required.

==Image Tags==
Each released build is published under a numeric version tag (e.g. <code>140048</code>), pointing to a multi-architecture manifest covering both amd64 and arm64. Architecture-specific tags are also published for each build, using the suffix <code>-amd64</code> or <code>-arm64</code> (e.g. <code>140048-amd64</code>, <code>140048-arm64</code>), for cases where a specific platform variant needs to be pulled explicitly.

The <code>latest</code> tag always points to the most recent stable build and, like the numeric version tags, is published as a multi-architecture manifest. Corresponding <code>latest-amd64</code> and <code>latest-arm64</code> tags are also available.

==Concept==

The innovaphone App Platform Container provides the innovaphone App Platform for container environments (Open Container Initiative (OCI) format).

* The App Platform Manager and Webserver Apps are already integrated in the container and provide the already known functionality.
* Apps are installed, updated and managed as usual.
* The mount point will be used for the database, the App binaries and log files.

==Image Information==

This chapter provides details about the Docker image used for the innovaphone App Platform.

===Repository Details===

;Repository Host : registry.innovaphone.com
;Image Name : cloud/kubernetes/innovaphone-platform-instance

registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

===Tagging and Versioning===
The image is usually tagged with the build number according to innovaphone software releases:

;Latest Tag : Use the latest tag for pulling the most recent service release.

;Release Build Number : For production or version-specific deployments, use a specific build number as the tag (e.g., 130006).

Example:
docker pull registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

===Supported Architecture===
This Docker image supports the <code>linux/amd64</code> architecture.

===Image Reference===
An example of a full image reference using a specific release build number would be:
registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

==Ports==
This chapter outlines the various ports exposed by the container. The webserver ports are available immediately upon container startup, after start of the AP Manager and the Webserver, while the additional application ports become active after the app installation. In most cases, a one-to-one mapping is used, meaning the container port is mapped directly to the same host port unless otherwise specified.

===Ports < 1024===
On most docker hosts, a container won't be able to use ports below 1024, unless the container is started with higher privileges.
This shouldn't be neccessary anyways as all ports can be configured to higher ports.

===Webserver Ports===
;HTTP:
Container Port: 8080
Description: Used for accessing the built-in webserver immediately upon container startup.

;HTTPS:
Container Port: 8082
Description: Used for accessing the built-in webserver immediately upon container startup.

=== Additional Application Ports===
Following additional container ports are avilable depending on installed and configured applications:
;H323/TLS : 1300
;SIP : 5060
;SIPS : 5061
;LDAPS : 1636
;SMTP : 8025
;SMTPS : 8587
;STUN/TURN : 3478 UDP/TCP
'''Additional hint for Portmapping'''<syntaxhighlight lang="yaml" line="1">
docker run -d \
--name=innovaphone \
--restart unless-stopped \
-p 9090:8080 \ #Container Host Port (external) 9090:8080 Container Port
-p 9091:8082 \
-p 5060:5060 \
-p 5061:5061 \
-p 1300:1300 \
-p 1636:1636 \
-p 8025:8025 \
-p 8587:8587 \
-p 3478:3478 \
-p 3478:3478/udp \
-v /path/of/data/innovaphone:/mnt/data \ #in this path you will find Apps, DBs & Logs
#this path musst be used for backups!!
-e WEBSERVERPORTHTTP=8080 \
-e WEBSERVERPORTHTTPS=8082 \
-e LOG_FLAGS=7 \
-e LOG_SIZE=1048576 \
-e DNSIPV4=8.8.8.8 \
-e LIMIT_RAM=512 \ #Ram limit in MB
-e LIMIT_DISK=10 \ #disk size in GB
-e TZ=Europe/Berlin \
registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

</syntaxhighlight>

==Environment Variables (ENVs)==
This chapter outlines the key environment variables used to configure the behavior of the innovaphone App Platform Container. These variables allow you to customize logging, port settings, resource limits, and more during startup and runtime.

;LOG_FLAGS : Defines the integer representation for the trace flags of the AP Manager, according flags activated under the AP Manager / Diagnostics. See browser console message on Save button press (e.g. "logFlags":1 , if the "App" flag is activated).
LOG_FLAGS=7
;LOG_SIZE : Specifies the maximum size in bytes for logs before rotation or management actions occur. Default: 5242880.
LOG_SIZE=1048576
;WEBSERVERPORTHTTP : Sets the in-container HTTP port for the webserver. Default: 8080.
WEBSERVERPORTHTTP=8080
;WEBSERVERPORTHTTPS : Sets the in-container HTTPS port for the webserver. Default: 8082.
WEBSERVERPORTHTTPS=8443
;DNSIPV4 : Specifies the in-container DNS server IPv4 address for DNS resolution. Overrides the default container runtime DNS server.
DNSIPV4=8.8.8.8
;DNS_DOMAIN : The FQDN of the App Platform that can be used to access the app services. This optional parameter is used as a static DNS entry added to /etc/hosts. The destination IP address is the resolved IP address behind INTERNAL_DNS_DOMAIN or NAMESPACE.
DNS_DOMAIN=ap.example.com
;INTERNAL_DNS_DOMAIN : The internal FQDN of the App Platform. This FQDN is used to resolve the internal IP address of the App Platform, to be mapped from DNS_DOMAIN in /etc/hosts.
INTERNAL_DNS_DOMAIN=my-apps-deployment.my-namespace.svc.cluster.local
;NAMESPACE : The Kubernetes namespace used to build internal FQDN of the App Platform. Used with DNS_DOMAIN to map it to the IP address of ap.my-namespace.svc.cluster.local.
NAMESPACE=my-namespace
;LIMIT_RAM : Sets the RAM limit for the container, in MB, controlling how much memory it may consume. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_RAM=512
;LIMIT_DISK : Defines the disk space limit in GB for the container to manage storage consumption. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_DISK=10

==File limits==
Containers may have a default file limit per process, e.g. 1024 files. Depending on your installation and usage, this value is too small and you need to allow more, e.g. handing this in the docker run command:
--ulimit nofile=500000:500000

==Volumes and Mounts==
This container uses a dedicated internal mount path for the persistent data management across container restarts and updates.

===Internal Data Volume===
;Mount Path : <code>/mnt/data</code>
;Contents:
*Apps: Installed application binaries.
*Databases: PostgreSQL files.
*Logging: Log files for system and application events.

===Mounting===
To ensure that your data is preserved, map a host directory or Docker named volume to the container's /mnt/data path when running the container.
For example:
docker run -d -v /path/on/host:/mnt/data registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

This setup guarantees that your apps, associated data, databases, and logs persist independently of the container lifecycle.

==Entrypoint==
The container uses a fixed entrypoint:
ENTRYPOINT ["/entrypoint.sh"]

This script prepares the container and starts the AP Manager executable.

==Serial number==
===Online creation===
A container first tries to connect to my.innovaphone.com to fetch a unique serial number, which will be later used etc. for licensing.
If this fails, the offline creation is enabled.

===Offline creation (from V16r1sr6 and up)===
As long as there is no valid serial number, e.g. the App IP cannot be installed or started.

* open the settings and '''Container MAC'''
* download a request file
* login to [https://portal.innovaphone.com Portal my.innovaphone]
* navigate to Licenses -> Licenses -> Devices and open '''Create a container MAC from an offline request file'''
* upload the previously downloaded request file -> you'll get a download of the answer file with a unqiue serial number
* upload this answer in the Settings of the App Platform Manager
* the App Platform Manager reboots now and has this serial number assigned

===Restore of a container backup===
If you restore the container backup, you will get a new unique serial number and you can't revert back to the old serial number.
In such a case you must request a license move from the old to the new serial number by license@innovaphone.com

==Logging and Monitoring==
The log of the entrypoint.sh and of the AP manager is avilable as conatiner output. The installed applications store the ir log files under <code>/mnt/data/var/log/apps/</code>.

=== Unexpected high system load ===
If you encounter a high load, you need to verify whether the load is actually coming from your container. Docker containers always display the load of the physical host system.

It may be that the Docker host itself is also virtualized as an LXC container, and your Docker instances are running within it. In such a setup, the system load of the physical host is displayed because <code>/proc/loadavg</code> is not isolated per logical layer.

An increased load in the container therefore does not automatically mean that the container itself is the cause or that you have a problem at all. In short: To assess the load, you always need information (e.g., number of CPU cores or I/O information) from the physical host.

==Usage Example==
sudo docker run -d --ulimit nofile=500000:500000 --restart unless-stopped --name innovaphoneAP -p 9090:8080 -p 9091:8082 -e WEBSERVERPORTHTTP=8080 -e WEBSERVERPORTHTTPS=8082 -v $(pwd)/myapps/:/mnt/data registry.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

This command runs the container in detached mode with automatic restart. It names the container innovaphoneAP, maps host ports 9090 and 9091 to the container's HTTP and HTTPS ports, sets the webserver port environment variables, mounts a host directory to /mnt/data, and starts the AP Manager. After container start up the AP manager web UI is accessible via <code>http://localhost:9090</code> or <code>https://localhost:9091</code>.

== Related Articles ==
[https://wiki.innovaphone.com/index.php?title=Howto16r1:Step-by-Step_Docker_Compose_Container_Deployment Step-by-Step Docker Compose Container Deployment]

[https://wiki.innovaphone.com/index.php?title=Howto:Install_and_Upgrade_the_App_Platform_using_Helm Howto:Install and Upgrade the App Platform using Helm]

Reference16r1:Concept App Service Connector for Whatsapp

2026-09-18T16:32:16Z

Kpe: /* Requirements */

== Applies To ==

<ul><li>innovaphone System (PBX/AP) from version 16r1 upwards</li>
</li></ul>

== Requirements ==

<ul><li> innovaphone PBX
</li><li> innovaphone AppPlatform
</li><li> innovaphone myApps
</li><li> Messages App service and Connect app
</li><li> A Facebook account
</li><li> At least one valid phone number (MSN) required for the registration with the WhatsApp Business platform. This number cannot be associated with the free version of whatsapp already.
</li><li> The reverse proxy must be configured to allow connections to <dns-name of AP>/<domain-name>/whatsapp.
</li></ul>

== Licensing ==
This product requires licensing. You will need the following license.
<ul><li>Name: innovaphone Connector für WhatsApp
</li><li>ID: Service(innovaphone-whatsapp)
</li><li>Order number: 02-00050-017
</li></ul>

== Concept ==

The Connector for WhatsApp establishes a connection to the WhatsApp Business Platform and to a Connect instance. Messages can be exchanged between Connect users and WhatsApp users. Supported message types include text messages, locations, contacts, reactions, and media files ( e.g png, .jpg, .pdf, .mp4, .txt). You can find a full list here [https://developers.facebook.com/documentation/business-messaging/whatsapp/business-phone-numbers/media#supported-media-types here]]

[[image:Concept-connector-whatsapp.png|concept-connector-whatsapp.png/|concept-connector-whatsapp.png/]]

== How it works ==

Messages written by WhatsApp users will be displayed in Connect alsongside with the Name of the Sender. By answering within the feed, the message is sent to the whatsapp-account of the initiator of the conversation.

Please note that a discussion can only be initiated by the WhatsApp user. A Connect user can reply to a message from WhatsApp within a 24-hour time window. If there was no response within the time frame, a new discussion will be created in Connect when a new message from the same number is received.


Within a discussion in Connect, all messages are forwarded to the sender of the WhatsApp message, not only those posted as direct replies to the incoming message. Private messages are excluded from this behavior and can only be viewed by the author and the recipient.


== Apps ==
=== App (innovaphone-whatsapp) ===
[[image:whatsapp-connector.png|whatsapp-connector.png/|whatsapp-connector.png/]]The Settings plugin enable the following parameters:

;Hidden: This app has no user interface and should be hidden for users
;Websocket: Connection between the PBX and the App Platform.
;Services: API which is used to get access to APIs provided by other App Services
;connect: The connector for Whatspp needs access to connect to the Connect App
;connect~moderator: The Connector for Whatsapp needs ''moderator'' rights to access the Connect App.

Please note that Connect needs to have access to the Connector for Whatsapp as well. As a result, please make sure to enable the checkbox for the Connector for Whatsapp inside the Apps tab of the Connect app.

== Steps to set up the Connector for Whatsapp ==
=== Install ===
*Install the WhatsApp Connector via the ''app Installer'' Settings plugin.
* Create a new PBX Object for the WhatsApp Connector with the Settings Plugin of the Connector for Whatsapp.
** Configure a name and SIPid
** Select your Connect app
** Select the moderator mode of the Connect app.
** Select a config template. Users inheriting from this template will have access to the Connect zone where WhatsApp posts are sent.
** Configure the license amount

Please note that only one app object can be created per instance. To create another, a separate app service instance is required.

=== Set up===
After the initial installation of the Connector for WhatsApp, you need to onboard the Connector for Whatsapp to the WhatsApp Business Platform. It is crucial that the App Object exists on the PBX before you start the Onboarding process 

[[image:whatsapp-oboarding.png|whatsapp-oboarding.png/|whatsapp-oboarding.png/]] 

Go to the ''Whatsapp Settings'' Plugin in your Settings app and open ''Set Up''. 

[[image:Set-up-whatsapp1.png|set-up-whatsapp1.png/|set-up-whatsapp1.png/]] 

Next, configure any 6-digit PIN. Please store the PIN in a safe place, as it is required for the administration of your Phone IDs if they need to be deleted. 

[[image:set-up-whatsapp2.png|set-up-whatsapp2.png/|set-up-whatsapp2.png/]] 

Click ''Set Up'' to connect to a shared service operated by Innovaphone. This will open a new tab in your browser which will connect to <code>https://whatsapp.innovaphone.com/whatsappsharedservice</code>. To add only a new phone number, select ''Register new phone number'' instead of completing the full onboarding. To add a phone id, your WhatsApp Business Display name as to be included in the Profile Name.

[[image:set-up-whatsapp3.png|set-up-whatsapp3.png/|set-up-whatsapp3.png/]] 

Click ''Onboard'' to start an authenticated session with Meta (www.facebook.com/platform) and log in using your Facebook account. If you do not have one, you must create one. 

[[image:set-up-whatsapp4.png|set-up-whatsapp4.png/|set-up-whatsapp4.png/]] 

If you already have a WhatsApp Business Account or a Business Portfolio, you can select it here. If not, one will be created for you. Click ''Next''. 

[[image:set-up-whatsapp5.png|set-up-whatsapp5.png/|set-up-whatsapp5.png/]] 

Add the details for your Business account, such as name, email address, and country, then click ''Next''. 

[[image:set-up-whatsapp6.png|set-up-whatsapp6.png/|set-up-whatsapp6.png/]] 

Next, select Use a new or existing WhatsApp number and enter the number you want to link as your WhatsApp Business number. Important: This number must not already be linked to another WhatsApp account, either WhatsApp Business or a regular WhatsApp account. 

Select ''Text message'' to verify your number. You’ll receive a verification PIN via SMS. Enter it to complete the process. 
If you use a MSN that is not capable of receiving a text message, choose ''Phone call'' instead. An automated system will call you and provide the verification code. 

[[image:set-up-whatsapp7.png|set-up-whatsapp7.png/|set-up-whatsapp7.png/]] 

Once completed, a success message will be displayed. 

[[image:set-up-whatsapp8.png|set-up-whatsapp8.png/|set-up-whatsapp8.png/]]

During the onboarding process, a user token and a phone ID are created for each MSN number and stored in the Connector for WhatsApp app service. They are automatically added to the Configuration section of the plugin. In order to transmit the data, Meta must be able to connect to the Connector for WhatsApp on your Application Platform (webhook address). '''The reverse proxy must therefore allow connections to <dns-name of AP>/<domain-name>/whatsapp.'''

=== Configuration ===
After completing the onboarding process, the user token and phone ID from Meta are displayed in the Configuration menu.

Now you have to assign a Connect instance and zone to each phone ID ('''MANDATORY'''). Hashtags are optional. Messages received via a specific mobile number ID will be posted and tagged based on this configuration.
A custom message can be defined that will be sent once the 24-hour timeframe has elapsed.

Enable the license option for each phone ID that needs to be licensed.

To delete Phone numbers for a WhatsApp Business account, or the WhatsApp Business account itself, go to the Meta Business Suite:
[https://www.facebook.com/business/help/1592865014304024/] Note: Numbers are not removed from the Connector for WhatsApp settings when you delete the number in the Whatsapp Business account.
To remove the numbers open the Configuration section of the plugin and remove the affected number using the delete icon.

== WhatsApp Account Information ==
After the Onboarding Process the plugin will show you the following Parameter:
*WhatsApp Business Account ID
*Webhook-address (This address has to be reachable from the Internet, so make sure your reverse proxy forwards the traffic to the AP)
*Phone IDs associated with Whatsapp Business (max 20 MSN numbers)
*License count

== Troubleshooting ==

If problems occur, please send us a log of the app service. Before reproducing the issue, delete the current contents of the log. The following trace flags should be enabled:

<ul><li>HTTP client
</li><li>App Websocket
</li><li>Webserver traffic
</li><li>Webserver
</li><li>Websocket client
</li></ul>

== Known issues ==
=== Whatsapp zone not visible in Connect===
The user must have access to the ''Connector for WhatsApp'' app (Users → Apps tab). Config Templates can be used to distribute the app to users.

=== Phone Calls ===
You cannot make phone calls between WhatsApp and Connect users.

=== Sticker ===
Stickers are currently not supported. These messages will not be transmitted.

== Related Articles ==

Reference14r2:Concept App Service Queues

2026-09-09T10:27:52Z

Kpe: /* Known issues */

Reference15r1:Concept App Service Queues

2026-09-09T10:27:16Z

Kpe: /* Known issues */

[[Category:Concept|Apps]]
The Queues App Service can be installed on an innovaphone App Platform and will provide services for several Apps that can be used to manage calls and waiting queues with myApps. For example the Switchboard App.

== Applies To ==

* innovaphone PBX from version 15r1final

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V15r1xx
* UsersAdminApp
* (Soft)PhoneApp
* ProfileApp
* CalllistApp
* Calllist-API
* RCC-API
* configured Waiting Queues in the PBX
* configured group(s) in the PBX assigned as "Static" and "Active" to the Waiting Queue
* License “App(innovaphone-switchboard)13” (order no. 02-00050-007) per application-user
* A dedicated group(queues) in the PBX assigned as "Static" to all Waiting Queues used by the Switchboard App and assigned as "Static and Active" to all Switchboard Users

==V15 Improvements==
'''Show call diversions for BLF entries.''' 
This feature shows, with a colored label in the BLF entry, the configured call forwarding from the respective User. The color of the label depends on the type of configured forwarding, CFNR (orange/yellow), CFB (red) or CFU (purple). A click on the label, shows the configured forwarding destination.

'''Break-through of call diversions from BLF and Search details.''' 
With a new icon (handset with arrow) it is possible to call to the User with a Call forward and breakthrough this call forward. This applies for CFB and CFU. In case of a CFNR the CFx-breakthrough does not apply because the call rings first at the user and after the configured timer the CFNR will be executed.

'''Fix for handling connections from multiple PBXs.''' 
An overall improvement of the handling when multiple calls are ringing.

'''Hotkeys for accepting and releasing calls.''' 
The myApps provide hotkeys functionality to start an App from anywhere within windows with this hotkey.
The Switchboard App now supports this hotkey functionality.

'''Focus call panel when starting switchboard''' 
When starting the Switchboard App, the focus will be in the call section, so that an incoming call can be answered immediately by pressing the enter-key.

'''Transfer button on the second call for intuitive transfer handling.''' 
When having an incoming call, a click on the Transfer button, did already show multiple transfer icons on the BLF entries. When having also an outgoing call, this icons now also appears on the outgoing call for a more user-friendly and intuitive transfer of the call. By clicking this icon on the outgoing call, the incoming call will be transferred to the outgoing call.

'''Pickup in BLF Favorites.''' 
The Phone and Softphone favorites are shown in the BLF field from the Switchboard App. New in this version, when a call is ringing at one of the favorites, a pickup symbol will be shown. By clicking on the pickup symbol, the call will start ringing on your phone and can be answered by the Switchboard App User.

== Apps ==
=== Switchboard App (innovaphone-switchboard) ===
[[Image: Switchboard-App.png|50px|switchboard-app.png/|switchboard-app.png/]]

The Switchboard App is an attendant workstation integrated into the myApps user interface. At a switchboard workstation, an employee of a company or a telephone network operator can process incoming calls and connection requests from external or internal callers. An employee can accept connections, request information, put calls on hold, transfer them to the desired destination, or reject the connection. The calls displayed are the ones from the monitorized phone device and they are managed using the RCC-API. The Switchboard App needs a license per Switchboard user, called the Switchboard App.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard</pre>
;Websocket
;TableUsers: to be able to replicate the users for the BLF
;Admin: to be able to edit the User object to monitor or un-monitor a waiting queue
;PbxApi: to edit the presence information
;RCC: to use the RCC API to manage the calls
;Impersonation: to get the Phone App favorites

=== Switchboard Admin App (innovaphone-switchboard-admin) ===
[[Image: Innovaphone-switchboard-admin.png|50px|innovaphone-switchboard-admin.png/|innovaphone-switchboard-admin.png/]]

With the Switchboard Admin App an administrator can manage the user(s) rights, can assign waiting queues to users and can pre-configure the Busy Lamp Field BLF.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard-admin</pre>
;Websocket
;TableUsers: to be able to replicate the users from the PBX
;Admin: to be able to assign the waiting queue groups to the user

== PBX Manager Plugins ==

=== Queues ===

With the Queues plugin the Switchboard App and Switchboard Admin App Objects can be created, edited and deleted on the PBX.

==Configuration==
# Install the Queues App
#* Option 1: Settings Apps/App Installer plugin - Search and Install the Queues App or
#* Option 2: AP Manager/App Store:
#** Search and Install the Queues App
#** Create an Instance of the Queues App
#** Start the created instance
# Settings App/Queues Plugin - Create the necessary App Objects:
#* Switchboard App: e.g. 'Switchboard'/'switchboard'
#* Switchboard Admin App: e.g. 'Switchboard Admin'/'switchboard-admin'
# Assign the Switchboard App and License to the correct users (can be done User- or Config Template-based)
# Assign the Switchboard Admin App to the correct Admin-users (can be done User- or Config Template-based)
# Configure Master PBX via the Switchboard Admin App Settings (optional with a single PBX):
#* PBX Name: PBX Name (PBX/Config/General/PBX Name) of the Master PBX
#* DNS (optional): DNS Name (PBX/Config/General/PBX Name) of the Master PBX Restart the Queues Instance after changing (so the App Objects can re-connect).
# Configure Waiting Queues via the Settings App/Waiting Queues Plugin or check existing Waiting Queues:
#* Waiting Queues monitored by the Switchboard App must have a '''Primary Group''' (used by the Switchboard Admin App to assign groups to Users)
#* Waiting Queues monitored by the Switchboard App must '''not''' have the ''''Operator connect for SOAP''''-checkbox ticked (needed to release calls correctly when taken/accepted by another Switchboard User)
# Create a Monitoring Group '''queues''' for the Switchboard (Admin) App. This can be done easily via the Queues Plugin of the Settings App (Groups configuration) or via the Advanced UI of the PBX:
#* '''Waiting Queues''' to be seen by the Switchboard App must have this group assigned '''Static only'''
#* '''Switchboard Users''' must have this group assigned '''Static and Active'''
# Configure the Switchboard Users via Switchboard Admin App:
#* Assign the correct rights / Waiting Queues to be monitored
#* (Optional) Create or Assign an already created Busy Lamp Field
# Adjust the Switchboard User Object and Phone Config (can also be done via a Config Template (desk phones only)):
#* Object: '''Untick 'Twin Phones'''' => Picking alerting calls (BLF or Waiting Queue-section) is possible
#* (Soft)Phone: '''Enable 'Call Waiting'''' => handling of multiple calls is possible (e.g. pickup call while there is an already alerting call)
# (Optional) Adjust the PBX/Phone/myApps/UsersAdmin App Config for better usage:
#* PBX: Configure the Recall Timeout of the PBX (PBX/Config/General/Recall Timeout) => Blind Transferred calls can be taken back
#* Phone: Configure a Park-key on the phone(s) of the Switchboard User(s) => visual/audio reminder of Parked Calls after X seconds
#* myApps: Deselect the default (Soft)Phone App + Untick the "Bring AppSharing/Video always to front" in your (Soft)Phone App => prevention of the (Soft)Phone App to popup.
#* UsersAdmin App: Tick the 'Privacy/Display e-mail address' in the Settings of the Users Admin, so that a callback-button is shown for User-search results.
# Open the Switchboard App and Select a (Soft)Phone to be controlled in the Settings/Hamburger Menu

'''Note''': Make sure to close the Switchboard App of the user when adjusting the config this user via the Switchboard Admin App. This ensure that changes are not overwritten again with the old values.

==Switchboard Admin App - User interface==
When opening the Switchboard Admin App the Switchboard Admin App shows only a search field at start (since release V14r1).
It will not list all users anymore, which speeds up the start of the App in big environments with many users.
At this point, closing the Switchboard Admin App, doesn't make any changes to the Switchboard App database.

Before doing any changes for any switchboard user, make sure that this user has closed the Switchboard App. Perform the changes, and afterward the Switchboard App user can reopen the Switchboard App and the changes will be applied.

===Search field===
Search for the user of your choice by typing its name.
The users details include their configured CFx since V15r1 and up.
When multiple user are shown, select the correct user.
The more detailed information (Rights / Busy lamp field) shown is retrieved from the Switchboard App database, while the existing user's group membership of the configured waiting queues, is retrieved from the PBX.

===Rights===
Here, you can define the rights of the Switchboard App user:
* Edit waiting queues: the user is allowed to add or delete waiting queues in the Switchboard App, to receive calls from.
* Edit presence: the user is allowed to change the presence state and presence note from other users in the system.
* Edit call diversions and mobility: the user is allowed to change other user's call forwards, mobility and its destinations.

===Waiting Queues===
This section shows the membership of primary group activity from the respective waiting queue.
This information is retrieved from the PBX. Changes will be saved into the PBX and the Switchboard App database.
Be aware that when making any changes to the selected user, it will be saved in the PBX and the Switchboard App database as well.
It might overwrite the latest group membership change done by the Switchboard App user itself. 
To make sure that your Administrative group membership settings will apply, make sure that the user's Switchboard App is closed before doing any changes. 
You might want to verify the user's preferred settings before, to apply them respectively with your changes.

The, in the PBX manager, pre-configured waiting queues will be shown to select the possible group membership. The possible choices are:
* Off: this waiting queue will not be shown in the user's Switchboard App for login.
* Dynamic-In: this waiting queue will be shown in the user's Switchboard App and the user is automatically logged-in the group with the start of the App (the user logs off from the group when closing the Switchboard App).
* Dynamic-Out: this waiting queue will be shown in the user's Switchboard App and the user is logged-off at start of the App (the user logs off from the group when closing the Switchboard App).
* Static: this waiting queue will be shown in the user's Switchboard App and the user is static in the group without the option to log-off (the user stays active in the group after closing the Switchboard App).

===Busy Lamp Field===

The Busy Lamp Field (BLF) section in the Switchboard Admin App, allows you, as admin, to pre-define the BLF groups and the PBX Users in the groups.
There is also the option to copy an already configured BLF from another user and edit it to your preferences.

==Switchboard App - User interface==
[[File:Switchboard app user interface.png|thumb|switchboard_app_user_interface.png/|switchboard_app_user_interface.png/]]
The user interface is divided in 3 panels:
* Left panel : Busy Lamp Field and users search
* Central panel: Calls
* Right panel: Waiting queues and calls history

There is also a hamburger menu, where some configuration settings can be edited.

=== Left panel ===
==== Busy Lamp Field ====
[[File:Switchboard app BLF contact.png|thumb|switchboard_app_blf_contact.png/|switchboard_app_blf_contact.png/]]
The '''BLF''' is displayed on the left panel. There all the users replicated from the PBX are displayed and it can be undocked and displayed on another window.
Information displayed by user:
* Profile picture
* Presence
* Common name
* Phone number
* CFx label if a CFx is configured (destination of the CFx is visible with a click on the label)

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a call by using the phone button
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display users detailed contact information
* Create BLF groups
* Re-arrange BLF groups by moving one entry '''on top of''' another entry in order to place it '''before it'''.
* Add a user to a BLF group
* Delete a user from a BLF group by long press left mouse
* Call Breaktrough on configured CFB or CFU

The BLF contacts is limited to PBX users and Contacts from the Contacts App with the proper detailed information. A Name, sip-name and number must be available as minimum information

==== Users search ====
[[File:Switchboard app contact information search result.png|thumb|switchboard_app_contact_information_search_result.png/|switchboard_app_contact_information_search_result.png/]]
The '''users search''' (Search-API) can be done with the input field. This input field can also be used to directly dial using the phone button.
Information displayed by user:
* Profile picture
* Presence
* Common name
* CFx if configured

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a chat
* Start a call
* Start a Breakthrough call on CFB or CFU
* Send an email
[[File:Switchboard app BLF contact information detailed.png|thumb|switchboard_app_blf_contact_information_detailed.png/|switchboard_app_blf_contact_information_detailed.png/]]
The user '''details''' can also be expanded by clicking on the arrow icon.
Data displayed (read only) for the user:
* Profile picture
* Common name
* SIP
* Phone number
* Email
* PBX
* Node

Data displayed that can also be edited for the user (if the user has the appropriate rights):
* Presence note
* Presence
* Call diversions
* Mobility

Actions allowed:
* Start a chat
* Start a call (by SIP and phone number)
* Send an email
* Send a "Call me back" notification by email
* Add the user to a BLF group

=== Center panel ===
On the center panel the calls are displayed.

==== Calls ====
The calls are divided in 5 sections: in the waiting queue, incoming, outgoing, parked and transferred.

Depending on the call state, different '''actions''' are allowed to manage the calls:
* Connect/Disconnect a call
* Mute/Unmute a call
* Hold/Release a call
* Park/Unpark a call
* Transfer a call to a user or connect 2 calls
* Pick up a transferred call or a call from the waiting queue

=== Right panel ===
On the right panel the waiting queues and the calls history are displayed.

==== Waiting Queues ====
On the right panel the '''waiting queues''' are displayed. They can be added by clicking on "Add waiting queue" (only displayed if the user has the appropriate right), which will automatically add the user to the given group. The calls will be displayed on the calls section and from there they can be picked up or transferred to an user.

==== Calls history ====
On this panel also the '''calls history''' is displayed, which is received from the Call List-API.

Information displayed on entry:
* Call flow
* Call information (source/destination, date and duration)

Actions allowed:
* Start a call
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display contact information
* Add the user to a BLF group

=== Hamburger menu ===
On the hamburger menu the '''shortcuts''' can be edited and the size of the users items from the BLF can be customized.
==== Edit shortcuts ====
To edit a shortcut, the shortcut must be selected and then the desired key pressed. Afterwards it has to be clicked again to finish the editing. To remove a shorcut, select the shortcut and press the "Del" key on your keyboard.

==== Size of the user items (BLF) ====
There are 2 different size:
* Icons only: only the profile picture, presence and common name will be displayed.
* Detailed large: the phone number and the call button are displayed too.

==== Limit displayed calls in waiting queues section ====
Different view of incoming calls in the waiting queues section
* If enabled: a short list of incoming calls will be shown and a scrollbar will appear in this section
* If disabled: a long list of incoming calls will be shown.
The amount of showed calls in both scenarios depends on the used display size and resolution configuration (adaptive design)

==== Select monitored device ====
If a device is selected, all the calls from/to that device will be monitored by the app.

==Additional information==
===Licensing===
* When using the OperatorV13 license in a pre V13r2 release, and you want to use the Switchboard App instead in a > V13r2, you need to download a new license file from my.innovaphone
* Upgrade from Operator, the Operator13 license will result in 3 times App(innovaphone-switchboard)13 in addition.

===Reverse Lookup from Contacts===
For Reverse Lookup to work both for Queue-calls as Operator-calls, the Directory must have the correct Access Rules:
* if the directory has no ACL-rules => will work for Queue- and Operator Calls
* if the directory has ACL-rules => a rule for each object (WQ and Operator) must apply:
** the name of the WQ/Operator-object
** an active group of the WQ/Operator

===Info field for BLF contact details, Operator Note===
The Switchboard Operator can use the Contacts App to add or edit the contact details with the Info field, to show additional information like an "Operator Note".

The information added to the Info field, will be shown in the detailed view of a BLF Contact or in the detailed view of a searched contact at the bottom as additional information aka "Operator Note"

==Known issues==
* The switchboard App does not (fully) support the touchscreens functionality. We do not recommend to use a touchscreen!
* When closing the Switchboard App, the user will be logout of all the waiting queues groups. When opening the app again, the user will be automatically logged-in on this groups again. (This is by design)
* Shortcuts may not be triggered on the Switchboard App if the app is not on focus. For this just click on the UI of the app.
* If a softphone is being monitored, the Softphone App must be opened on background. Otherwise the RCC-API will not sent calls information to the Switchboard App. Since >= V13r3 this will be done automatically.
* If no (soft)phone device has been selected on the hamburger menu of the Switboard App, the calls may be displayed duplicated because that means that the app is monitoring all the devices. To avoid this please select your default (Soft)Phone App on the phone devices section.
* When using the Softphone App with the same name and hardware-id on multiple devices (PC and Smartphone) an incoming call will be shown more than once, depending on the amount of used devices. You can add a Softphone with different naming and hardware-ID for the Switchboard User to use with the Switchboard App only.
* As Switchboard App "Operator" you will work mainly with the Switchboard App. To have video from internal callers, you need to have a (Soft)Phone App open in the background. Deselect your Default Phone device in the myApps otherwise this App will get focus during the incoming call and on connect after answering a call. Best Practice to undock the Video from your (Soft)Phone App in the background and deselect the option "Bring AppSharing/Video always to front" as this would bring your (Soft)Phone App to the front as well.
* When using Softphone App on X multiple devices, incoming calls will be displayed X multiple times. In scenarios where the Switchboard App user has multiple devices with myApps(Smartphone, tabblet, PC) it might make sense to create a Softphone with different name for each device or at least for the device where you want to use the Switchboard App with the Softphone App. Using different names for the Softphones, creates respectively different hardware-ID's. This assures that only the selected specific Softphone App and device will be monitored by the Switchboard App based on this specific name and HW-ID.
* If LDAP contacts are not displayed on the search results, please check if the rights for the LDAP object have been given to the Switchboard App.
* It is possible that the app instance needs to be restarted if the PBX name has changed on the hamburger menu of the Switchboard Admin App.
* Use unique group name per waiting queue. The Group and group name, assigned to your waiting queue, should not be (re)used for other Waiting Queues or other groups.

==Trouble shooting==
* If any issue can be reproduced, open the console output of your browser or right-click and inspect in the native client version of the Switchboard App. Clear the console output and reproduce the issue and copy past the output as a textfile and send this attached in your support ticket.

==Related Articles==
* SDK Integration (if the content is available)

Reference16r1:Concept App Service Queues

2026-09-09T10:26:41Z

Kpe: /* Known issues */

[[Category:Concept|Apps]]
The Queues App Service can be installed on an innovaphone App Platform and will provide services for several Apps that can be used to manage calls and waiting queues with myApps. For example the Switchboard App.

== Applies To ==

* innovaphone PBX from version 16r1final

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V16r1xx
* UsersAdminApp
* (Soft)PhoneApp
* ProfileApp
* CalllistApp
* Calllist-API
* RCC-API
* configured Waiting Queues in the PBX
* configured group(s) in the PBX assigned as "Static" and "Active" to the Waiting Queue
* License “App(innovaphone-switchboard)13” (order no. 02-00050-007) per application-user
* A dedicated group(queues) in the PBX assigned as "Static" to all Waiting Queues used by the Switchboard App and assigned as "Static and Active" to all Switchboard Users

==V16 Improvements==
'''Show call diversions for the favorites section in the BLF.''' 
This feature shows, with a colored label in the BLF entry, the configured call forwarding from the respective User. The color of the label depends on the type of configured forwarding, CFNR (orange/yellow), CFB (red) or CFU (purple). A click on the label, shows the configured forwarding destination.

'''Breakthrough of call diversions from BLF in favorites section.''' 
With a new icon (handset with arrow) it is possible to call to the User with a Call forward and breakthrough this call forward. This applies for CFB and CFU. In case of a CFNR the CFx-breakthrough does not apply because the call rings first at the user and after the configured timer the CFNR will be executed.

'''Edit mobility destination for users.''' 
An improvement for changing the mobility destination of the users.

'''Enable numeric + key as shortcut for transfer option.''' 
The Switchboard App now supports the shortkey + as shortkey for the transfer functionality.

'''Focus on second call for easier transfer ''' 
When starting a second call in the Switchboard App, the focus will be in the call section on this second call, so that a transfer can be initiated immediately by pressing the configured short-cut, for example the numeric + key. In case the focus is in the search field, press the TAB key first.

'''Call state in outgoing call section.''' 
When having an outgoing call, the status of this call (ringing or connected) will be shown in this outgoing call for a more user-friendly and intuitive feedback.

'''Notes for in- and outgoing calls in connect.''' 
When having an in- or outgoing call, you can add a note for this call in the Connect App. When a new call arrives, the Note can be consulted as additional information about this caller or called number.

'''Callback request email during a call.''' 
When having a call, a callback request per email can be generated. The email will have available callinformation already preloaded, like name, number and email-address of the caller if available.

'''Show Notes button in the Call History.''' 
Action key in the call history items to jump to the corresponding Notes in the Connect App.

'''Show fold/ unfold view for adjusting WQ height in Config''' 
changed design for configuring the showed Waiting Queue call section height.

'''Show Blf slider in Icons only view''' 
when selected the Icons only view of the BLF a slider will be shown.

'''Improved search funcionality.''' 
The improved search functionality is in line with the (Soft)Phone App search showing the source of the search result.

'''Improved search details.''' 
Improved the shown details from a search result and showing more info in the BLF entry details.

'''Create a popup box for already existing shortcuts.''' 
In case you enter a short cut that already excist, it will give you a warning that this shortcut is already created.

'''Fixed breakthrough option/button was not updated.''' 
Fixed breakthrough option/button was not updated (added/removed) when eg a CFu is set/removed.

'''Fix: Issue added users not visible immediately in BLF.''' 
Show users immediately in the BLF after adding them to a group.

'''Fix: Issue missing call-leg2 Info.''' 
Missing Call-leg2 Info now showed after connecting a Call.

'''Fix: Issue to many calls when starting call forward breakthrough.''' 
Fixed call forward breakthrough that leaded to many calls.

'''Fix: Issue to less space between buttons in BLF Details.''' 
Fixed the space between buttons in BLF user details.

'''Fix: Issue with Queues-plugin Group Configuration.''' 
The Display Name was wrongly used as User Identifier/Common Name to assign the 'queue'-group.

'''Fix: Issue Display of mismatched number with name in outgoing calls.''' 
Fixed the display of mismatched number with name in outgoing calls section on pickup.

'''Fix: Issue with missing CFx on a user after a change by the Switchboard App.''' 
Fixed the forwardings stored in PBX after a change by the Switchboard App.

'''Fix: Issue Users displayed multiple times when we click on BLF duplication button.''' 
Fixed the behavior when we click on BLF duplication button.

'''Fix: Issue when Transfer-button clicked twice.''' 
Fixed when transfer-button clicked twice, the transfer button was not removed on second call.

'''Fix: Issue Missing call after selecting IVR option.''' 
Fixed when selecting IVR option, show the waiting Queue again in the call panel section.

'''Fix: Issue transfer button shown on active calls.''' 
Fixed don't show the transfer button on active calls.

'''Fix: Show CFx Icon on toggling from large to small Icon view''' 
Fixed to show the Call Forward Icon in the small view of the Busy Lamp Field.

'''Fix: Favorites did have less actions than other contacts in the BLF''' 
Fixed to show all possibile actions on the BLF entries in the favorites section

'''Fix Add option to fix WQ height in config''' 
Fixed added option to waiting queues height configuration

'''For further fixes to come with future service releases, please consult our release notes accordingly.''' 

== Apps ==
=== Switchboard App (innovaphone-switchboard) ===
[[Image: Switchboard-App.png|50px|switchboard-app.png/|switchboard-app.png/]]

The Switchboard App is an attendant workstation integrated into the myApps user interface. At a switchboard workstation, an employee of a company or a telephone network operator can process incoming calls and connection requests from external or internal callers. An employee can accept connections, request information, put calls on hold, transfer them to the desired destination, or reject the connection. The calls displayed are the ones from the monitorized phone device and they are managed using the RCC-API. The Switchboard App needs a license per Switchboard user, called the Switchboard App.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard</pre>
;Websocket
;TableUsers: to be able to replicate the users for the BLF
;Admin: to be able to edit the User object to monitor or un-monitor a waiting queue
;PbxApi: to edit the presence information
;Services: to be able to connect to extra apis (eg messages or connect (*))
;RCC: to use the RCC API to manage the calls
;Impersonation: to get the Phone App favorites

;Apps->connect (or Apps->messages): to be able to see/post call notes (*)

=== Switchboard Admin App (innovaphone-switchboard-admin) ===
[[Image: Innovaphone-switchboard-admin.png|50px|innovaphone-switchboard-admin.png/|innovaphone-switchboard-admin.png/]]

With the Switchboard Admin App an administrator can manage the user(s) rights, can assign waiting queues to users and can pre-configure the Busy Lamp Field BLF.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard-admin</pre>
;Websocket
;TableUsers: to be able to replicate the users from the PBX
;Admin: to be able to assign the waiting queue groups to the user

== PBX Manager Plugins ==

=== Queues ===

With the Queues plugin the Switchboard App and Switchboard Admin App Objects can be created, edited and deleted on the PBX.

==Configuration==
# Install the Queues App
#* Option 1: Settings Apps/App Installer plugin - Search and Install the Queues App or
#* Option 2: AP Manager/App Store:
#** Search and Install the Queues App
#** Create an Instance of the Queues App
#** Start the created instance
# Settings App/Queues Plugin - Create the necessary App Objects:
#* Switchboard App: e.g. 'Switchboard'/'switchboard'
#* Switchboard Admin App: e.g. 'Switchboard Admin'/'switchboard-admin'
# Assign the Switchboard App and License to the correct users (can be done User- or Config Template-based)
# Assign the Switchboard Admin App to the correct Admin-users (can be done User- or Config Template-based)
# Configure Master PBX via the Switchboard Admin App Settings (optional with a single PBX):
#* PBX Name: PBX Name (PBX/Config/General/PBX Name) of the Master PBX
#* DNS (optional): DNS Name (PBX/Config/General/PBX Name) of the Master PBX Restart the Queues Instance after changing (so the App Objects can re-connect).
# Configure Waiting Queues via the Settings App/Waiting Queues Plugin or check existing Waiting Queues:
#* Waiting Queues monitored by the Switchboard App must have a '''Primary Group''' (used by the Switchboard Admin App to assign groups to Users)
#* Waiting Queues monitored by the Switchboard App must '''not''' have the ''''Operator connect for SOAP''''-checkbox ticked (needed to release calls correctly when taken/accepted by another Switchboard User)
# Create a Monitoring Group '''queues''' for the Switchboard (Admin) App. This can be done easily via the Queues Plugin of the Settings App (Groups configuration) or via the Advanced UI of the PBX:
#* '''Waiting Queues''' to be seen by the Switchboard App must have this group assigned '''Static only'''
#* '''Switchboard Users''' must have this group assigned '''Static and Active'''
# Configure the Switchboard Users via Switchboard Admin App:
#* Assign the correct rights / Waiting Queues to be monitored
#* (Optional) Create or Assign an already created Busy Lamp Field
# Adjust the Switchboard User Object and Phone Config (can also be done via a Config Template (desk phones only)):
#* Object: '''Untick 'Twin Phones'''' => Picking alerting calls (BLF or Waiting Queue-section) is possible
#* (Soft)Phone: '''Enable 'Call Waiting'''' => handling of multiple calls is possible (e.g. pickup call while there is an already alerting call)
# (Optional) Adjust the PBX/Phone/myApps/UsersAdmin App Config for better usage:
#* PBX: Configure the Recall Timeout of the PBX (PBX/Config/General/Recall Timeout) => Blind Transferred calls can be taken back
#* Phone: Configure a Park-key on the phone(s) of the Switchboard User(s) => visual/audio reminder of Parked Calls after X seconds
#* myApps: Deselect the default (Soft)Phone App + Untick the "Bring AppSharing/Video always to front" in your (Soft)Phone App => prevention of the (Soft)Phone App to popup.
#* UsersAdmin App: Tick the 'Privacy/Display e-mail address' in the Settings of the Users Admin, so that a callback-button is shown for User-search results.
# Open the Switchboard App and Select a (Soft)Phone to be controlled in the Settings/Hamburger Menu

'''Note''': Make sure to close the Switchboard App of the user when adjusting the config this user via the Switchboard Admin App. This ensure that changes are not overwritten again with the old values.

==Switchboard Admin App - User interface==
When opening the Switchboard Admin App the Switchboard Admin App shows only a search field at start (since release V14r1).
It will not list all users anymore, which speeds up the start of the App in big environments with many users.
At this point, closing the Switchboard Admin App, doesn't make any changes to the Switchboard App database.

Before doing any changes for any switchboard user, make sure that this user has closed the Switchboard App. Perform the changes, and afterward the Switchboard App user can reopen the Switchboard App and the changes will be applied.

===Search field===
Search for the user of your choice by typing its name.
The users details include their configured CFx since V15r1 and up.
When multiple user are shown, select the correct user.
The more detailed information (Rights / Busy lamp field) shown is retrieved from the Switchboard App database, while the existing user's group membership of the configured waiting queues, is retrieved from the PBX.

===Rights===
Here, you can define the rights of the Switchboard App user:
* Edit waiting queues: the user is allowed to add or delete waiting queues in the Switchboard App, to receive calls from.
* Edit presence: the user is allowed to change the presence state and presence note from other users in the system.
* Edit call diversions and mobility: the user is allowed to change other user's call forwards, mobility and its destinations.

===Waiting Queues===
This section shows the membership of primary group activity from the respective waiting queue.
This information is retrieved from the PBX. Changes will be saved into the PBX and the Switchboard App database.
Be aware that when making any changes to the selected user, it will be saved in the PBX and the Switchboard App database as well.
It might overwrite the latest group membership change done by the Switchboard App user itself. 
To make sure that your Administrative group membership settings will apply, make sure that the user's Switchboard App is closed before doing any changes. 
You might want to verify the user's preferred settings before, to apply them respectively with your changes.

The, in the PBX manager, pre-configured waiting queues will be shown to select the possible group membership. The possible choices are:
* Off: this waiting queue will not be shown in the user's Switchboard App for login.
* Dynamic-In: this waiting queue will be shown in the user's Switchboard App and the user is automatically logged-in the group with the start of the App (the user logs off from the group when closing the Switchboard App).
* Dynamic-Out: this waiting queue will be shown in the user's Switchboard App and the user is logged-off at start of the App (the user logs off from the group when closing the Switchboard App).
* Static: this waiting queue will be shown in the user's Switchboard App and the user is static in the group without the option to log-off (the user stays active in the group after closing the Switchboard App).

===Busy Lamp Field===

The Busy Lamp Field (BLF) section in the Switchboard Admin App, allows you, as admin, to pre-define the BLF groups and the PBX Users in the groups.
There is also the option to copy an already configured BLF from another user and edit it to your preferences.

==Switchboard App - User interface==
[[File:Switchboard app user interface.png|thumb|switchboard_app_user_interface.png/|switchboard_app_user_interface.png/]]
The user interface is divided in 3 panels:
* Left panel : Busy Lamp Field and users search
* Central panel: Calls
* Right panel: Waiting queues and calls history

There is also a hamburger menu, where some configuration settings can be edited.

=== Left panel ===
==== Busy Lamp Field ====
[[File:Switchboard app BLF contact.png|thumb|switchboard_app_blf_contact.png/|switchboard_app_blf_contact.png/]]
The '''BLF''' is displayed on the left panel. There all the users replicated from the PBX are displayed and it can be undocked and displayed on another window.
Information displayed by user:
* Profile picture
* Presence
* Common name
* Phone number
* CFx label if a CFx is configured (destination of the CFx is visible with a click on the label)

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a call by using the phone button
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display users detailed contact information
* Create BLF groups
* Re-arrange BLF groups by moving one entry '''on top of''' another entry in order to place it '''before it'''.
* Add a user to a BLF group
* Delete a user from a BLF group by long press left mouse
* Call Breaktrough on configured CFB or CFU

The BLF contacts is limited to PBX users and Contacts from the Contacts App with the proper detailed information. A Name, sip-name and number must be available as minimum information

==== Users search ====
[[File:Switchboard app contact information search result.png|thumb|switchboard_app_contact_information_search_result.png/|switchboard_app_contact_information_search_result.png/]]
The '''users search''' (Search-API) can be done with the input field. This input field can also be used to directly dial using the phone button.
Information displayed by user:
* Profile picture
* Presence
* Common name
* CFx if configured

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a chat
* Start a call
* Start a Breakthrough call on CFB or CFU
* Send an email
[[File:Switchboard app BLF contact information detailed.png|thumb|switchboard_app_blf_contact_information_detailed.png/|switchboard_app_blf_contact_information_detailed.png/]]
The user '''details''' can also be expanded by clicking on the arrow icon.
Data displayed (read only) for the user:
* Profile picture
* Common name
* SIP
* Phone number
* Email
* PBX
* Node

Data displayed that can also be edited for the user (if the user has the appropriate rights):
* Presence note
* Presence
* Call diversions
* Mobility

Actions allowed:
* Start a chat
* Start a call (by SIP and phone number)
* Send an email
* Send a "Call me back" notification by email
* Add the user to a BLF group

=== Center panel ===
On the center panel the calls are displayed.

==== Calls ====
The calls are divided in 5 sections: in the waiting queue, incoming, outgoing, parked and transferred.

Depending on the call state, different '''actions''' are allowed to manage the calls:
* Connect/Disconnect a call
* Mute/Unmute a call
* Hold/Release a call
* Park/Unpark a call
* Transfer a call to a user or connect 2 calls
* Pick up a transferred call or a call from the waiting queue

=== Right panel ===
On the right panel the waiting queues and the calls history are displayed. The Notes Field when beeing used, will be on top off the Waiting Queues and Calls History section.

==== Waiting Queues ====
On the right panel the '''waiting queues''' are displayed. They can be added by clicking on "Add waiting queue" (only displayed if the user has the appropriate right), which will automatically add the user to the given group. The calls will be displayed on the calls section and from there they can be picked up or transferred to an user.

==== Calls history ====
On this panel also the '''calls history''' is displayed, which is received from the Call List-API.

Information displayed on entry:
* Call flow
* Call information (source/destination, date and duration)

Actions allowed:
* Start a call
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display contact information
* Add the user to a BLF group

==== Notes Field ====
During an active call you have the option to add a Note for this call and caller-id. The first notes information like name and/or number is added by the App service. You can add a personal note as additional information related to the call or caller-id.

The notes are stored in the Connect App in the zone Switchboard. To be able to see the Switchboard Notes from the service and other Switchboard operators, the Switchboard user should have read access to the zone Switchboard. To add personal notes to the discussion, the Switchboard User should also have the Connect App license (included in the UCC license)

In the call history you are also able to create, read and add notes.

With a new incoming call and there is already a note available for this caller-id, the note will be shown immediately in the right section of the screen.

=== Hamburger menu ===
On the hamburger menu the '''shortcuts''' can be edited and the size of the users items from the BLF can be customized.
==== Edit shortcuts ====
To edit a shortcut, the shortcut must be selected and then the desired key pressed. Afterwards it has to be clicked again to finish the editing. To remove a shorcut, select the shortcut and press the "Del" key on your keyboard.

==== Size of the user items (BLF) ====
There are 2 different size:
* Icons only: only the profile picture, presence and common name will be displayed.
* Detailed large: the phone number and the call button are displayed too.

==== Limit displayed calls in waiting queues section ====
Different view of incoming calls in the waiting queues section
* If disabled: a long list of incoming calls will be shown.
* If enabled: a short list of incoming calls will be shown and a scrollbar will appear in this section
** Fix WQ height optional with height setting between 0 and 50
The amount of showed calls in both scenarios depends on the used display size and resolution configuration (adaptive design)

==== Select monitored device ====
If a device is selected, all the calls from/to that device will be monitored by the app.

==Additional information==
===Licensing===
* When using the OperatorV13 license in a pre V13r2 release, and you want to use the Switchboard App instead in a > V13r2, you need to download a new license file from my.innovaphone
* Upgrade from Operator, the Operator13 license will result in 3 times App(innovaphone-switchboard)13 in addition.

===Reverse Lookup from Contacts===
For Reverse Lookup to work both for Queue-calls as Operator-calls, the Directory must have the correct Access Rules:
* if the directory has no ACL-rules => will work for Queue- and Operator Calls
* if the directory has ACL-rules => a rule for each object (WQ and Operator) must apply:
** the name of the WQ/Operator-object
** an active group of the WQ/Operator

===Info field for BLF contact details, Operator Note===
The Switchboard Operator can use the Contacts App to add or edit the contact details with the Info field, to show additional information like an "Operator Note".

The information added to the Info field, will be shown in the detailed view of a BLF Contact or in the detailed view of a searched contact at the bottom as additional information aka "Operator Note"

==Known issues==
* The switchboard App does not (fully) support the touchscreens functionality. We do not recommend to use a touchscreen!
* When closing the Switchboard App, the user will be logout of all the waiting queues groups. When opening the app again, the user will be automatically logged-in on this groups again. (This is by design)
* Shortcuts may not be triggered on the Switchboard App if the app is not on focus. For this just click on the UI of the app.
* If a softphone is being monitored, the Softphone App must be opened on background. Otherwise the RCC-API will not sent calls information to the Switchboard App. Since >= V13r3 this will be done automatically.
* If no (soft)phone device has been selected on the hamburger menu of the Switboard App, the calls may be displayed duplicated because that means that the app is monitoring all the devices. To avoid this please select your default (Soft)Phone App on the phone devices section.
* When using the Softphone App with the same name and hardware-id on multiple devices (PC and Smartphone) an incoming call will be shown more than once, depending on the amount of used devices. You can add a Softphone with different naming and hardware-ID for the Switchboard User to use with the Switchboard App only.
* As Switchboard App "Operator" you will work mainly with the Switchboard App. To have video from internal callers, you need to have a (Soft)Phone App open in the background. Deselect your Default Phone device in the myApps otherwise this App will get focus during the incoming call and on connect after answering a call. Best Practice to undock the Video from your (Soft)Phone App in the background and deselect the option "Bring AppSharing/Video always to front" as this would bring your (Soft)Phone App to the front as well.
* When using Softphone App on X multiple devices, incoming calls will be displayed X multiple times. In scenarios where the Switchboard App user has multiple devices with myApps(Smartphone, tabblet, PC) it might make sense to create a Softphone with different name for each device or at least for the device where you want to use the Switchboard App with the Softphone App. Using different names for the Softphones, creates respectively different hardware-ID's. This assures that only the selected specific Softphone App and device will be monitored by the Switchboard App based on this specific name and HW-ID.
* If LDAP contacts are not displayed on the search results, please check if the rights for the LDAP object have been given to the Switchboard App.
* It is possible that the app instance needs to be restarted if the PBX name has changed on the hamburger menu of the Switchboard Admin App.
* Use unique group name per waiting queue. The Group and group name, assigned to your waiting queue, should not be (re)used for other Waiting Queues or other groups.

==Trouble shooting==
* If any issue can be reproduced, open the console output of your browser or right-click and inspect in the native client version of the Switchboard App. Clear the console output and reproduce the issue and copy past the output as a textfile and send this attached in your support ticket.

==Related Articles==
* SDK Integration (if the content is available)

Reference16r1:Concept App Platform

2026-07-17T09:18:09Z

Kpe: /* Quotation marks */

= General =
* V16 uses [https://buildroot.org/ buildroot]
* this is an own (innovaphone) collection of packages
* For further information see: [https://buildroot.org/docs.html Buildroot Documentations]

== Requirements ==

* V13 or above
* Gateway (arm): IPx10 (with CF card) or IPx11 (with mSATA SSD)
* Gateway (arm64): IPx13 (with m2 SSD)
* Virtual (x86_64)
** HyperV with [https://docs.microsoft.com/de-de/windows-server/virtualization/hyper-v/deploy/upgrade-virtual-machine-version-in-hyper-v-on-windows-or-windows-server#supported-virtual-machine-configuration-versions VM-configuration Version] 6.2 (minimum: Windows 10 or Windows Server 2016)
** VMWare
** Proxmox/KVM/Qemu

== Default credentials ==

'''During INSTALL, the default passwords are replaced with the global Admin PW!'''
* SSH-Login with '''admin''' and '''ipapps'''
* root login with '''root''' and '''iplinux''' (the root login is not directly possible, you have to login as admin first and use the command ''su root'')
* manager App (web login) '''pwd'''

= App Platform - arm/arm64 (Gateway)=

* The installation image has a size of ~50MB. During installation, the following partitions are created<ref name="partition-size">Maximum partition sizes are given. The real sizes are returned by the linux 'df -h'-command. These real values will be lower, but can grow in the future with new releases.</ref>:
** /dev/sda1 fat32: 200MB (contains ramdisk, rootfs and kernel)
** /dev/sda2 ext4: depends on disk size (contains databases, log files and apps)
** /dev/sda3 ext4: 500MB (contains the rootfs)
** /dev/sda4 swap: 512MB

When comparing potential performance of the IPxx11 platform compared to the IPxx10 platform, there are some major differences:
* SSDs found in the xx11 are faster and more reliable than the CF found in the xx10
* the available RAM for the App Platform (as specified in column ''RAM for LAP (GB) out of RAM'' in chapter ''Technical data and recommended number of users supported'' of [[Howto:How to implement large PBXs#Technical data and recommended number of users supported|How to implement large PBXs]]) is factor 6 larger on the xx11 (1,536 GB) than on the xx10 (0,256 GB))
* the xx11 has gigabit Ethernet while the xx10 has 100Mbps Ethernet. The xx10 is therefore not well suited for Apps with larger network traffic, such as Recordings
* the CPU of the xx11 (although it runs on the same frequency) is roughly 20% faster than the xx10

While it is hard to predict the performance of the App Platform in a specific scenario, we see that in a real life environment an App Platform running on an xx11 platform can well support 150 users. The xx10 platform is estimated to support 120 users. Because CPU performance is the limiting factor, larger setups can be built based on the virtual machine platform (see [[#App services and multi-threading|App services and multi-threading]] below).

<references/>

= App Platform - x86-64 (Virtual Machine 64bit) =

* The default disk size is 16GB. It should be increased '''before''' the first start if needed!
* Multiple CPUs are supported, default is one CPU
* default RAM: 512MB
* static IP address, DNS, Gateway can be configured with the command '''setip''' on the console. Run '''setip --help''' to get a list of parameters. (Example: setip --addr=x.x.x.x --mask=x.x.x.x --gateway=x.x.x.x --dns1=x.x.x.x)
* If you have permission problems change to su user (Password is iplinux or your new admin password)
* To figure out your ip address you can use the command: ''ip address'' on the console.
* '''loadkeys de''' can be used to change to german keyboard layout (etc.)
* partitions<ref name="partition-size">Maximum partition sizes are given. The real sizes are returned by the linux 'df -h'-command. These real values will be lower, but can grow in the future with new releases.</ref>:
** /dev/sda1 ext2: 350MB (contains ramdisk, rootfs and kernel)
*** the real partition format size is smaller but there is no need to monitor sda1 as sda1 won't grow during usage of the App Platform
*** sda1 is completely exchanged during an image update and its size might have changed but will never exceed these 350MB
** /dev/sda2 ext4: depends on disk size (contains databases, log files and apps)
** /dev/sda3 ext4: 500MB (contains the rootfs)
** /dev/sda4 swap: 512MB
* VMWare Tools: Open VM Tools
* Qemu Guest Agent: installed since 110032
** The qemu guest agent can be configured in Proxmox with ''Virtio'' or ''ISA''. Before version 130012, you must use ISA, as Virtio was not supported with older versions.

<references/>

= Installation =
==ARM Gateway==

If you setup a Gateway with the install procedure, the App Platform is installed automatically (Https Download has to be allowed and shouldn't be blocked by any firewall.) 
You can also install it manually:
* Open App Platform -> General and '''Enable Linux Support'''. Restart the gateway.
* You need to enable Proxy-ARP on [[{{NAMESPACE}}:IP4/ETH/IP|ETH0]] or [[{{NAMESPACE}}:IP4/ETH/IP|ETH1]], so your Gateway and the Linux Appliance will share the same physical interface.
* Open App Platform -> IP and configure the IP settings of the App Platform. Restart the Gateway.
* Open App Platform -> Installation and select the given version or enter an own path to the ''app-platform-armel.img'' image file.
* The installation runs without any further required step.

==ARM64 Gateway==

If you setup a Gateway with the install procedure, the App Platform is installed automatically (Https Download has to be allowed and shouldn't be blocked by any firewall.) 
You can also install it manually:
* Open App Platform -> General and '''Enable Linux Support'''. Restart the gateway.
* You need to enable Proxy-ARP on [[{{NAMESPACE}}:IP4/ETH/IP|ETH0]] or [[{{NAMESPACE}}:IP4/ETH/IP|ETH1]], so your Gateway and the Linux Appliance will share the same physical interface.
* Open App Platform -> IP and configure the IP settings of the App Platform. Restart the Gateway.
* Open App Platform -> Installation and select the given version or enter an own path to the ''app-platform-arm64.img'' image file.
* The installation runs without any further required step.

==Virtual machine==

* Import the image into your server environment.
** Proxmox: follow this description here, just with the app-platform-ova.zip: https://wiki.innovaphone.com/index.php?title={{NAMESPACE}}:Concept_Innovaphone_Virtual_Appliance#Proxmox_VE
* Edit the disk size, if needed.
* Start the machine and wait until it reboots and starts again.
* Note: If you need to access an IP addresses available through a VPN connection from from inside the virtual machine, it could be that you need to set the network of your VM to NAT (and also add the URL for an IP to /etc/hosts)

[https://wiki.innovaphone.com/index.php?title={{NAMESPACE}}:Concept_Innovaphone_Virtual_Appliance#Configuration More Configuration Hints regarding VM Ware]

== Backup of the Apps ==

Each App Service can have multiple instances and each instance has its own database. The manager app itself also has its own database. 
There are no other files which need to be backuped. 
The standard way to backup the databases is through the Devices App [[{{NAMESPACE}}:Concept_App_Service_Devices#Backups]]. 
 
An alternate way is to use a command file which is similar to the command files from the firmware.

===Commands===
* '''times''' 0,12 # backup only at 0 or 12 o'clock
* '''backup-instances''' http://user:pw@ip/path/#I-#D.dump PUT
** PUT and POST are supported, all instances including the manager itself are saved
* '''backup-instance''' http://user:pw@ip/path/#I-#D.dump apidemo example.com PUT
** backup a single instance with instance name and instance domain
* '''backup-manager''' http://user:pw@ip/path/#I-#D.dump

===Hash parameters===
* #L App Platform label (neu), e.g. 10024
* #A App label (neu), e.g. 130004
* #I instance name (neu), e.g. reporting1
* #D instance domain (neu), e.g. innovaphone.com
* #m MAC address of the LAP, e.g. 00ab11eeff
* #d Current date and time (plain UTC without daylight saving and timezone adjustments) 20051010-170130
* #bn rolling backup index (n >=0 and <= 9, just one digit)
* ## escapes a hash mark

= App Platform Infrastructure and Concept =
== Webserver ==
The app platform includes a webserver that is highly optimized for handling many Websocket connections at a low memory footprint.
All apps use that webserver by registering for specific HTTP subpath. So they can all use the same HTTP/HTTPS ports - typically the standard ports.

=== Import Custom SSL Certificate ===
You have to upload a PEM Certificate with the following chain structure and without password encoding.

-----BEGIN CERTIFICATE-----
(certificate: eg. your_domain_name.crt)
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
(Intermediate certificate: eg. DigiCertCA.crt)
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
(Root certificate: eg. TrustedRoot.crt)
-----END CERTIFICATE-----
-----BEGIN RSA PRIVATE KEY-----
(certificate Key: eg. your_domain_name.key)
-----END RSA PRIVATE KEY-----

If you have problems generating the complete and correct certificate chain, you can use tools such as https://whatsmychaincert.com/ as an aid.
'''Please keep in mind that you never give away the private part of your key.'''

=== Known issues ===
*The app platform webserver can use only the default http/https ports 80/443.
*By design, there is no possibility to restore the default webserver certificate on the App Platform, if another certificate was once uploaded. 
**If nevertheless needed, you must login with Putty (see [[#How to retrieve files from the AP| Retrieve files]]) and execute these commands as root:
**''psql -d manager -c "DELETE FROM config WHERE name='webserverCertificate'"''
**''/etc/init.d/S92manager restart''
*The app platform webserver interprets URLs case-sensitive. In other words, <nowiki>http://<addr>/file.txt</nowiki> is not the same as <nowiki>http://<addr>/FILE.TXT</nowiki>

== Database ==
The app platform creates a database for each app instance with a given password. In the installer there will be used randomly generated passwords. You can set a new database password for every instance in the Application Platform.

The apps should store all data in that database. That makes sure that a consistent backup and restore of app instances can be done by the app platform manager.
In hosted scenarios, having separate databases for each instance also makes sure that the data of different customers are clearly separated and can easily be moved from one physical platform to another.

The default configuration decline database request from extern. If you need external access you can change the PGSQL configuration (as root) in the file ''/mnt/sda2/pgsql/pg_hba.conf''.
After editing pg_hba.conf, the database-service has to be restarted with the command <code>/etc/init.d/S50postgresql restart</code>
(Please think about it before you do it, because a better way is to create your own local app with local database access.)

You can find the official documentation for the pg_hba.conf here: https://www.postgresql.org/docs/14/auth-pg-hba-conf.html

Please note that you do this on your own responsibility, that it makes sense to create a backup of the original pg_hba.conf
and that you may break your database server if you do not know exactly what you do!

Sometimes the Apps are not proper working after this. You can wait a while until everything is working again or you go the hard way:
* stop the manager
** <code>/etc/init.d/S92manager stop</code>
* restart the database-service (maybe not really necessary, but makes a good feeling)
**<code>/etc/init.d/S50postgresql restart</code>
* start the manager
** <code>/etc/init.d/S92manager start</code>

=== Nightly database analyse ===

Every database is analysed at night to keep indexes in sync with the data. This triggers a ''vacuumdb -a -z'', which updates optimizer statistics, but does '''not''' shrink the physical size of the database. 
This must be done manually in the instance settings.

== App Platform Manager ==
The App Platform Manager is the central component of the App Platform. It does the following:
* Installing app services by downloading the binaries from an app store.
* Running and monitoring app services. If an app service crashes it is restarted, automatically.
* Management of app instances and providing them with the environment they need:
** A database
** A webserver path
** A password for authentication
* Backup and restore of app instances.
* Collecting debug information like tracing and crash dumps.
* System monitoring (CPU usage, memory usage, etc).

== App Services ==
App services are runned by the App Platform Manager. They implement an interface that is used by the manager to start, stop and configure app instances. Each service runs in a separate child process of the manager.

== App Instances ==
The actual functionality of an app service is provided by app instances. They run in the same process as the app service but have a distinct webserver path and their own database. There can be 0..n instances of an app service. Instances can optionally host (web) apps that can be opened in the myApps client.

Each instance of an App service has two passwords. The instance password itself and a database password. If you want to change it you must update the password on both sides. 
The instance password must match to the password in the corresponding PBX App objects, while one instance can have different App objects. 
The database password must be just known to the manager and not outside of the App Platform.

The ''Database name'' and ''Database user'' are both limited to a length of 63 characters. By default, the App Manager would create ''<domain>''_''<instance-name>'' as value for both. This is why it is recommended to use instance names so that length(name) + length(domain) is less than 63 characters. However, if this is not possible, you can manually shorten the suggested values (both must still be unique on your App Platform).

=== Cleanup database ===
You can cleanup the instance database inside the instance settings. This starts the vacuumdb process for the instance database which frees disk space of deleted rows.
Note that this process locks the database and that sufficient disk space is needed to complete it!

=== External database host ===
You can optionally configure an external database host, if the database shall be hosted on an external host. 
Note that the App Platform Manager still creates a local database, which is then not used as long as the external host is configured.

What are external databases useful for?:
* User data is too large (files are stored as BLOB in the database)
* Other (non-innovaphone) database servers are to be used due to other regulations
* There is already an external database cluster with its own backup/restore processes which should be used
* More performance is required (please note that a local UNIX socket provides much faster results than a remote database server). Depending on the app and the task of the app, it can still be useful to use a separate server if it is faster.

==== Supported database types ====
In principle, ''PostgreSQL'' and ''MySQL'' are supported. However, please note that the respective app must be designed for the target database server type. If an app has been developed for PostgreSQL, it cannot be operated on a MySQL server.

'''Please note:''' All innovaphone apps are developed exclusively as PostgreSQL apps.

MySQL therefore only makes sense if own apps are developed and MySQL or certain MySQL features are to be used. For such apps, it is very important to deactivate the automatic Application Platform APP-Backup.
The database backup process of the App Platform uses PostgreSQL backup commands, which is why the backup would fail, so the app must be excluded from the backup, and you must take care of the backup yourself.

==== Database creation ====
If you use an external database, you have to create the database itself.
The App Platform Manager itself creates a PostgreSQL database like this (you may respect this on your database host to be compatible with the database implementation inside the Apps):
* CREATE DATABASE "dbname" ENCODING 'UTF8';
* CREATE USER "dbuser";
* ALTER USER "dbuser" WITH PASSWORD 'dbpassword';
* GRANT ALL PRIVILEGES ON DATABASE "dbname" TO "dbuser";
* ALTER DATABASE "dbname" OWNER TO "dbuser";
* REVOKE CONNECT ON DATABASE "dbname" FROM public;

==== Database connection ====
There are different possibilities to specify the host. You can use a DNS-Name, IPv4 or IPv6. A port can be optionally added with a colon.

Our PostgreSQL implementation sets sslmode=prefer, so SSL is used by default if enabled on the server.

==== Backup/Restore ====
External databases are still backuped as normal, but you can't restore such a database with the App Platform Manager on the external host! You must restore such a dump manually on your database host.

==== Database redundancy ====
In principle, it is possible to create redundancies for failure scenarios through this function.

However, there are different scenarios that need to be evaluated on a case-by-case basis:

* One database, multiple App Platforms (primary online / secondary '''offline''') where multiple apps access the same database.
** This mode of operation is legal as long as you can really ensure that only one App Platform is active at a time.

* One database, multiple App Platforms (primary online / secondary '''online''') with multiple apps accessing the same database.
** This operating mode cannot be used for innovaphone apps, as the app itself would have to be developed for such a mode, which it is not.

However, we advise great caution here! The use of the same databases from different nodes may only be used if you can ensure that the databases or runtime environments of apps cannot get into a ''split-brain'' mode.

== Relationship between app instances and app objects in the PBX ==
Typically an app instance is connected to one or more app objects in a customer PBX. This is done by configuring the same parameters on both sides:
* URL
* Password
The password is used by the PBX for authenticating itself, users and services against the app instance.

Some apps need a websocket connection with the PBX. When "websocket" is activated at the app object, the PBX establishes a websocket connection to the app instance and provides the APIs that are configured at the app object.

=== Supported scenarios ===
It is important to understand that the concept does not do any assumptions on how PBXes and APs are correlated. So you can have
* One App Platform for one customer
* One App Platform for many customers
* Many App Platforms for one customer
* Many App Platforms for many customers

Attention: The V13 installer can only configure the scenario "''One App Platform for one customer''". If you want to have a different scenario, you have to configure it manually.

For hosting or cloud scenarios you need special scenarios. Please refer our [[Howto:V13 Hosting| V13 Hosting]] instructions.

=== Restrictions ===
Currently we don't have redundancy for app instances or App Platforms.

== Update of the App Platform itself ==
The App Platform is build on top of buildroot and will receive updates and fixes from time to time. 
You can update the used build inside the Manager App by using the '''Update''' button at the top. 

It is strongly advised to make a full backup (VM) or at least backup all apps (Gateway) before you run such an update!

After the update has been downloaded and verified, your App Platform will reboot.
You can check the installation process after the reboot with the following URL: https://IP-of-AP/manager/ramdisk.log

== App services and multi-threading ==
Each App Service runs in a single process with no multi-threading, independent of the instances of the App Service. However, each instance maintains its own database connection and the database responds to this connect with the creation of a new process. Each app service therefore uses 1+''n'' threads (where ''n'' is the number of instances). All communication between app service instances and their clients must pass the single-threaded web server. On platforms with multi-threading support (i.e. VMware or Hyper-V), up to 1 + ''m'' + ''m'' * ''n'' (with ''m'' being the number of Apps and ''n'' the number of instances per App) threads can be utilized.

= AP Manager settings =

== General ==
* ''Enable Developer mode'': in developer mode, apps can be manually uploaded without an App Store
* ''Disable App security'': each App has an own unix user and if this flag is set, the user can login with SSH for debugging
* ''App Store URL'': the URL to the App Store where Apps are searched and also an update of the AP image itself
* ''Devices app URL'': the URL to the Devices App to manage the AP through Devices
* ''Devices app URL 2'': don't use!
* ''App Platform DNS name'': currently not used
* ''NTP server 1/2'': NTP servers for this AP (in addition to NTP servers retrieved by DHCP)
* ''Timezone string'': A timezone string which is used by the App Platform Manager to do certain jobs according to the configured timezone.
** Note that this doesn't change the timezone of the linux itself!
* ''DNS server 1/2'': DNS servers for this AP (in addition to DNS servers retrieved by DHCP)
* ''Database optimization time'': The database optimization process will be started at this hour (local time), with a random offset of up to 7 hours
* ''Command file'': see [[#Backup of the Apps| Backup of Apps]]

== Security ==
* ''Current Webserver certificates'': shows the current certificates with the ability to download them.
* ''Webserver certificate'': upload a webserver certificate in PEM format
* ''AP Manager password'': the password to the web interface of the AP Manager (normally set through Devices)
* ''Linux root user'': password of the root user (normally set through Devices)
* ''Linux admin user'': password of the admin user (normally set through Devices)

== Let's Encrypt ==

Configure the certificate creation by Let's Encrypt here.

* ''Enable'': turns the automatic creation on or off
* ''Let's Encrypt App URL'': the URL of your Connector for Let's Encrypt App Service. You can copy&paste this URL from your Connector for Let's Encrypt PBX Manager Plugin
* ''Let's Encrypt App Password'': the client password of your Connector for Let's Encrypt App Service. You can copy&paste this password from your Connector for Let's Encrypt PBX Manager Plugin
* ''Key length'': 2048, 3072 or 4096 (keep in mind, that [[{{NAMESPACE}}:Certificate_management#Certificate_Key_Length_and_CPU_Usage|a higher value provides higher security but also lower performance!]])
* ''DNS Name'': the external DNS names of your device (up to 100 possible)

== Alarms and events ==
* ''URL'': URL to the Events app
* ''Username/Password'': HTTP credentials of the Events app
* ''Email address'': an email address which will get emails on full disk alarms/warnings
* ''Threshold'': All Apps will be stopped and an hourly email sent on reaching this threshold. An alarm is generated 10% before reaching this threshold and an email is sent every 24 hours.

== SMTP ==
SMTP server settings for sending emails from within the AP Manager.

Starting with 16r1 you also can configure OAuth2 Authentications. You can have a look into our HowTo Article for assistance: [[Howto16r1:Configure OAuth2 E-Mail]]

== Replication ==
App Platform [[#App Platform replication|replication settings]]

== Registered Access Domains ==

== Update ==
Updates the App Platform to the latest image available on the App Store.

== Restart ==
Restarts the App Platform.

== Shutdown ==
Shuts down the App Platform.

= App Platform replication =

== Requirements ==

* 13r3 or above on both standby servers and the primary server
* at least an App Platform image starting with version 110002 (otherwise postgresql is too old)
* standby and primary servers must have the same system architecture
** arm gateways (IPx11) just with arm gateways (IPx11)
** arm64 gateways (IPx13) just with arm64 gateways (IPx13)
** x86_64 virtual machines just with x86_64 virtual machines
* the disk size on standby servers must be at least equal as the disk size on the primary server

== General ==
The configuration is done within the App Platform Manager next to the settings button under "Replication".

=== Off ===
No replication is done at all.

=== Primary ===
The App Platform acts as primary server for one or multiple standby servers. 
Max 8 standby servers can be configured. 
 
Every standby server must get a unique name on the primary server which is then also configured on the standby server itself. This is due to the fact, that the primary server preserves data for every standby server while it's not reachable. 
A standby server name must be a valid domain name, although this name is currently not used as DNS name (but might be used in the future). 
 
The password is randomly pregenerated and must be used as handed by the App Platform Manager.

==== PostgreSQL port ====
The default PostgreSQL port is 5432 and can't be changed on the primary. It must be reachable through your firewall or at least forwarded on a different port towards this App Platform on port 5432.

=== Standby ===
Configure the password from the primary and one of the not yet used standby server names. 
The host and port must be reachable through the network. You can specify a non default port which then must be forwarded somewhere else to port 5432 on your primary.

*Note: Do '''not''' configure the same standby name on different standby servers, as this will break the replication on at least one standby! 
*Note: On a standby, all '''locally installed apps are removed''' during installation

== Failure detection ==

The replication state on both primary and standby servers are continuously monitored. 
In case of a broken connection, an alarm is triggered at once and just cleared if the failure goes away. 
 
If such an alarm lasts for 5 minutes an email is send. The recipient address must be configured in the App Platform Manager settings under "Alarms and Events" and you must also provide a valid SMTP configuration.

== Failover ==

There is no automatic failover procedure. If you detect the failure state, you must get active yourself.

=== Standby down ===

Fix the standby server and see if the replication comes up again. If not, setup a new standby server which will replicate the whole database cluster from scratch.

=== Primary down ===

If the primary is down and cannot be brought into life again, you must take the following steps, depending on your configuration:

==== One standby server ====

* Disable the replication in the replication configuration. You will then have a standalone App Platform afterwards.

==== Multiple standby servers ====

* Change the replication type on one of the standby servers from standby to primary. Please note that the other standby entries must still exist here (they are automatically offered)!
* Change the host entry on the other standby servers to the new standby server. The standby server will sync the whole database cluster again, which will take time.

==== Configuration changes ====

You must also tell the PBXes and other tools to use the new primary server.

* You may simply change the IP address behind the DNS of your primary server to point to the new primary server.
**Note: to ensure rapid recognition of the new DNS target, the definition of an appropriate TTL value is recommended
* Without DNS, you must currently modify the configuration by replacing the IP address of the old primary with the new address.
** This must be done in every master PBX configuration.
** This must be done in every App configuration which may use this IP address, e.g. Devices which rolls out an alarm server configuration

== App Platfom update ==

If you're running an active standby server and the major version of the PostgreSQL database didn't change, you can simply update primary and standby servers independently. 
 
If it contains a ''new major version'' of the PostgreSQL database, you must follow these steps:

* deactivate replication on all standby servers (which promotes these standby servers to active servers)
* ensure that the '''same''' App Platform Manager version is running on primary and standby servers!
* perform the App Platform update on the primary server
* perform the App Platform update on the standby servers
* reactivate replication on the standby servers (which will do a full replication again, so it might take some time)

Alternativly you may setup the standby server from scratch directly with the new App Platform image version.

Sadly there is currently no better method offered by PostgreSQL to perform such an upgrade.

See also https://wiki.innovaphone.com/index.php?title=Howto14r2:Firmware_Upgrade_V14r1_V14r2#App_Platform_and_Apps

== Technical backgrounds ==

=== Streaming replication ===

We use the asynchronous [https://www.postgresql.org/docs/9.3/warm-standby.html#STREAMING-REPLICATION streaming replication of PostgreSQL]. A transaction thus just waits for a commit on the primary server. Standby servers will receive the transaction asynchronously afterwards to avoid a reduced writing performance. 
A primary server keeps the neccessary WAL files for every standby server until the standby fetched the neccessary information. 
This fact can lead to higher disk space usage on the primary if one or multiple standby servers are offline for a while.

Take care to fix broken replications as soon as possible to avoid a full disk on the primary server!

=== What is replicated ===
The whole database cluster of an app platform is replicated. This includes every database of every instance and the database of the App Platform Manager itself. 

=== App Services on standbys ===
The database of the App Platform Manager itself also contains the App service binaries to be able to restore applications in a failover case. 
You do not have to install App services on the standby if you install them on the primary. 
App Platform Manager and Webserver can be updated as usual through the App Store or the Devices App if the standby is connected to Devices.

=== App Platform Manager configuration of the standby server ===
The App Platform Manager configuration of the standby server cannot be stored inside the database, as the database is readonly. So it is stored inside a configuration JSON file under ''/home/root/standby.conf''. 
This configuration is backed up as usual by a Devices backup job and can be also manually restored on a standby (not on a primary though!).

Configuration options from the primary are not synced to the standby server, as the standby server has its own configuration (as it could be in a different network etc.)!

=== No automatic failover ===

There is currently no automatic failover mechanism. PostgreSQL doesn't offer multi master replication, so writing is just possible on the primary itself. Standby servers have a readonly database. 
Let's consider the following use case if we would implement an automatic failover with the current technical possibilities: 
* The primary server is connected to a master PBX.
* A slave PBX is also connected to the primary server in another location.
* A standby server is in this location and replicates from the primary.
* The internet connection between primary and standby fails.
* The standby promotes itself to primary, so that the master PBX now writes to the old primary and the slave PBX now writes to the "new" primary.
* The internet connection comes up again and both primary and standby servers now have databases which are out of sync and which cannot be merged.

=== Security ===

* port 5432 must be reachable on the App Platform
* For every standby a PostgreSQL user is created with the REPLICATION role on the primary. Just this user has access to the database server from non localhost connections.
* You cannot establish a standard connection with such a user and modify/read from tables.
* The replication connection is established over TLS by default.

= App Installer PBX Manager Plugin =
== Requirements ==

* V14 and above

== General ==

The app installer plugin allows IT administrator (with access to the PBX Manager) to install/update/delete new apps from the innovaphone app store including Partners apps. It is automatically available with existing app platforms or after adding a new one in the PBX Manager.
It offers a view to the App Platform Manager‘s App Store with all the available functionalities and simplifies the install, update and uninstall of apps.

== Dedicated AP for each user ==

Installing a new app will install the app service and add a new instance with the user’s domain. The instance is automatically started. 
This further enables the configuration of the instance through its respective PBX Manager plugin. 
Uninstalling the app will remove the app service and the corresponding instance.

== Shared AP between users ==

Installing a new app works in a similar way to that of the dedicated AP. However, each time a new user installs the app, only a new instance is created if the app service is already installed. 
A user can uninstall the app, in this case the corresponding instance is deleted. If no more instances exist, then the app service is uninstalled. 
The administrator can only update the app service in such scenario.

= Known Issues =

== Reboot after an image update hangs (ARM/ARM64 gateway) ==

If it happens, that the App Platform doesn't recover after the reboot, please open the Admin UI of the corresponding gateway and take a look at App Platform -> General. 
If '''Kernel command line''' is set to '''/dev/ram0''', the App Platform booted the ramdisk. 
 
Try to fetch the upgrade log file:
https://[APP-PLATFROM-IP/DNS]/manager/ramdisk.log
 
If this doesn't work, try to login with putty in this case (default credentials admin/ipapps and root/iplinux) and issue this command: 
''cat /apps/install_step1.log'' 
 
If this file contains '''finished''' at the end, you can reconfigure the settings under App Platform -> General: 
* press '''Stop'''
* Initrd file: empty
* Kernel command line:
** IPxx11: '''root=/dev/sda3'''
** IPxx13: '''root=/dev/nvme0n1p3'''
* Ramdisk size: empty
* press '''Start'''

The App Platform should boot and run the already updated image.

<pre style="color: red; font-size:150%;">---WARNING---
If the file doesn't contain "finished" at the end, you may still need to wait, as an upgrade may take some time!
Do not reconfigure without being sure that the upgrade has finished, otherwise your system may won't run!</pre>

== Reboot after an image update boots always into rescue mode (virtual machine) ==

This most likely means that the image installation didn't finish the first time and was interrupted before the bootloader settings could be changed back to the default partition. 
 
If your App Platform doesn't boot or isn't normally accessible after manual selection of the standard entry in the boot menu, you need to '''revert''' to a '''snapshot/backup''' prior to the update. 
If your App Platform runs normally though, you can follow this instruction to change the default boot entry: 
 
* boot into the '''rescue''' partition
* login with root/iplinux
* edit the file /boot/grub/grub.cfg
** search the line with '''set default=0''' and change it to '''set default=1'''
** reboot

== App Platform doesn't start after an update ==

=== Gateway ===
If it happens, that the App Platform doesn't want to start an update, please open the Admin UI of the corresponding gateway and take a look at App Platform -> General. 
* '''Shutdown''' the App Platform and '''Stop''' it 
* Set '''Kernel command line''' to '''/dev/ram0''' 
* Set '''Initrd file''' to '''ramdisk.ext2.xz''' 
* Set '''Ramdisk size''' to '''100000''' 
* '''Start''' the App Platform now. 

The App Platform now either applies the image update or it reboots into the old image. Try the image update afterwards again.

Note: This process can take a while, after it's finished it reboots and automatically change the '''Kernel command line''' value.

=== Virtual Machine ===

Boot into the '''rescue''' partition.

The App Platform now either applies the image update or it reboots into the old image. Try the image update afterwards again.

=== It still doesn't start ===

If it still doesn't start, configure the App Platform to boot from /dev/sda3|IPx11 or /dev/nvme0n1p3|IPx13 (or inside a VM start the second boot loader entry) and login with SSH as root.
Then do a first check to verify that you have a specific error due to an incomplete update or a [[Howto15r1:Firmware Upgrade V14r2 V15r1#AP Upgrade to Image 130006|wrong update order]]:

* /etc/init.d/S92manager stop
* /apps/manager/manager
* if this outputs '''error while loading shared libraries: libcrypto.so.3:''' you have a manager version which cannot run on the current image.

In this case you must download an older build (14r1 1410593):

* /etc/init.d/S92manager stop
* wget --no-check-certificate -O /apps/manager/manager https://webbuild.innovaphone.com/1410593/arm/manager/manager
** inside a virtual machine, use '''x86_64''' inside the path instead of '''arm'''
** on an IP6013, use '''arm64''' inside the path instead of '''arm'''
* wget --no-check-certificate -O /apps/webserver/webserver https://webbuild.innovaphone.com/1410593/arm/webserver/webserver
** inside a virtual machine, use '''x86_64''' inside the path instead of '''arm'''
** on an IP6013, use '''arm64''' inside the path instead of '''arm'''
* chown root:root /apps/manager/manager
* chown root:root /apps/webserver/webserver
* chmod +x /apps/manager/manager
* chmod +x /apps/webserver/webserver
* echo 110000 > /mnt/sda1/label
** this allows the manager to perform an image update again
* /etc/init.d/S92manager start
* now perform an image update and '''afterwards''' update your apps again

== Webserver doesn't respond after an image update ==

If you can't reach the web UI after an image update, please try to connect with SSH as admin user and delete old coredumps, which may prevent the App Platform Manager from starting correctly:
* su root (become root)
* rm -f /mnt/sda2/log/core_dumps/*/*
* /etc/init.d/S92manager restart

Check if you can now reach the App Platform again.

= Tracing =
Each App Service has its own log file, which can be accessed through the Manager App. You can configure a log file size for each App Service. 
Each App Intance has its own trace flags. The following trace flags can be set: 

* Alarm client: used by the manager to send alarms to an alarm server
* App: logs from the App Service itself
* App WebSocket: logs app websocket connections (e.g. from PBX objects to an App Service or from the UI to the App Service)
* AppSharing: just native clients
* AppProxy: just native clients, logs requests which are proxied between the local webserver and the remote server
* Audio: just native clients
* Browser: just native clients
* Command: the command interface is used to execute shell commands, e.g. used by the manager App
* Config: logs config changes of an App
* Database: database logs
* DB files: database file logs
* DNS: DNS request logging
* DTLS: just native clients, DTLS request logging
* Ethernet: interface to get ethernet adapater infos, just manager App
* File: logs for file system access (synchronous), e.g. manager App
* Files: logs for file system access (asynchronous)
* HTTP client: http client logs
* HTTP file: logs for static HTTP files
* ICE: just native clients
* LDS: local domain sockets
* Media: just native clients
* Media channel: just native clients
* Process: IProcess interface logs which is used for spawning, killing processes etc.
* SMTP: SMTP client logs
* TCP: TCP logs
* Time: ITime interface logs
* TLS: TLS logs
* TURN: just native clients
* UDP: UDP logs
* Video: just native clients
* WebSocket client: logs outgoing websocket connections
* Webserver traffic: logs incoming HTTP traffic, which is forwarded from the webserver to the App
* WebDAV service: logs WebDAV requests to the App
* Webserver: enables webserver specific logs

== RPCAP ==

If you open the Manager App, click on the Manager in the left list and then on the Diagnostics button, you can enable RPCAP. 
You can add the interface in wireshark with the string:
rpcap://<APP-Platform-IP>/eth0

'''Please don't forget to disable RPCAP after your testing!'''

== Exclamation marks ==
If you see an exclamation mark next to an App Service, this App Service has been crashed before. 
You can download a core dump or backtraces for further investigation. To clear the exclamation mark, you have to delete the log files.

= How-Tos =

== How to retrieve files from the App Platform ==
To retrieve files from the App Platform which can not be retrieved via the App Platform manager UI, you can connect to the App Platform using the SCP protocol on port 22. 
 
First copy files to /home/admin as root with Putty or another SSH client:
* use the ''DNS'' name or IP address of your App Platform (not the PBX)
* use user ''admin'' and the appropriate password (''ipapps'' by default)
* use ''su root'' to be root (''iplinux'' as default password)
 
You can now copy files to ''/home/admin'' (e.g. from /var/log/apps/manager/...). 
 
You can create a tar archive with all logs like this:
* cd /home/admin
* tar -cf - /var/log/* | xz -z - > log.tar.xz
** you may want to exclude coredumps (due to their size):
** tar -cf - --exclude=/var/log/core_dumps/* /var/log/* | xz -z - > log.tar.xz
* chown admin:admin /home/admin/log.tar.xz
 
Then copy the files to your local system, e.g. with WinSCP 
* use ''SCP'' as protocol (NB: WebDAV is not supported on most of the directories on the App Platform )
* use the ''DNS'' name or IP address of your App Platform (not the PBX)
* use user ''admin'' and the appropriate password (''ipapps'' by default)
* use ''/home/admin'' as start directory
* copy the needed files

== App Platform disk space warning ==

If the configured threshold is reached, all Apps are stopped inside the App Platform . You must then free disk space somehow.

=== Find large instances ===
Click through your apps in the tree on the left side and take a look at the database size of each instance.

=== Delete data inside an instance ===
It depends on the type of app if you can delete data or not. E.g. you can start the Files app and delete files inside this app. 
This won't reclaim disk space though due to the way how PostgreSQL databases work, so you need to follow this guide to reclaim the disk space:

* start the corresponding App
* delete data inside the App
* optimize disk usage of the database by cliking on the button "Clean up database" under Edit instance. If this does not help, continue with the following steps.
* stop the corresponding App again
* download a backup of the instance (backup button at the top), this backup contains the whole instance data, also the password of the instance
* delete this specific instance
* restore the downloaded backup (restore button at the top)

Depending on the hardware and the size of the instance, this process may take hours to complete!

=== Resize the disk ===
The resizing of a disk is just possible for virtual machines, see [[#Resizing the disk of a Virtual machine|Resizing the disk of a Virtual machine]].

=== Delete the whole instance ===
If there is no other possibility, you can delete the whole instance. Afterwards you recreate the instance with the same values and a new random password. Don't forget to set this password in the corresponding PBX App objects though!

=== Restart the Apps or the App Platform ===
If you have enough disk space again, you must either restart the whole App Platform or you manually start all Apps again.

== App Platform/Apps app not online anymore due to full disk ==
If the apps app is not online anymore and you can't access any apps anymore, try to login with an SSH client to see if your disk is full.
Login as admin and afterwards as root (su root). 
 
* issue '''df -h''' and see the disk usage of /dev/sda2, if this is 100%, your disk is too full
* stop the manager
** /etc/init.d/S92manager stop
* empty the 500 MB file, which is exactly for this case here (manager must be 13r1 SR9 or higher to have this file)
** echo "" > /mnt/sda2/empty_if_no_space
* delete log files to recover some space
** rm /var/log/apps/*/*
** rm /var/log/core_dumps/*/*
* restart the postgresql server (see the output if this worked or not)
** /etc/init.d/S50postgresql restart
* restart the manager
** /etc/init.d/S92manager restart
* wait until everything is online again
* open the Apps app and try to find the instance which uses the most disk space and try to delete files/content from it
** you may want to stop all app services first to prevent more writes to the database
** if not possible, you can delete this instance, but you'll loose all data from this instance then!
* after that you can try [[{{NAMESPACE}}:Concept_App_Platform#Shrink_the_physically_size_of_PostgreSQL_database_files|Reference14r2:Concept_App_Platform#Shrink_the_physically_size_of_PostgreSQL_database_files]] to free up space
** If this does not work you can create a backup from the database, delete the database and import the database again.
* free up at least 500 MB so that the manager can create the file again
* delete /mnt/sda2/empty_if_no_space if you are done and restart the manager:
** rm /mnt/sda2/empty_if_no_space
** /etc/init.d/S92manager restart
** the manager restart automatically recreates the empty_if_no_space file if this file doesn't exist

Make sure, that you do '''not''' have backups configured to a local files instance while this files instance is not excluded from backups.
An instance can be excluded from backups in the instance settings in the App Platform Manager.

If all of this doesn't help, you can resize the file system on a VM:
* proceed with [[{{NAMESPACE}}:Concept_App_Platform#Resizing_the_disk_of_a_Virtual_machine|Reference14r2:Concept_App_Platform#Resizing_the_disk_of_a_Virtual_machine]]

== Resizing the disk of a Virtual machine ==

Do '''NOT''' resize if you're running an App Platform version higher than '''110000''' and lower than '''110027''' or '''130007''' and lower than '''130015''' or your data will be lost!
Please update your App Platform to version 130015 or higher before you start resizing your disk.

* stop the VM
* expand the disk using your VM utilities
* start the VM, select in the blue screen the option '''rescue/setup''' (just the first 3 seconds to see)
* login with '''root''' and '''iplinux'''
* execute this command: '''/home/root/install_step1.sh log.txt resize'''
* the VM reboots automatically after a successful resize

== Shrink the physically size of PostgreSQL database files ==
Tuples that are deleted in your database are not physically removed from the database-file. So the claimed space on the harddisk is still in use after the delete operation.
If you need to free up some disk space you can force to reorganize the physically database-file on your harddisk.

You can also start this process through the instance settings as long as the App Platform Manager is still running.

'''Important: You are operating on the Database, you have to make a Backup of your Database before you do this!'''

Login via SSH to the APPlatform with the ''admin'' User
su root

=== All databases ===
/etc/init.d/S92manager stop # not always needed, but in case of database errors recommended, of course no app is online then
sudo -u postgres reindexdb -a
sudo -u postgres vacuumdb -a -f
/etc/init.d/S92manager restart # just execute if the manager has been stopped above

=== single database ===
sudo -u postgres reindexdb -d dbname # for a single database with dbname
sudo -u postgres vacuumdb -d dbname -f # for a single database with dbname

Note: This may take some time and the App database is not available during this time

After the process you can check the free dispace via <code>df -h</code>. You can check the claimed space from the database file with the command <code>du -sh /mnt/sda2/pgsql/</code>.

== Change IP Addresses / DNS Names / System Name ==

If you want to change the System Name or the DNS Name of the PBX and/or App Platform Platform you must change records manually '''in the described order'''!
You have to know the Admin password to directly Login to the App Platform .

=== App Platform ===
; Settings - General
* ''Devices app URL''
* ''App platform DNS name''

; Settings - Alarms and Events
* ''URL''

; All Instances
* ''Domain''
* ''Webserver path''

=== PBX ===
Download the configuration and ''search/replace'' in the config file. Upload the config file and reboot.

Manual:
* ''URL'' in all PBX Object (Apps, Voicemail ...)
* [[{{NAMESPACE}}:Gateway/CDR|CDRx]]
* [[{{NAMESPACE}}:PBX/Config/General|IP address for App Platform]]
* [[{{NAMESPACE}}:PBX/Config/myApps|Reset Password Page]]
* [[{{NAMESPACE}}:PBX/Config/Authentication|Verification link]]

Depending on your change you have to activate/deactivate the Setting [[{{NAMESPACE}}:PBX/Config/General|Operation without DNS]]

=== Additional Devices / Steps ===
* ''Devices Registration URL''
** There is no automatism to change the URL on all devices in your setup.
** If you have the option to use DHCP, you can temporarily overwrite the [[{{NAMESPACE}}:Services/Update|Update URL]] and execute a [[{{NAMESPACE}}:Concept_Update_Server|custom update script]] to change the ''Device Registration URL''
* ''Alarm server''
* Reverse Proxy configuration
* Change ''Domain Name'' in Devices if you have also changed the system name

== How to recover from a broken File System ==
Sometimes you may find messages in the ''messages'' log file (in ''var/log'') like

initial error at 1500329378: ext4_journal_start_sb:328
last error at 1500329378: ext4_journal_start_sb:328

Or you get events like "Broken file system" from your App Platform .

This indicates a file system failure on the Linux Installation.

When the Linux file system is broken, you can try to repair it using some command line Linux tools.

If this doesn't fix your issue, you need to replace the SSD with a new one, re-install the App Platform and any applications and restore your backups.

=== Gateway ===

* Open the WebGUI of the gateway running your LAP and proceed to ''App Platform/General''
** terminate Linux (''Status/Stop'')
** modify the Kernel command line from root=/dev/sda3 (or /dev/nvme0n1p3) to root=/dev/ram0
** modify the Initrd file to ramdisk.ext2.xz
** modify the ramdisk size to 100000
** start Linux again
:: This will run Linux on another (hopefully sane) partition.

* use [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html putty] to log in to the LAP's command line ( try either user: root, pw: iplinux '''OR''' user: admin, pw: ipapps)
** use this to be root <code>su - root</code> (password iplinux)
** on the command prompt, use <code>e2fsck -p -f /dev/sda2</code> on IPx10/IPx11 gateways
** on the command prompt, use <code>e2fsck -p -f /dev/sda3</code> on IPx10/IPx11 gateways
** on the command prompt, use <code>e2fsck -p -f /dev/nvme0n1p2</code> on IPx13 gateways
** on the command prompt, use <code>e2fsck -p -f /dev/nvme0n1p3</code> on IPx13 gateways
:: this should fix any issue on the file system

* go back to the WebGUI of the gateway running your LAP and proceed to ''App Platform/General''
** terminate Linux (''Status/Stop'')
** modify the ''Kernel command line'' from ''root=/dev/ram0'' to <code>root=/dev/sda3</code> (IPx10/IPx11) or to <code>root=/dev/nvme0n1p3</code> (IPx13)
** clear the Initrd file field
** clear the ramdisk size field
** start Linux again
:: This will run Linux on the original partition.

=== VM ===

Restart the VM and select the first entry in the boot menu from grub.

* use [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html putty] to log in to the LAP's command line ( try either user: root, pw: iplinux '''OR''' user: admin, pw: ipapps)
** use this to be root <code>su - root</code> (password iplinux)
** on the command prompt, use <code>e2fsck -p -f /dev/sda2</code>
** on the command prompt, use <code>e2fsck -p -f /dev/sda3</code>
:: this should fix any issue on the file system
* Reboot your VM
[[Category:Concept]]

== How to create a memory dump of a running process ==

Sometimes it's usefull to have a memory dump of a running process to investigate certain issues.

* login with SSH and become root
* find out the PID of the relevant process, e.g. with ''ps aux | grep /apps/manager/manager | grep -v grep''
* gdb --pid PID -ex gcore --batch
* this creates a core file core.PID
* download this core file with WinSCP or similar tools

== Move instance database to external database host ==

In case you want to use an external database server instead of the integrated:

* download a backup of the specific instance over the App Platform Manager
* create a postgresql database on the external host:
** createdb --encoding=UTF-8 exampledb
* restore the backup
** pg_restore -d exampledb backup-exampledb.dump
* change the ownership to a specific postgresql user (which you have to create yourself first)
** psql -d postgres -c "ALTER DATABASE exampledb OWNER TO exampleuser"
* configure the database host, name, user and password on the instance inside the App Platform Manager

Reference16r1:Concept App Service IP

2026-07-06T07:26:34Z

Kpe: /* Create instance */

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
'''Name''' = ip 
'''Domain''' = customer domain (system name of the PBX) 
'''Password''' = The password '''must be set to "pwd"''' for Install and will be changed during the process. '''Note:''' if you want to login with the Adv.GUI to the PBX prior to the Install proces, this is also the admin password!

=== Install Process ===
Install can be started under the webserver path of the App IP instance and /''install.htm'', e.g.: http://app.domain.com/domain.com/ip/install.htm

⚠️ Use standard ports for installation. If necessary, install via a reverse proxy

⚠️ Do not use the localhost (127.0.0.1) address

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://app.domain.com/domain.com/ip/admin.xml?xsl=admin.xsl

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

==Troubleshooting==
The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==
The installation process must be performed using a DNS name rather than an IP address. 
The URL must include the parameter ''?apdns="DNS from App Platform"'' in the path, for example: http://app.domain.com/domain.com/ip/install.htm?apdns=pbx.domain.com 
Starting with version 16r1 sr1, installation using an IP address is supported. 

However, it is generally recommended to use DNS for the installation.

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Container]]

Reference:Supported SIP Features and List of RFC's

2026-07-03T07:23:46Z

Kpe: /* List of supported RFCs in v13r2 */

==Summary==
SIP Features and list of RFC’s supported since version 6 of innovaphone firmware

==Applies To==
This information applies to
* All innovaphone V6 devices
Build 06-6040001 and later.

==More Information==

===PBX Features and their corresponding RFCs===

MWI (RFC 3842/RFC 3265 "Subscription für message-summary")

DTMF (RFC 2833 "RTP payload for DTMF")

Name Identification (Display String, RFC 3325 "Asserted Identity")

Hold/Retrieve (RFC 3264 "Offer/Answer Model for SDP") [[Howto:SIP Reverse Negotiation - Call Transfer]]

Transfer (RFC 3515 "REFER Method", RFC 3891 "Replaces Header)

Coder Change [T.38] (RFC 3264 "Re-Negotiation")

Call Forwarding (PBX internal, "183 Call Is Being Forwarded", "Diversion Header")

Overlap Dialing (RFC 3578)

Dialoge State monitoring (partner Key) (RFC 4235)

Instant Messaging (RFC 3428)

=== CTI Features and their corresponding RFCs ===

Initiate outgoing call (a call with <code>Answer-Mode: Auto</code> header (RFC 5373) is sent to the originating phone)

Accept incoming call (an unsolicited NOTIFY-Request with <code>Event: talk</code> header (RFC 3265) is sent to the accepting phone)

In a scenario where a call is accepted on a different device (e.g. pickup group), the PBX will use the Reason Header <code>Reason: SIP ;cause=200 ;text="Call completed elsewhere"</code> in its Cancel Message to signal that a call is accepted elsewhere and must not be entered in the phones call list. (RFC 3326)

===List of supported RFCs===

*RFC 1889
RTP: Real-Time Transport Protocol

*RFC 1890
RTP Profile for Audio and Video Conferences with Minimal Control

*RFC 2327, RFC 3266, RFC 4566
SDP: Session Description Protocol

*RFC 2396
Uniform Resource Identifiers (URI): Generic Syntax

* RFC 2543
SIP: Session Initiation Protocol (obsolete)

* RFC 2616
Hypertext Transfer protocol (HTTP/1.1)

*RFC 2617
HTTP Authentication: Basic and Digest Access Authentication

*RFC 2782
A DNS RR for specifying the location of services (DNS SRV)

*RFC 2976
The SIP INFO Method (including the non-standard <code>application/dtmf-relay</code> and <code>application/dtmf</code> content types with a fixed duration of 250)

*RFC 3203
DHCP reconfigure extension

*RFC 3261
SIP: Session Initiation Protocol

*RFC 3263
Session Initiation Protocol (SIP): Locating SIP Servers

*RFC 3264
An Offer/Answer Model with the Session Description Protocol (SDP) [[Howto:SIP Reverse Negotiation - Call Transfer]]

*RFC 3265
SIP-Specific Event Notification

*RFC 3323
A Privacy Mechanism for the Session Initiation Protocol (SIP)

*RFC 3326
The Reason Header Field for the Session Initiation Protocol

*RFC 3389
RTP Payload for Comfort Noise

*RFC 3515
The Session Initiation Protocol (SIP) Refer Method

*RFC 3550
RTP: Transport Protocol for Real-Time Applications

*RFC 3551
RTP Profile for A/V Conferences with Minimal Control

*RFC 3555
MIME Type Registration of RTP Payload Formats

*RFC 3578
Mapping of Integrated Services Digital Network (ISDN) User Part (ISUP) Overlap Signalling to the Session Initiation Protocol (SIP)

*RFC 3680
SIP Event Package for Registrations

*RFC 3764
enumservice registration for SIP Adresses-of-Record

*RFC 3824
Using E.164 numbers with SIP

*RFC 3891
The Session Initiation Protocol ‘Replaces Header’

*RFC 3892
The SIP Referred-By Mechanism
-SIP-aware filtering (to prevent SIP attacks)

*RFC 3842
SIP Message Waiting

*RFC 3311
re-INVITE

*RFC 2833
DTMF via RTP Channel , RTP payload for DTMF

*RFC 3325
Name identification

*RFC 3578
Overlap Dialing

*RFC 3420
Internet Media Type message/sipfrag

*RFC 3428
Extension for Instant Messaging

*RFC 3262
Reliability of Provisional Responses in Session Initiation Protocol (SIP)

*RFC 4028
Session Timers in the Session Initiation Protocol (SIP)

*RFC 4235
Dialoge State monitoring (partner Key)

*RFC 4612
Real-Time Facsimile (T.38) - audio/t38 MIME Sub-type Registration

*RFC 4733
RTP Payload for DTMF Digits, Telephony Tones, and Telephony Signals

*RFC 4916
Connected Identity in the Session Initiation Protocol (SIP)

*RFC 5373
Requesting Answering Modes for the Session Initiation - only Header <code>Answer-Mode: Auto</code> for calls started via SOAP/TAPI is supported. Header <code>Priv-Answer-Mode</code> for urgent calls is not supported.

*RFC 4568
Session Description Protocol (SDP) Security Descriptions for Media Streams

===List of supported RFCs in V8===

*RFC 3863
Presence Information Data Format (PIDF)

*RFC 4480
Rich Presence Extensions to the Presence Information Data Format (PIDF)

*RFC 3856
A Presence Event Package for the Session Initiation Protocol (SIP)

===List of supported RFCs in V9===

*RFC 4235
An INVITE-Initiated Dialog Event Package for the Session Initiation Protocol (SIP)

*RFC 4040
RTP Payload Format for a 64 kbit/s Transparent Call

===List of supported RFCs in v11r1===
* RFC 5245
Interactive Connectivity Establishment (ICE)

* RFC 6336
Interactive Connectivity Establishment (ICE) Options

*RFC 5763
DTLS-SRTP Framework

===List of supported RFCs in v13r2===
*RFC 5626
Client-Initiated Connections in SIP

===List of supported RFCs in v15r1===
*RFC 7118
SIP over WebSocket

==Related Articles==
* [[Howto:SIP Reverse Negotiation - Call Transfer]]

* [[Howto:SIP Media Negotiation - Details]]
* [[Howto:Guidelines for Testing 3rd Party SIP Terminal Devices]]
* Additional RFC's listed here: [[Howto:Security_works_with_innovaphone]]

[[Category:Howto|{{PAGENAME}}]]
[[Category:Faq|{{PAGENAME}}]]

Howto13r3:Step-by-Step Setting up a Standby PBX

2026-06-26T15:11:21Z

Kpe: /* Requirements */

[[Category:Step-by-Step|Setting up a Standby PBX]]
{{HOWTOMOD13r3 Translation Info}}

This guide provides step-by-step instructions for configuring a standby PBX only, which is used to enhance the availability of your system.

This guide does not describe all aspects that might be necessary in your scenario, it only covers the setup of the standby PBX. Check for more details the related articles the courseware about redundancy.

== Purpose ==
A standby PBX provides redundancy in your system architecture in case the master PBX fails or the connection to the master PBX got lost.

In the standby role, registrations arriving at the standby PBX will be diverted to the master PBX.

When there is no connection between standby PBX and master PBX or if the master PBX fails, the standby PBX will switch its role from "Standby" to "Master" and accepts registrations from the clients.

As soon as the master PBX is up and running again or the connection is restored, the master PBX takes over it's master role again and the standby will be in the standby role again.

There is a timeout mechanism to make sure that this switching roles only happens after the timeout has been expired, this to prevent repeatedly switching in case of short connection errors.

[[image:set-up-standby-PBX-overview.png|set-up-standby-pbx-overview.png/|set-up-standby-pbx-overview.png/]]

=== Features ===
* A standby PBX ensures the availability of your system in case the master PBX in your system architecture fails or the connection to the master PBX fails.

== Requirements ==
* The platform used as a standby PBX needs to be able to handle as much registrations and object definition as the the master PBX does. However, it does not need to be the same type of device. E.g. an IP0011 may serve as a standby for an IP3011 in certain scenarios.
* To enable standby functionality, a standby PBX must have the same amount of standby licenses as port licenses. Please note that the standby PBX receives the necessary licenses as soon as it registers with the master PBX by replication. You don't need to upload the standby licenses manually to the standby PBX! In case you use an IPVA as a Standby PBX, make sure that you also have IPVA-licenses available.

== Things to know before you begin ==
* You need to know the PBX password of your system
* You need to know the IP address of your master PBX

== Configuration ==
Please enter the IP address or DNS name of your designated standby PBX into a browser and log in to the advanced user interface of this device.
=== PBX Mode ===
Go to PBX/config/General and set the PBX mode to ''Standby''

[[image:set-up-standby-PBX-1.png|set-up-standby-pbx-1.png/|set-up-standby-pbx-1.png/]]

=== General Settings ===
Almost all properties of the general page of the standby PBX must be set identically to those of the master PBX. Please note that the standby PBX must have a unique ''DNS name''.

[[image:set-up-standby-PBX-2.png|set-up-standby-pbx-2.png/|set-up-standby-pbx-2.png/]]

Do not forget to press OK to save the settings.

=== PBX Password ===
Go to PBX/Config/Security and set the PBX password identical to the ''PBX password'' of the master PBX.

[[image:set-up-standby-PBX-3.png|set-up-standby-pbx-3.png/|set-up-standby-pbx-3.png/]]

=== Registration ===
Please go back to PBX/Config/General and set the ''registration'' protocol to H.323/TLS. Furthermore please set the ''Master'' property to the IP address of the master PBX. (No DNS Name allowed)

=== Object Replication ===
After registration we want to replicate all objects to the standby PBX. This can be achieved by ticking the ''Replicate from Master'' checkbox and the ''use TLS'' checkbox.

[[image:set-up-standby-PBX-4.png|set-up-standby-pbx-4.png/|set-up-standby-pbx-4.png/]]

=== Client configuration ===
Make sure each phone or interface is configured with a secondary gatekeeper, as this allows the client to send its registration requests to the standby PBX if the master fails.

== Verification ==
There are multiple ways to verify if your configuration works as expected.

*You should see an entry called ''_STANDBY_'' in the list of registrations on the master PBX.

[[image:set-up-standby-PBX-5.png|set-up-standby-pbx-5.png/|set-up-standby-pbx-5.png/]]

*You should see an entry called ''_ACTIVE_'' in the list of registrations on the standby PBX.

[[image:set-up-standby-PBX-6.png|set-up-standby-pbx-6.png/|set-up-standby-pbx-6.png/]]

*You should see all expected licenses in the Licenses area (PBX/Config/General) on your standby PBX.

*All Objects of the master PBX should be replicated to the standby PBX.

*You can test your configuration by turning off the master PBX. The standby PBX should take over all registrations

== Known issues ==

== Related Articles ==
[[Courseware:IT_Advanced_-_02_PBX_-_initial_Configuration]]

[[Courseware:Advanced_-_Standby_PBX]]

[[{{NAMESPACE}}:Step-by-Step Standby registration through Reverse Proxy]]

Reference13r3:Concept Provisioning

2026-06-25T08:40:34Z

Kpe: /* User adding a new phone */

=Overview=
In 13r1 and above provisioning of phones is done with Devices. From a user point of view a provisioning code is entered on a new phone and then the rest happens automatically. There are different kind of provisioning. A user who adds a new phone, an administrator who performs rollout for many phones and maybe more. The different types of provisioning are defined one after the other.

== Requirements ==

* HTTP/HTTPS-access to config.innovaphone.com (open port 80/443)
* further required protocols/ports see [[Howto13r3:Firewall Settings|here]]
* device does not yet belong to a (different) domain

== User adding a new phone ==

From a user point of view this should work as follows:

* The user unpacks the phone and connects it to the network (we assume 13r1 is on the phone already, but maybe an old build)
* On the display a form requesting a provisioning code is displayed
* The user opens myApps/Profile and selects to add a new phone
* Drop down to select a category is provided
* When the user has sent the request a provisioning code is displayed
* The user adds the provisioning code on the phone and confirms with OK.
*:'''Note''' for IP101/IP102, IP150/IP160 IP170/IP171: Confirmation is done by adding <nowiki>#</nowiki> to the provisioning code or using the redial key if this key is available.
* The phone is updated to the current version of the installation, configured, a device is added to the user in the PBX

=== Implementation ===

;Setup:
:* The Devices PBX app object must have a websocket connection flag.
:* The Profile PBX app object must have a websocket connection flag, the Services flag and the "devices-api" App.

;User connects a 13r1 phone to the network:
:* The standard update url http://config.innovaphone.com/init is requested.
:* The provision code form is displayed.

;User selects to add a new phone on myApps/Profile:
:* The Users instance asks Devices for a list of categories configured for provisioning
:* The Users Instance requests a provisioning code from Devices with selected category
:* Devices requests a provisioning code from config.innovaphone.com and supplies the devices URL to config.innovaphone.com
:* config.innovaphone.com generates a random provisioning code of 12 digists without any structure
:* config.innovaphone.com stores the provisioning code and URL in the database
:* Devices stores the provisioning code together with domain and category in the database
:* Users stores the provisioning code and with the requesting user in the database

;The user enters the provisioning code:
:* The code is sent to config.innovaphone.com
:* config.innovaphone.com configures the Devices URL of the customer
:* The phone connects to Devices and sends the provisioning code
:* Devices assigns the phone to a domain and category
:* Devices updates the phone
:* Devices configures the phone
:* Devices sends the mac address and provisioning code to a Users instance of matching domain. If no Users with matching domain is connected, the mac address is stored in the database so that the info can be sent, when a matching Users connects
:* Users configures a device for the user

'''Note''': Due to security reasons, provisioning codes are valid for 10 minutes from date of issue. Upon validation expiry, they are deleted from the database and no more useable anymore.

=== Update Software functionality in Devices ===

A list of jobs is stored. This list contains domain and category of the devices to be updated. With a job the json which was current on the time of creation is stored. When a device registers it is updated according to the latest matching job.

=== Update Config functionality in Devices ===

A list of jobs is stored. This list contains doman, category and a type of config with related parameters. When a device registers it is updated according to the latest jobs of all types.

== Rollout of many phones on UsersAdmin ==

On UsersAdmin under "Register phones" phones can be provisioned for many users at once.

To provision the phones:

* Select new phone registrations and follow the steps.
* On the first step the connection with Devices is stablished.
* On the second step, the provisioning category (the categories are configured on Devices for a given domain) and the phone app are selected. A dropdown menu will be displayed if there is more than one option.
* On the third step the users must be selected
* On the fourth step the provisioning codes list is displayed. This list can also be downloaded as a CSV file. Every user must enter his code on his phone. After that, the state should change from "Pending" to "Registered".

'''Note''': Due to security reasons, provisioning codes for rollouts are valid for 7 days from date of issue.

== Privacy ==

When using the online provisioning, following data/information are send to innovaphone [[Howto:Innovaphones_public_services|config.innovaphone.com]]:

* Devices APP
** Websocket URL of your AP-Platform
* Phone
** Mac Address
** Phone Model
** Firmware Version
** Bootcode version
** Timestamp of the first connect to config.innovaphone.com
** Entered Provisioning Code
** Local IP

== Offline Provisioning ==

There is also the possibility for offline provisioning: [[{{NAMESPACE}}:Concept_Offline_Provisioning]]

== Show provisioning code display on phones ==

You have to issue the following command to show the provisioning code display on phones again:
''!vars create UPDATE/PROVISIONING-CODE h prompt''

No reboot or config write is required

== Automatic provisioning ==

Available with 13r1 '''SR13'''.

You can enable the automatic provisioning mechanism inside your Devices App in the domain settings. 
If you enter a security token here, devices can register with this token automatically. 
 
You then have to rollout a devices registration URL with URL parameters on your devices, which shall use this mechanism. 
 
Let's assume the auto provisioning URL (visible in the Devices App) looks like this: 
wss://apdnsname.com/domain.com/devices/sysclients?domain=domain.com&token=1j2h3j12h3&category=testcategory
 
The config cmd provided within an update script then looks like this, as you need to URL encode the whole value: 

config change SYSCLIENT /sysadmin wss%3A%2F%2Fapdnsname.com%2Fdomain.com%2Fdevices%2Fsysclients%3Fdomain%3Ddomain.com%26token%3D1j2h3j12h3%26category%3Dtestcategory

The following parameters are available and mandatory. The values of these parameters must be URL encoded '''before''' the complete URL is URL encoded for the !config change command:
* domain: the domain name for the device
* token: a security token, which must be manually configured in the Devices App inside the domain settings
* category: the name of a provisioning category inside the given domain (it must be explicitly a provisioning category!)

Example:

Encode the values for token and category first:
token: abcdef#XYZ => abcdef%23XYZ
category: acme IP Phone => acme%20IP%20Phone

Encode the complete provisioning URL:
wss://apdnsname.com/domain.com/devices/sysclients?domain=domain.com&token=abcdef%23XYZ&category=acme%20IP%20Phone
=>
wss%3A%2F%2Fapdnsname.com%2Fdomain.com%2Fdevices%2Fsysclients%3Fdomain%3Ddomain.com%26token%3Dabcdef%2523XYZ%26category%3Dacme%2520IP%2520Phone

Double check the [[Reference13r1:General/Devices-Registration|''Devices App URL'']] after the Update Script is executed on the provisioned device (the URL must not contain any spaces or non urlencoded characters):

wss://apdnsname.com/domain.com/devices/sysclients?domain=domain.com&token=abcdef%23XYZ&category=acme%20IP%20Phone

Do not use a web browser to submit the config line <code>config change SYSCLIENT ...</code> to the provisioned device, cause it will urldecode the URL prio sending it to the device, resulting in an incorrect configuration.

=== Administrative passwords ===

With latest 13r3 firmware and above, devices which are automatically provisioned will never receive the administrative domain password but instead a random password. 
If you provision a gateway like this, you can remove it from your domain and manually add it again to receive the administrative domain password if you deploy the administrative password on your domain. 

Note that you can't remove and add a device in our cloud manually! Provision the device instead with the install provided on the gateway where you enter a manually created provisioning code.

== Provisioning V13 devices with V12 Update Server ==

If you use a V12 update server you have to delete some variables on the device. This is normally done by the V13 provisioning service which is not used in this scenario.

Therefore you need to delete the following variables in your provisioning process.

config rem UP1 /provisioning
config rem UP1 /provision
vars del UPDATE/PROVISIONING-CODE
config write
config activate

=Related Articles=
* [[{{NAMESPACE}}:Concept_Offline_Provisioning]]
* [[{{NAMESPACE}}:Services/Provisioning]]
* [[{{NAMESPACE}}:Services/Update]]
* [[Howto:V13_Firewall_Settings]]
* [[Howto:What_Ports_are_used_for_Signaling_and_Voice_Traffic_in_SIP_and_H.323%3F]]
* [[Howto:Innovaphones_public_services]]

= Known issues =
== Device provisioning doesn't work ==
Make sure that your device does not belong to a different domain. If the MAC address is already assigned to a different domain, the provisioning process is cancelled to prevent unauthorized domain moves.

Howto:Use bc conference object and push for smartphones

2026-06-18T15:33:24Z

Kpe:

==Applies To==
This information applies to
* PBX with firmware 12r2 or higher supporting push

==More Information==
General information about [https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects/Call_Broadcast_Conference| Call Broadcast Conference]

===Details===
The [https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects/Call_Broadcast_Conference| BC Conference Object] uses a group membership to call a group of users.

In case these users are smartphones, a special configuration is needed, because a BC Conference Call does NOT trigger the push mechanism.

To be able to call myApps clients on a Smartphones in the background or in standby mode, push is needed to trigger a call ringing on the smartphone.

===Problem===
A BC Conference call does '''NOT''' trigger the push mechanism.

===Solution===
A Waiting Queue call triggers the push mechanism.

===Configuration===
Make every smartphone user a group member of it's own dedicated waiting queue (static membership)

Make this dedicated waiting queu a static member of the BC Conference group and a static active member of this WQ-group.

=== Conclusion ===
Now it is possible to use Smartphones in a BC Conference group and receive BC Conference Calls on the myApps client in background or with the smartphone in standby modus.

== Related Articles ==

* [[Reference9:PBX/Objects/Call_Broadcast_Conference]]

* [[Howto13r1:Step-by-Step_Evacuation_alarm ]]

* [https://wiki.innovaphone.com/index.php?title=Howto:Use_soft_conference_interface_with_bc_conference_object| Howto:Use_soft_conference_interface_with_bc_conference_object ]

[[Category:Sample|{{PAGENAME}}]]
[[Category:Howto|{{PAGENAME}}]]

Howto:Use soft conference interface with bc conference object

2026-06-18T15:31:49Z

Kpe:

==Applies To==
This information applies to
* PBX with firmware with at least 13r1 sr13 or 13r2

==More Information==
General information about [https://wiki.innovaphone.com/index.php?title=Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported]

===Details===
In the past, BC conference ( https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects/Call_Broadcast_Conference ) were using the default conference interface or an external conference interface.

With the new v13, from 13r1 sr13, we can use soft conference channel together with the BC conference to make it works.

To do so, simply configure in the BC conference object, as hardware ID, macaddress-SCNF (for example, 0090330000-SCNF), where the mac address is the gateway were soft conference are available, and in the conference object, as hardware ID the same (for example, 0090330000-SCNF), and in the Devices tab, the same Hardware ID.

=== Conclusion ===
Now is possible to use soft conference also when configuring a BC conference object.

== Related Articles ==

* [[Reference9:PBX/Objects/Call_Broadcast_Conference]]

* [[Howto13r1:Step-by-Step_Evacuation_alarm ]]

* [https://wiki.innovaphone.com/index.php?title=Howto:Use_bc_conference_object_and_push_for_smartphones| Howto:Use_bc_conference_object_and_push_for_smartphones ]

[[Category:Sample|{{PAGENAME}}]]
[[Category:Howto|{{PAGENAME}}]]

Howto:Panic Button to trigger a Silent Alarm via Function Key on IP-Phone

2026-06-18T15:27:43Z

Kpe: /* Related Articles */

The following configuration based on BC Conference Object and a Function Key on an IP-Phone enables you to implement a panic button. The panic button triggers a silent alarm that is not noticeable on the triggering phone. The button can be used also if the phone is in an active call.

==Applies To==
This information applies to

*V10 SR10 PBX and later.



==More Information==
===Configuration===
; 1) Function Key: The functionality is based on the Function Key of type ''Dial'' that must be configured on the IP-Phone. The Option ''Send as Control Call'' must be activated on the Function Key the function is silent. As destination Number or Name must be a ''BC Conference'' Object.

<center>[[Image:Panic Button Silent Alarm 01.png]]</center> 

; 2) BC Conference : The ''BC Confernce Object'' takes care to call all the members of the alarm group. The ''BC Conference'' Object must be active in this group, all other members are passive in the group.

Generate a BC Conference Object with at least name (which is used in the F-Key above).
Not further settings needed here.

Considerations:

To provide an audio announcement to all members of the conference you have two possibilities:
* use a Waiting Queue with the ''1st Announcement URL'' as one of the conference members
** Pros: Ability to talk between each alarmed user while or after the announcement.
** Cons: Conference facility based on an innovaphone Gateway is required. Number of alarm group members is limited by the number of conference channels.
* connect all conference members to a HTTP-Interface broadcasting the announcement, instead to connect them to a real conference
** Pros: No conference facility hardware is required. Big number of alarm group members supported.
** Cons: No conversation possible between alarmed users.

; C1) BC Conference Variant 1 (real conference with an announcement at the beginning) :
Create a ''Waiting Queue'' Object with ''Alert Time'' set to 0 and only the ''1st Announcement URL'' configured. Place the ''Waiting Queue'' Object in to the group of the ''BC Conference'' Object.

<center>[[Image:Panic Button Silent Alarm 03.png]]</center> 

; C2) BC Conference Variant 2 (announcement only) : The difference to the previous configuration is to use the HTTP-Interface instead of CONF-Interface. To route all conference members to an announcement create a ''Gateway Object'' and register the HTTP-Interface on it.

<center>[[Image:Panic Button Silent Alarm 02.png]]</center> 
<center>[[Image:Panic Button Silent Alarm 04.png]]</center> 

Make sure you enable '#MOH Mode'' option to reduce load on the CPU - the same media stream will be played to all.
<center>[[Image:Panic Button Silent Alarm 07.png]]</center> 

This will create auto-generated routes in the relay:

<center>[[Image:Panic Button Silent Alarm 05.png]]</center> 

On the route from RWEB to HTTP add the URL to the announcement under ''Add UUI''. You can append <code>&repeat=true</code> to the URL in order to loop the announcement.

<center>[[Image:Panic Button Silent Alarm 06.png]]</center> 

== Related Articles ==

* [[Reference9:PBX/Objects/Call_Broadcast_Conference]]

* [[Howto13r1:Step-by-Step_Evacuation_alarm ]]

* [https://wiki.innovaphone.com/index.php?title=Howto:Use_bc_conference_object_and_push_for_smartphones| Howto:Use_bc_conference_object_and_push_for_smartphones ]

[[Category:Sample|{{PAGENAME}}]]
[[Category:Howto|{{PAGENAME}}]]

Howto:Use bc conference object and push for smartphones

2026-06-18T15:24:12Z

Kpe: /* Configuration */

Howto:Use bc conference object and push for smartphones

2026-06-18T15:23:27Z

Kpe: /* Applies To */

==Applies To==
This information applies to
* PBX with firmware 12r2 or higher supporting push

==More Information==
General information about [https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects/Call_Broadcast_Conference| Call Broadcast Conference]

===Details===
The [https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects/Call_Broadcast_Conference| BC Conference Object] uses a group membership to call a group of users.

In case these users are smartphones, a special configuration is needed, because a BC Conference Call does NOT trigger the push mechanism.

To be able to call myApps clients on a Smartphones in the background or in standby mode, push is needed to trigger a call ringing on the smartphone.

===Problem===
A BC Conference call does '''NOT''' trigger the push mechanism.

===Solution===
A Waiting Queue call triggers the push mechanism.

===Configuration===
Make every smartphone user a group member of it's own dedicated waiting queue (static membership)

Make this dedicated waiting queu a static member of the BC Conference group and an static active member of this WQ-group.

=== Conclusion ===
Now it is possible to use Smartphones in a BC Conference group and receive BC Conference Calls on the myApps client in background or with the smartphone in standby modus.

Howto:Panic Button to trigger a Silent Alarm via Function Key on IP-Phone

2026-06-18T15:21:02Z

Kpe: /* Related Articles */

The following configuration based on BC Conference Object and a Function Key on an IP-Phone enables you to implement a panic button. The panic button triggers a silent alarm that is not noticeable on the triggering phone. The button can be used also if the phone is in an active call.

==Applies To==
This information applies to

*V10 SR10 PBX and later.



==More Information==
===Configuration===
; 1) Function Key: The functionality is based on the Function Key of type ''Dial'' that must be configured on the IP-Phone. The Option ''Send as Control Call'' must be activated on the Function Key the function is silent. As destination Number or Name must be a ''BC Conference'' Object.

<center>[[Image:Panic Button Silent Alarm 01.png]]</center> 

; 2) BC Conference : The ''BC Confernce Object'' takes care to call all the members of the alarm group. The ''BC Conference'' Object must be active in this group, all other members are passive in the group.

Generate a BC Conference Object with at least name (which is used in the F-Key above).
Not further settings needed here.

Considerations:

To provide an audio announcement to all members of the conference you have two possibilities:
* use a Waiting Queue with the ''1st Announcement URL'' as one of the conference members
** Pros: Ability to talk between each alarmed user while or after the announcement.
** Cons: Conference facility based on an innovaphone Gateway is required. Number of alarm group members is limited by the number of conference channels.
* connect all conference members to a HTTP-Interface broadcasting the announcement, instead to connect them to a real conference
** Pros: No conference facility hardware is required. Big number of alarm group members supported.
** Cons: No conversation possible between alarmed users.

; C1) BC Conference Variant 1 (real conference with an announcement at the beginning) :
Create a ''Waiting Queue'' Object with ''Alert Time'' set to 0 and only the ''1st Announcement URL'' configured. Place the ''Waiting Queue'' Object in to the group of the ''BC Conference'' Object.

<center>[[Image:Panic Button Silent Alarm 03.png]]</center> 

; C2) BC Conference Variant 2 (announcement only) : The difference to the previous configuration is to use the HTTP-Interface instead of CONF-Interface. To route all conference members to an announcement create a ''Gateway Object'' and register the HTTP-Interface on it.

<center>[[Image:Panic Button Silent Alarm 02.png]]</center> 
<center>[[Image:Panic Button Silent Alarm 04.png]]</center> 

Make sure you enable '#MOH Mode'' option to reduce load on the CPU - the same media stream will be played to all.
<center>[[Image:Panic Button Silent Alarm 07.png]]</center> 

This will create auto-generated routes in the relay:

<center>[[Image:Panic Button Silent Alarm 05.png]]</center> 

On the route from RWEB to HTTP add the URL to the announcement under ''Add UUI''. You can append <code>&repeat=true</code> to the URL in order to loop the announcement.

<center>[[Image:Panic Button Silent Alarm 06.png]]</center> 

== Related Articles ==

* [[Reference9:PBX/Objects/Call_Broadcast_Conference]]

* [[Howto13r1:Step-by-Step_Evacuation_alarm ]]

* [[Howto:Use_bc_conference_object_and_push_for_smartphone ]]

[[Category:Sample|{{PAGENAME}}]]
[[Category:Howto|{{PAGENAME}}]]

Howto:Use bc conference object and push for smartphones

2026-06-18T15:20:51Z

Kpe: Created page with "==Applies To== This information applies to * PBX with firmware with at least 12r2 or higher supporting push  ==More Information== General information about [https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects/Call_Broadcast_Conference| Call Broadcast Conference] ===Details=== The [https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects/Call_Broadcast_Conference| BC Conference Object] uses a gro..."

==Applies To==
This information applies to
* PBX with firmware with at least 12r2 or higher supporting push

==More Information==
General information about [https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects/Call_Broadcast_Conference| Call Broadcast Conference]

===Details===
The [https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects/Call_Broadcast_Conference| BC Conference Object] uses a group membership to call a group of users.

In case these users are smartphones, a special configuration is needed, because a BC Conference Call does NOT trigger the push mechanism.

To be able to call myApps clients on a Smartphones in the background or in standby mode, push is needed to trigger a call ringing on the smartphone.

===Problem===
A BC Conference call does '''NOT''' trigger the push mechanism.

===Solution===
A Waiting Queue call triggers the push mechanism.

===Configuration===
Make every smartphone user a group member of it's own dedicated waiting queue (static membership)

Make this dedicated waiting queu a static member of the BC Conference group and an static active member of this WQ-group.

=== Conclusion ===
Now it is possible to use Smartphones in a BC Conference group and receive BC Conference Calls on the myApps client in background or with the smartphone in standby modus.

Reference16r1:Concept App Remote Control

2026-06-05T09:46:45Z

Kpe: /* General information */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]

== Applies to ==
* innovaphone PBX from version 16r1
== Requirements ==
* innovaphone PBX
* innovaphone Application Platform (minimum version 130015)
* V16r1
* Windows 10 and up
* Windows Server 2016 and later versions
* myApps launcher for Windows.
* Remote Control Client (portable .EXE) for external participants or Remote Control Client (installable .MSI) '''Note : in v16r1 the Remote Control Client is only available for Windows'''
* Additionally it is possible to join a session also via myApps opened in a web Browser

== Overview ==
Remote Control is an application to access a remote PC.
 The application can be used by the IT department to provide remote support or it could also be used as a collaborative tool for remote work.

== Licensing ==
* For the [[#Features|licensed features]] you will need to order the '''Service(innovaphone-remotecontrol)''' license, order number : ''02-00050-015''
* '''The application includes one session by default'''

== Installation ==
=== For new v16r1 installation ===
The Remote Control App is automatically installed by the installer and will be deployed in the '''Config User''' template. The service ID is activated and the address pre-configured
=== With the Settings App - AP app installer plug-in ===
[[File:Ap_app_installer.png|ap_app_installer.png/]]

Go to the Settings App and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown. ''Hint : if you access it for the first time, you will need to accept the "Terms of Use of the innovaphone App Store"''
* In the search field located on the top right corner of the store, search for '''"remote control"''' and click on it
* Select the proper firmware version, here '''"v16"''' and click on install
* Tick "I accept the terms of use" and continue by clicking on the install yellow button
* Wait until the install has been finished
* Close and open the Settings App to refresh the list of the available coloured AP plugin
* Click on the '''"AP remotecontrol"''' and click on '''" + Add an App"'''
* The '''"Name"''' display name field ''(all characters allowed)'' and the '''"SIP"''' administration field ''(no spaces, no capital letters)'' need to be filled. You can enter for example ''Remote Control/remotecontrol'' .
* Tick the appropriate template to distribute the App
* Enter the amount of purchased licenses
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good
* Additionally you can enter the users that are allowed to start a remote session in the '''"configuration"''' menu of the plug-in, enter name comma separated and allow the usage of IDs with the Remote Control Client (external application available in our store)

== Apps ==
=== Remote Control (remotecontrol) ===
This is the standard App within myApps for Remote Control.
Parameters of the App object:
;Websocket: Connection between the PBX and the App Platform. the App Platform receives the number of licences via this connection.
;PbxSignal: Protocol to register to the PBX and do signalling with the JSON signalling protocol (necessary to retrieve the TURN server data from the PBX)
;Admin: Used for the administration configuration available in the AP remotecontrol plugin
;PbxApi: App notification and presence monitoring of in-app user list

== Concept ==
[[Image: Rcrounded.png|rcrounded.png/]]

A user (viewer) sends a request to another user (sharer) to access the sharer's PC.
 The sharer accepts the session and begins to share their desktop with the viewer.
 The viewer is also automatically given control of the mouse and keyboard.

=== Features ===
Here are the features available in the Remote Control App
==== Included features ====
* One session between Remote control App opened within myApps
* Start a session with myApps started in a browser (no control possible of the PC that have myApps opened in a web browser)
* App notification to start a session
* Multiple monitor support: Viewers can switch between desktops by clicking on the monitor icons
* Direction of control: Change the direction of sharing, a viewer would become a sharer
''Note: if the viewer use myApps Remote Control App in a browser, the direction of control will not work since the browser has no interaction with the local operating system''
* Screen scaling: Two different views of the remote desktop, original size or resized
* Notifications: On the remote PC, if the sharer does not have the remote control open or is busy with another session, the person requesting a session will be notified within the Remote Control App
* Text copy & paste support in both directions
* Support for same keyboard layouts (e.g. QWERTY to QWERTY).
* Multi-viewer support: several viewer can join a sharer session

==== Licensed features ====
* Support of external participants via the [[#The Remote Control Client|Remote Control Client]]
* Administration configuration (available in the Settings App - AP remotecontrol plugin) such as : users that can start a session, usage of IDs code.
* Launch the Remote Control App and start a session with an URL.
* Share a session from the Remote Control App opened in myApps
* Multiple sessions: If you need more than one session (e.g. many viewers for one sharer, more than one parallel session)

=== Technical overview ===
[[Image:Remote-control_technical-overview.png|remote-control_technical-overview.png/]]
 ''Note: SCTP packets are routed through the TURN server and therefore the transmission is not peer-to-peer if the TURN server is selected from the ICE candidate.''

=== Technical data ===
*The maximum bitrate can reach '''8 Mbps''' if there is no packet loss. In case of packet loss, the bitrate is reduced, with a minimum of '''1 Mbps''' for the user who is sharing their desktop UI(sharer). The viewer only sends mouse and keyboard events.
* Remote Control App is using the SCTP protocol with a fix UDP port range between [https://wiki.innovaphone.com/index.php?title=Howto:What_Ports_are_used_for_Signaling_and_Voice_Traffic_in_SIP_and_H.323%3F#Application_Sharing_(RTP)| 50200-50299] within the myApps client. Same range as the Application Sharing feature
*The Remote Control Client uses the same port range.
*In order to communicate with the Central ID Service, port '''443''' is used. The Remote Control client and the myApps Remote Control app must be able to communicate externally via port 443.

=== Central ID service server ===
innovaphone provides a centrally hosted ID service that simplifies the establishment of sessions between the myApps Remote Control App and the Remote Control Client but also between myApps Remote Control Apps. The service is pre-configured in the Settings App, under the AP remotecontrol configuration menu, with the address '''remotecontrol.innovaphone.com'''.
It is possible to enable or disable this feature.

In few steps it is explained how does the flow works:
#The myApps Remote Control App or the Remote Control Client automatically generates an ID ''(ID is user based)''
#The sharer sends the ID to the viewer or the viewer send its ID to the sharer
#The viewer enters the ID into their myApps Remote Control App or the sharer enter the code in the Remote Control Client
#The viewer’s myApps Remote Control App or the sharer's Remote Control Client communicates with the ID service to transmit a session hash link
#The ID service forwards the session hash link to the sharer/viewer in order to establish the session
#The sharer receives a connection request notification that must be accepted
#Once the session request is accepted, the viewer can access the sharer’s PC
''Note: For the Remote Control Client, it is possible to enable auto-connect to bypass manual acceptance of the session, see the notes in the [[#The Remote Control Client| General information]] section of the respective clients'' 
''Note: For the Remote Control Client, the STUN/TURN server information stored in your Remote Control App service (running in your App Platform) is also transmitted within the hashlink.''

== The Remote Control Client ==
=== Portable version ===
==== General information====
The portable Remote Control Client allows you to establish a remote session with people who are not part of your myApps environment. E.g. external participants such as your customers. External participants share their screen to the the myApps users. In order to use IDs to start a session, the Remote Control Client and the myApps Remote Control App has a default connection to the central ID service hosted by innovaphone.
* Compatible with Windows only
* Users are notified via an in-app notification when a new version is available. The new version is downloaded from the client and need to be started afterwards
* No installation needed, simple light .exe file that can be started without admin right
* You can download the Remote Control Windows .EXE file by a given link from the person that want to take the control from his myApps client or directly in our [https://store.innovaphone.com/release/160A000/download.htm store] under the section software, item name is '''Remote Control Windows Portable'''
#Open the shared session link in a web browser to download the ''remoteControl.exe''
#Launch the app and enter your name (and any additional information, if desired)
#Provide the code to the viewer
#Accept the Remote session
''Note: Optionally enable or disable the admin session and auto-connect features, works with ID code only'' 
''Note: If you have entered the provided link or a code in the "Link or ID" field, click on "Join Session"'' 
'''Important:''' For the automatic connection, you will need to enter one or several codes separated by commas. This allows the Remote Control Client to be accessed automatically from different viewers, in that case, you will need to request one or several codes from the viewer and you do not need to click on the "Join Session" button.

==== Parameters available in the UI ====
;Your ID: ''Can be copied and given to the person that want to start a session with the portable client''
;Display Name: ''You can enter a name that will be used to notify the myApps Remote Control App''
;Additional information: ''Such as company name''
;Link or ID: ''If you start a session via link or a code, link or code is provided by the viewer that want to take the control''
;Join session: ''To establish a remote session when the link/ID code is previously entered''
;Admin Session on/off: ''Allow to start a session without having the administration right from the Windows user''
;Autoconnect on/off: ''Allow to start a session without being accepted by the Windows user, works only with ID codes''
''Note: When you activate auto connect, a new field is displayed. There, you can enter the codes used for the auto-connect feature. Multiple codes can be entered, separated by commas.''

=== Installable version ===
==== General information====
The installable Remote Control Client allows you to establish a remote session with people who are not part of your myApps environment. E.g. external participants such as your customers. External participants share their screen to the the myApps users. In order to use IDs to start a session, the Remote Control Client and the myApps Remote Control App has a default connection to the central ID service hosted by innovaphone.
*Compatible with Windows only
*Pop-up notification when a new version is available
*Silent update installation
*Auto start
*Fast installation (require the admin right), you can download the Remote Control Windows .MSI file in our [https://store.innovaphone.com/beta/download.htm store] under the section software, item name is '''Remote Control Windows'''
#Get the version of ''remoteControlSetup.msi'' on our store and install it
#Launch the app and enter your name (and any additional information, if desired)
#Provide the code to the viewer
#Accept the Remote session

==== Parameters available in the UI ====
;Your ID: ''Can be copied and given to the person that want to start a session with the installed client''
;Display Name: ''You can enter a name that will be used to notify the myApps Remote Control App''
;Additional information: ''Such as company name''
;Link or ID: ''If you start a session via link or a code, link or code is provided by the viewer that want to take the control''
;Autoconnect on/off: ''Allow to start a session without being accepted by the Windows user, works only with ID codes''
''Note: When you activate it, a new field is displayed. There, you can enter the codes used for the auto-connect feature. Multiple codes can be entered, separated by commas.''
;Join session: ''To establish a remote session when the link/ID code is previously entered''

==== Parameters available in the tray icon menu ====
When you do a right click on the tray icon it offers you the following possibilities
;Open trace folder: ''Fast access to the folder where the debug files are stored''
;Show in task bar: ''Pin the application to your Windows taskbar''
;Autostart: ''The application starts when you log in''
;Exit Remote Control: ''Close the application''

== Use Case scenario==
The table below presents the different options for starting a session, depending on the environment. it indicates also if a licence is required or not
 ''Description'':
*myApps launcher: Remote Control App used within the myApps launcher for Windows
*myApps browser: Remote Control App used within myApps running in a web browser
''Note: myApps can be used within the Microsoft Teams client and is therefore considered as a myApps browser''
*Remote Control Client: Windows portable or installable client that does not require myApps launcher to be running

{| class="wikitable"
|-
! Viewer !! Sharer !! License needed
|-
| myApps launcher || Remote Control client || yes
|-
| myApps browser || Remote Control client|| yes
|-
| myApps browser|| myApps launcher|| not for the 1st session
|-
| myApps launcher|| myApps launcher || not for the 1st session
|-
|}

== Troubleshooting ==
When you open a support ticket, you will be asked to provide us with debugging data of your issue. You can also send us screenshots/videos of the behaviour you are reporting. Do not forget to send us also the PBX default configuration file.

=== Trace flags of the App instance on the App Platform ===
Select the corresponding App instance of the Remote Control App service and click on the '''Diagnostics button'''. Tick the following trace flags:
*App
*Database

=== Trace flags of the myAPPS Client ===
Go to the myApps '''Burger menu''', click on '''more''', and then click the '''magnifying glass'''. Tick the following trace flag:
*AppSharing

=== Trace of the myAPPS opened in a browser ===
Open the dev console ''(F12)'' and get the generated logs, you can copy them in a txt file

=== Trace of the Remote Control Windows Client (portable) ===
Trace are available under (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the chromium log file, chromium + remoteControl txt files and zip them before sending to our support.

=== Trace of the Remote Control Windows Client (installable) ===
Do a right click on the app tray icon and click on open trace folder, get the chromium log file, chromium + remoteControl txt files and zip them before sending to our support.

== Known issues ==
*Push notifications on sharer's smartphone : if a viewer wants to start a remote session with a sharer who does not have the Remote Control App open on their PC, a push notification is triggered on the sharer's myApps mobile phone (if installed).

== Known limitations ==
*The language of the Remote Control Windows client is based on your operating system's language.
*Keyboards with different layouts are not supported yet (e.g. QWERTZ to QWERTY).

==Related Articles==
* [[{{NAMESPACE}}:Apps/PbxManager/App RemoteControl]] [[Category:Apps/PbxManager/App RemoteControl]]
*[[Howto:Innovaphones_public_services#Remote_Control_Central_ID_service]]

Reference16r1:Concept Push Notifications for iOS and Android

2026-05-27T12:46:03Z

Kpe: /* myApps for iOS push configuration checks */

[[Category:Concept|iOS Softwarephone]]
The PBX is able to send Push notifications to the Apple (APNs) or Android Push Notification services. As a result, incoming calls are also indicated when the myApps application is not started or runs in the background mode. The PBX is using a service provided by innovaphone AG at ''push.innovaphone.com'' to send the push notifications to the vendors Notification Service. No call meta data is transmitted, the push notification is only used to wake up the myApps application. Only one Push object is needed for a system.

== Requirements ==
=== PBX ===
* Firmware version 15r1 or higher
* Internet access via HTTPS
* device certificate (also on '''IPVA or AppIP''')
** this device certificate is not an own certificate, which you can upload yourself but which you need to retrieve through my.innovaphone (see [[#Initial configuration| Initial configuration]])!

=== Smartphone ===
* iOS Version 12.0.1 or higher
* Android Version 6.0 or higher

== Configuration ==
=== PBX ===
* verify that each pbx has the certificates <code>innovaphone Device Certification Authority 2</code> or the signed <code>push.innovaphone.com</code> in his local trust list. If you use the [[{{NAMESPACE}}:Concept App Service Devices#Certificates configuration|Devices - certificate trustlist concept]] the certificates will be installed automatically.
* create a PUSH object via the PBX manager,by clicking on the plugin Push (Black and White myApps symbol) The Plugin will create a PBX object in the PBX of type [[{{NAMESPACE}}:PBX/Objects/Push|Push]] per system, even in master/slave scenarios
** Name Push and SIP name push can be freely choosen, but the sip name must be used in the push field of user the objects. We advise leave the pre filled Standard names.
** the App URL must be <code>https://push.innovaphone.com/push/ws</code>
After clicking OK a green checkmark should appear, indicating that the Push object has a valid websocket connection to the innovaphone Push service.

=== User Objects ===
* For each user who is to receive push notifications on his myApps-application, the ''Name'' of the push-object must be entered in his userobject at the ''Push'' field in the ''User'' tab.

=== iOS specific settings ===
* On the iOS device make sure to allow push notifications for the myApps application.

=== Android specific settings ===

==How it works==
*First of all the mobile phone opens a connection to Apple or Google. If the phone is in a restricted Wi-Fi network (and has no GSM/LTE data connection to receive Push notifications), the appropriate ports of the firewall needs to opened as explained in the documentation of [https://support.apple.com/en-us/HT203609 apple] or [https://firebase.google.com/docs/cloud-messaging/concept-options#ports_and_your_firewall google].
*If the app is in the background and the user receives an incoming call, the App needs to be woken.
*Therefore the PBX sends a push request to innovaphones push servers (push.innovaphone.com)
*The communication is done with MTLS and our push servers check the client device certificate of the PBX
** the used certificate is the device certificate provided by innovaphone and not a certificate, which you can upload yourself
*push.innovaphone.com forwards the request to the Apple or Google Push service.
*The respective vendor sends the push request to the mobile phone and uses the ports opened in the first step.
*The app then registers at the PBX via H.323.
*In the last step the incoming call is sent (using the H.323 registration) to the mobile phone.

[[Image:push.gif|push.gif/|push.gif/]]

Note: the services.innovaphone.com in the picture must be replaced with push.innovaphone.com

=== Privacy ===
When using the Push service the PBX will send following data/information to [[Howto:Innovaphones public services|innovaphone]]:

* Notification Type (plain)
** ''call'' or ''notification''

* Detailed informations (enrypted)
** ''call''
*** number
*** name
*** callflow
** ''notification''
*** title
*** content

This information will send from the PBX to the Smartphone via the innovaphone Push-Service and forwarded to the Google/Apple push system. The Smartphone receives a decryption key via websocket or H323 (you have to use the secure version to transmit the key encrypted) from the PBX. Neither the push service at innovaphone nor the Apple / Google push system can read the encrypted information.

== Troubleshooting ==
=== Initial configuration ===
* Check the trust list for the certificate of the innovaphone AG.
* Make sure the PBX can resolve the DNS host ''push.innovaphone.com''.
* Make sure the PBX can reach ''push.innovaphone.com'' via HTTPS.
* Make sure that you have a innovaphone ''device certificate'' - even on '''IPVA or AppIP'''. The certificate is signed by ''innovaphone Device Certification Authority 2'' or on IPVA or AppIP since V14r1 by ''innovaphone Unverified Device CA''. If not, you can acquire a new one on the Gateway via [[{{NAMESPACE}}:General/License/my.innovaphone#Download_Certificate | General/License/my.innovaphone]]. '''This will not conflict with an existing certificate that you installed yourself on the gateway.'''
* Make sure the myApps application has Push Notifications allowed in the OS settings.
** iOS: Also make sure, the iOS device has a valid GSM data connection or a WiFi connection with the internet, especially TCP port 5223 (see [https://developer.apple.com/library/archive/technotes/tn2265/_index.html Troubleshooting Push Notifications] article by Apple).

=== Push looses connected state ===
* If the push object was already connected, and for some reason (after a firmware update or network connection problems), the object is not connected anymore, please check that PBX can reach and resolve "push.innovaphone.com" and the innovaphone AG certificate is still in the trust list.

===myApps for Android push configuration checks ===

[[Image:Troubleshoot_v13_Push_with_myApps_for_Android and iOS_1.jpg|troubleshoot_v13_push_with_myapps_for_android_and_ios_1.jpg/|troubleshoot_v13_push_with_myapps_for_android_and_ios_1.jpg/]]

Open myApps, and check you have a softphone app configured. Then tap on the "burger" menu on the top right, and check your default app is the softphone app.

Scroll down and tap on "More"
# Tap on "myApps events" and enable notification on the smartphone for myApps
# Tap on "Calling account" and enable myApps as call account
# Tap on "Data saver" and enable background data for myApps on the smartphone
# Tap on "Overlaying" and enable them on the smartphone

===myApps for iOS push configuration checks ===
Go through the following steps, to check that in your iPhone, Push is configured correctly.
#Open your iOS Settings app on your iPhone
#Go to the ''Notifications'' (German: Mitteilungen) section
#Find the myApps app and make sure notifications are allowed and that LockScreen, Notification Center and Banners are selected as Alerts 
For more information on howto enable Push notifications for an iOS-app, see also [https://support.apple.com/en-us/HT201925#If%20you%20don't%20see%20notifications%20for%20a%20specific%20app this Apple support page, section If you don't see notifications for a specific app]

Check the Apple's Full Immersion feature and make sure to allow the myApps App.

===innovaphone Push Service check===
Consult [https://status.innovaphone.com/ innovaphone services overview] to check if any unexpected service outage concerning push exists

== Known limitations ==
=== Number to Name resolution on Android Push Notifications could be missing ===
On incoming call Push Notification to Android the caller number will be included, if the Number to name resolution it's not yet finished no name will be included in this Push notification just the number. The Android doesn't allow a number/name update of that call afterwards so it will remain displaying only the number till we terminate the call. On iOS we don't have such issue since the system allows update of the number/name during call.

=== Push does work even when the myApps app is switched off ===
The Push mechanism will also work when the myApps app is turned off. This can lead to complains about receiving calls after working ours or during holidays.
With myApps as client, you can set the status to DND Do Not Disturb. Then close the myApps.
This will prevent the App to be started by the Push mechanism.
To receive calls again, open the myApps clients and set the status back to available.

You can disable the Push to the myApps by just ending the session for this device by logging out of the myApps application or Alternative you can go to the Hamburger Menu, Account Security and logout the active session.
You can also remove a session from another device for example a myApps Session from another Smartphone or browser.
Deselecting a default Softphone app, will also prevent the Push mechanism.

=== Customer uses HTTP-Proxy for Internet access ===
The WebSocket client does not support HTTP-Proxy connections, more specific HTTP Tunneling using HTTP CONNECT - therefore Push notifications will not work. See also: [[{{NAMESPACE}}:Services/HTTP/Client#Proxy_Servers|Reference15r1:Services/HTTP/Client#Proxy_Servers]]

=== BC Conference Object does NOT trigger the push mechanism ===
The BC Conference Object is not able to trigger the push mechanism for smartphone users. In case you want to have smartphone users as participants in your BC Conference Object, you need to use the following workaround:
* Create for every user a dedicated waiting queue object and add the smartphone user as only member to the group of this dedicated waiting queue.
* Instead of the user, you add the dedicated waiting queue as a member of the BC Conference Object group.
A BC Conference call will notify the dedicated waiting queue and the waiting queue will call the smartphone user which also triggers the push mechanism.

==Known issues==

===Cloning IPVA / AppIP===
If you clone an IPVA or AppIP with an existing device certificate, you'll also clone this certificate, so you'll have a wrong serial number inside the certificate afterwards. 
So '''do not clone''' IPVA or AppIP but setup a new VM and upload a modified configuration file afterwards and create a new certificate for the new machine.

Currently it is not possible to update or delete the device certificate.

== Related Articles ==
* [[Howto:Innovaphones_public_services]]

Template:HOWTOMOD13r2 Share files in FilesApp via Fileskey

2026-05-13T15:21:41Z

Kpe:

* in the ''Files'' App, click on the ''add folder'' symbol on the upper right
: [[Image:{{NAMESPACE}}-{{PAGENAME}}-Share files in FilesApp via Fileskey-create folder.png]]
 
* rename the new folder to ''{{{folder}}}''
: [[Image:{{NAMESPACE}}-{{PAGENAME}}-Share files in FilesApp via Fileskey-rename folder.png]]
 
* click on the ''Mark'' button on the upper right and make sure only the new ''{{{folder}}}'' folder is ticked
: [[Image:{{NAMESPACE}}-{{PAGENAME}}-Share files in FilesApp via Fileskey-select folder.png]]
 
* click on the ''right arrow'' button on the right
: [[Image:{{NAMESPACE}}-{{PAGENAME}}-Share files in FilesApp via Fileskey-share folder.png]]
 
* select ''share as link with filekey'' and leave all other fileds empty. Then click on ''Share''
: [[Image:{{NAMESPACE}}-{{PAGENAME}}-Share files in FilesApp via Fileskey-share2 folder.png]]
 
* open the new folder by clicking on the folder name ''{{{folder}}}''
: [[Image:{{NAMESPACE}}-{{PAGENAME}}-Share files in FilesApp via Fileskey-open folder.png]]
 
* copy all files (''{{{files}}}'') to the ''{{{folder}}}'' using drag-and-drop from the Windows-Explorer to the ''Files'' App
: [[Image:{{NAMESPACE}}-{{PAGENAME}}-Share files in FilesApp via Fileskey-copy files.png]]
 
* finally click on the little ''i'' symbol on the upper right. Take note of the link shown (you may want to copy it to a text file)
: [[Image:{{NAMESPACE}}-{{PAGENAME}}-Share files in FilesApp via Fileskey-share link.png]]
 
You will need the ''fileskey={{{fileskey}}}'' option later on as it allows access to the shared files in you ''{{{folder}}}''.

Howto16r1:Create Apps for websites to open in a new window

2026-05-13T14:27:43Z

Kpe: /* Create a Shared Folder in Files App */

[[Category:Howto]]
==Applies to==
* firmware version V16 and higher
* it might work also with older Verions but it is not tested!

==More Information==
Create apps for (external) websites to be opened in a new browser tab (Browser version of myApps) or to be opened in a new docked out myApps window (Native myApps Client).
To make this possible you are going to host a html file in a shared folder from the Files App.
This html file will be accessed and will open the required Website URL that has been passed with this URL in a new window.

==Configuration==

===html file to download===
[[https://wiki.innovaphone.com/images/c/cf/Redirect_kpe.zip redirect_kpe.zip]]

===Create a Shared Folder in Files App===

In case you need a detailed example howto create a shared folder, check this wiki: [https://wiki.innovaphone.com/index.php?title=Template:HOWTOMOD13r2_Share_files_in_FilesApp_via_Fileskey_-_Sample Files_App_example]

# Open the Files App, click on the add folder symbol on the upper right and create a new folder with the name '''''html'''''
# Click on the Mark button on the upper right and make sure only the new '''''html folder''''' is ticked
# Click on the right arrow button on the right and share this folder with the fileskey access,
# Select share as link with filekey and leave all other fileds empty. Then click on Share
# Open the new folder by clicking on the folder name '''''html-folder'''''
# Copy and paste the downloaded html file '''''redirect_kpe.html''''' to the '''''html-folder''''' using drag-and-drop from the Windows-Explorer to the Files App
# Copy and paste your optional icon files to the '''''html-folder''''' using drag-and-drop from the Windows-Explorer to the Files App
# Finally click on the little '''''i''''' symbol on the upper right. Take note of the link shown and copy it to a text file for later use.
# Change the URL in the textfile for your purpose according to this example. The URL contains the destination to the redirect html file, added with the destination URL for the website to be opened and attached the fileskey to allow the acces to this html-folder. Example: "<nowiki>https://your.AppDNSname.com/yoursystemname.com/files/UI/html/</nowiki>'''''redirect_kpe.html?url=<nowiki>https://yourdestination.com</nowiki>'''''&'''''fileskey=Y0UrS3cr3tK3Y1234''''' "

===Create the App Object===
# Navigate in PBX-AdvancedUI to PBX/Objects
# Choose object type ''App'' from left sided drop down and confirm with ''New''
# Define app-object-name and app-object-longname and confirm with ''Apply''
# switch to tab ''App''
# Insert the used URL based on the example above - see also some examples below
# Insert optional the icon URL - see how to create an icon in the section below
# tick ''plain website''
# confirm with ''OK''

===Create an App Icon (Optional)===
* Search and download respective logo or create it with a screenshot tool. Observe any copyrights and rights of use.
* Max. size of 100x100 px is sufficent. If not available in that size, shrink down by use of any common image editor
* Choose any appropriate Base 64 image encoder, upload the adapted logo and copy the resulting hex dump
* paste the hex dump content including leading <code>data:image/png;base64,</code>into field ''Icon (URL)''
* pay attention to the max supported size of 3072 characters. Shrink down your source image if necessary.
* exampl of the icon URL: https://yourAP-DNSname.com/yoursystemname.com/files/UI/html/youriconfilename.png&fileskey=Y0UrS3cr3tK3Y1234

===Grant access to users===
Tick respective App-Object-Name in ''Apps''-tab at user object or distributing configuration template object

===URL examples===
App html URL: https://your.AppDNSname.com/yoursystemname.com/files/UI/html/redirect_kpe.html? (followed by in theory any website URL that you want to use as the destination URL)
Some example listed:
* Here: <code>https://wego.here.com/p/here:cm:namedplace:20171588?map=48.71042,9.00612,13.24</code>
* Nextcloud: <code>https://nextcloud.com/</code>
* Karls: <code>https://www.karls.nl</code>
Followed by your Fileskey &fileskey=Y0UrS3cr3tK3Y1234

=== Web App example on the Community ===
If you want to see an example of this redirect Web App, go to the [https://community.innovaphone.com Community PBX] and go to the All Apps icon in the bottom right corner and add the URL Redirect App to your homescreen.

By opening this App it will open the redirect html file and after a timeout of 3 seconds it will open the innovaphone website about security in a new browser tab.

==Known issues==
* No known issues yet,
* Feel free to add if you find some

==Related articles==
* [[Reference13r1:PBX/Objects/App]]
* [[Reference13r2:Concept_Apps#App_Objects_Parameters]]
* [[Courseware:IT_Advanced_-_03_The_Application_Platform#App_objects]]
* [https://www.youtube.com/watch?v=vXgryhUik1U innovaphone video on how to integrate websites as apps]
* [https://www.base64-image.de/ Base 64 image encoder]

Howto16r1:Create Apps for websites to open in a new window

2026-05-13T14:26:49Z

Kpe: /* html file to download */

[[Category:Howto]]
==Applies to==
* firmware version V16 and higher
* it might work also with older Verions but it is not tested!

==More Information==
Create apps for (external) websites to be opened in a new browser tab (Browser version of myApps) or to be opened in a new docked out myApps window (Native myApps Client).
To make this possible you are going to host a html file in a shared folder from the Files App.
This html file will be accessed and will open the required Website URL that has been passed with this URL in a new window.

==Configuration==

===html file to download===
[[https://wiki.innovaphone.com/images/c/cf/Redirect_kpe.zip redirect_kpe.zip]]

===Create a Shared Folder in Files App===

In case you need a detailed example howto create a shared folder, check this wiki: [https://wiki.innovaphone.com/index.php?title=Template:HOWTOMOD13r2_Share_files_in_FilesApp_via_Fileskey_-_Sample Files_App_example]

# Open the Files App, click on the add folder symbol on the upper right and create a new folder with the name '''''html'''''
# Click on the Mark button on the upper right and make sure only the new '''''html folder''''' is ticked
# Click on the right arrow button on the right and share this folder with the fileskey access,
# Select share as link with filekey and leave all other fileds empty. Then click on Share
# Open the new folder by clicking on the folder name '''''html-folder'''''
# Copy and paste the downloaded html file '''''redirect_kpe.html''''' to the '''''html-folder''''' using drag-and-drop from the Windows-Explorer to the Files App
# Copy and paste your optional icon files to the '''''html-folder''''' using drag-and-drop from the Windows-Explorer to the Files App
# Finally click on the little '''''i''''' symbol on the upper right. Take note of the link shown and copy it to a text file for later use.
# Change the URL in the textfile for your purpose according to this example. The URL contains the destination to the redirect html file, added with the destination URL for the website to be opened and attached the fileskey to allow the acces to this html-folder. Example: "<nowiki>https://your.AppDNSname.com/yoursystemname.com/files/UI/html/</nowiki>'''''redirect_kpe.html?url=https://yourdestination.com'''''&'''''fileskey=Y0UrS3cr3tK3Y1234''''' "

===Create the App Object===
# Navigate in PBX-AdvancedUI to PBX/Objects
# Choose object type ''App'' from left sided drop down and confirm with ''New''
# Define app-object-name and app-object-longname and confirm with ''Apply''
# switch to tab ''App''
# Insert the used URL based on the example above - see also some examples below
# Insert optional the icon URL - see how to create an icon in the section below
# tick ''plain website''
# confirm with ''OK''

===Create an App Icon (Optional)===
* Search and download respective logo or create it with a screenshot tool. Observe any copyrights and rights of use.
* Max. size of 100x100 px is sufficent. If not available in that size, shrink down by use of any common image editor
* Choose any appropriate Base 64 image encoder, upload the adapted logo and copy the resulting hex dump
* paste the hex dump content including leading <code>data:image/png;base64,</code>into field ''Icon (URL)''
* pay attention to the max supported size of 3072 characters. Shrink down your source image if necessary.
* exampl of the icon URL: https://yourAP-DNSname.com/yoursystemname.com/files/UI/html/youriconfilename.png&fileskey=Y0UrS3cr3tK3Y1234

===Grant access to users===
Tick respective App-Object-Name in ''Apps''-tab at user object or distributing configuration template object

===URL examples===
App html URL: https://your.AppDNSname.com/yoursystemname.com/files/UI/html/redirect_kpe.html? (followed by in theory any website URL that you want to use as the destination URL)
Some example listed:
* Here: <code>https://wego.here.com/p/here:cm:namedplace:20171588?map=48.71042,9.00612,13.24</code>
* Nextcloud: <code>https://nextcloud.com/</code>
* Karls: <code>https://www.karls.nl</code>
Followed by your Fileskey &fileskey=Y0UrS3cr3tK3Y1234

=== Web App example on the Community ===
If you want to see an example of this redirect Web App, go to the [https://community.innovaphone.com Community PBX] and go to the All Apps icon in the bottom right corner and add the URL Redirect App to your homescreen.

By opening this App it will open the redirect html file and after a timeout of 3 seconds it will open the innovaphone website about security in a new browser tab.

==Known issues==
* No known issues yet,
* Feel free to add if you find some

==Related articles==
* [[Reference13r1:PBX/Objects/App]]
* [[Reference13r2:Concept_Apps#App_Objects_Parameters]]
* [[Courseware:IT_Advanced_-_03_The_Application_Platform#App_objects]]
* [https://www.youtube.com/watch?v=vXgryhUik1U innovaphone video on how to integrate websites as apps]
* [https://www.base64-image.de/ Base 64 image encoder]

Howto16r1:Create Apps for websites to open in a new window

2026-05-13T12:56:56Z

Kpe: /* html file to download */

[[Category:Howto]]
==Applies to==
* firmware version V16 and higher
* it might work also with older Verions but it is not tested!

==More Information==
Create apps for (external) websites to be opened in a new browser tab (Browser version of myApps) or to be opened in a new docked out myApps window (Native myApps Client).
To make this possible you are going to host a html file in a shared folder from the Files App.
This html file will be accessed and will open the required Website URL that has been passed with this URL in a new window.

==Configuration==

===html file to download===
[[https://wiki.innovaphone.com/images/c/cf/Redirect_kpe.zip]]

===Create a Shared Folder in Files App===

In case you need a detailed example howto create a shared folder, check this wiki: https://wiki.innovaphone.com/index.php?title=Template:HOWTOMOD13r2_Share_files_in_FilesApp_via_Fileskey_-_Sample

# Open the Files App, click on the add folder symbol on the upper right and create a new folder with the name '''''html'''''
# Click on the Mark button on the upper right and make sure only the new '''''html folder''''' is ticked
# Click on the right arrow button on the right and share this folder with the fileskey access,
# Select share as link with filekey and leave all other fileds empty. Then click on Share
# Open the new folder by clicking on the folder name '''''html-folder'''''
# Copy and paste the downloaded html file '''''redirect_kpe.html''''' to the '''''html-folder''''' using drag-and-drop from the Windows-Explorer to the Files App
# Copy and paste your optional icon files to the '''''html-folder''''' using drag-and-drop from the Windows-Explorer to the Files App
# Finally click on the little '''''i''''' symbol on the upper right. Take note of the link shown and copy it to a text file for later use.
# Change the URL in the textfile for your purpose according to this example. The URL contains the destination to the redirect html file, added with the destination URL for the website to be opened and attached the fileskey to allow the acces to this html-folder. Example: "https://your.AppDNSname.com/yoursystemname.com/files/UI/html/'''''redirect_kpe.html?url=https://''''' '''''yourdestination.com'''''&'''''fileskey=Y0UrS3cr3tK3Y1234''''' "

===Create the App Object===
# Navigate in PBX-AdvancedUI to PBX/Objects
# Choose object type ''App'' from left sided drop down and confirm with ''New''
# Define app-object-name and app-object-longname and confirm with ''Apply''
# switch to tab ''App''
# Insert the used URL based on the example above - see also some examples below
# Insert optional the icon URL - see how to create an icon in the section below
# tick ''plain website''
# confirm with ''OK''

===Create an App Icon (Optional)===
* Search and download respective logo or create it with a screenshot tool. Observe any copyrights and rights of use.
* Max. size of 100x100 px is sufficent. If not available in that size, shrink down by use of any common image editor
* Choose any appropriate Base 64 image encoder, upload the adapted logo and copy the resulting hex dump
* paste the hex dump content including leading <code>data:image/png;base64,</code>into field ''Icon (URL)''
* pay attention to the max supported size of 3072 characters. Shrink down your source image if necessary.
* exampl of the icon URL: https://yourAP-DNSname.com/yoursystemname.com/files/UI/html/youriconfilename.png&fileskey=Y0UrS3cr3tK3Y1234

===Grant access to users===
Tick respective App-Object-Name in ''Apps''-tab at user object or distributing configuration template object

===URL examples===
App html URL: https://your.AppDNSname.com/yoursystemname.com/files/UI/html/redirect_kpe.html? (followed by in theory any website URL that you want to use as the destination URL)
Some example listed:
* Here: <code>https://wego.here.com/p/here:cm:namedplace:20171588?map=48.71042,9.00612,13.24</code>
* Nextcloud: <code>https://nextcloud.com/</code>
* Karls: <code>https://www.karls.nl</code>
Followed by your Fileskey &fileskey=Y0UrS3cr3tK3Y1234

==Known issues==
* No known issues yet,
* Feel free to add if you find some

==Related articles==
* [[Reference13r1:PBX/Objects/App]]
* [[Reference13r2:Concept_Apps#App_Objects_Parameters]]
* [[Courseware:IT_Advanced_-_03_The_Application_Platform#App_objects]]
* [https://www.youtube.com/watch?v=vXgryhUik1U innovaphone video on how to integrate websites as apps]
* [https://www.base64-image.de/ Base 64 image encoder]

File:Redirect kpe.zip

2026-05-13T12:41:28Z

Kpe:

a html file that supports to open a website in a new window from a Web App.

Howto13r2:Create Apps for websites

2026-05-13T09:55:25Z

Kpe: /* More Information */

[[Category:Howto]]
==Applies to==
* firmware version 13r2 and higher

==More Information==
Create apps for (external) websites (that support iframe) to be opened within myApps

For websites that do not support iframe, there is a solution to open the website in a new window, see this wiki [[Howto16r1:Create Apps for websites to open in a new window]]

==Configuration==

===App Object===
# Navigate in PBX-AdvancedUI to PBX/Objects
# Choose object type ''App'' from left sided drop down and confirm with ''New''
# Define app-object-name and app-object-longname and confirm with ''Apply''
# switch to tab ''App''
# Insert used URL - see some examples below
# Insert optional icon URL - see how to create below
# tick ''plain website''
# confirm with ''OK''

===Icon (Optional)===
* Search and download respective logo. Observe any copyrights and rights of use.
* Max. size of 100x100 px is sufficent. If not available in that size, shrink down by use of any common image editor
* Choose any appropriate Base 64 image encoder, upload the adapted logo and copy the resulting hex dump
* paste the hex dump content including leading <code>data:image/png;base64,</code>into field ''Icon (URL)''
* pay attention to the max supported size of 3072 characters. Shrink down your source image if necessary.

===Grant access===
Tick respective App-Object-Name in ''Apps''-tab at user object or distributing configuration template object

===URL examples===
(as of November 2022):
* Here: <code>https://wego.here.com/</code>
* Google: <code>https://www.google.com/search?igu=1</code>
* YouTube: <code>https://www.youtube.com/embed/vXgryhUik1U?autoplay=1&controls=0&showinfo=0</code>

==Known issues==
* Websites that don't allow to be opened within an iframe/xframe environment. Some websites do support iframe only with additional parameters for iframe in the URL.
* Websites using iframes are not supported to be displayed via App-objects
* myApps-Launcher does not store passwords entered in websites
* no spell check support in forms

==Related articles==
* [[Reference13r1:PBX/Objects/App]]
* [[Reference13r2:Concept_Apps#App_Objects_Parameters]]
* [[Courseware:IT_Advanced_-_03_The_Application_Platform#App_objects]]
* [https://www.youtube.com/watch?v=vXgryhUik1U innovaphone video on how to integrate websites as apps]
* [https://www.base64-image.de/ Base 64 image encoder]

Howto16r1:Create Apps for websites to open in a new window

2026-05-13T09:50:18Z

Kpe: Created page with "Category:Howto ==Applies to== * firmware version V16 and higher * it might work also with older Verions but it is not tested! ==More Information== Create apps for (external) websites to be opened in a new browser tab (Browser version of myApps) or to be opened in a new docked out myApps window (Native myApps Client). To make this possible you are going to host a html file in a shared folder from the Files App. This html file will be accessed and will open the requ..."

[[Category:Howto]]
==Applies to==
* firmware version V16 and higher
* it might work also with older Verions but it is not tested!

==More Information==
Create apps for (external) websites to be opened in a new browser tab (Browser version of myApps) or to be opened in a new docked out myApps window (Native myApps Client).
To make this possible you are going to host a html file in a shared folder from the Files App.
This html file will be accessed and will open the required Website URL that has been passed with this URL in a new window.

==Configuration==

===html file to download===

===Create a Shared Folder in Files App===

In case you need a detailed example howto create a shared folder, check this wiki: https://wiki.innovaphone.com/index.php?title=Template:HOWTOMOD13r2_Share_files_in_FilesApp_via_Fileskey_-_Sample

# Open the Files App, click on the add folder symbol on the upper right and create a new folder with the name '''''html'''''
# Click on the Mark button on the upper right and make sure only the new '''''html folder''''' is ticked
# Click on the right arrow button on the right and share this folder with the fileskey access,
# Select share as link with filekey and leave all other fileds empty. Then click on Share
# Open the new folder by clicking on the folder name '''''html-folder'''''
# Copy and paste the downloaded html file '''''redirect_kpe.html''''' to the '''''html-folder''''' using drag-and-drop from the Windows-Explorer to the Files App
# Copy and paste your optional icon files to the '''''html-folder''''' using drag-and-drop from the Windows-Explorer to the Files App
# Finally click on the little '''''i''''' symbol on the upper right. Take note of the link shown and copy it to a text file for later use.
# Change the URL in the textfile for your purpose according to this example. The URL contains the destination to the redirect html file, added with the destination URL for the website to be opened and attached the fileskey to allow the acces to this html-folder. Example: "https://your.AppDNSname.com/yoursystemname.com/files/UI/html/'''''redirect_kpe.html?url=https://''''' '''''yourdestination.com'''''&'''''fileskey=Y0UrS3cr3tK3Y1234''''' "

===Create the App Object===
# Navigate in PBX-AdvancedUI to PBX/Objects
# Choose object type ''App'' from left sided drop down and confirm with ''New''
# Define app-object-name and app-object-longname and confirm with ''Apply''
# switch to tab ''App''
# Insert the used URL based on the example above - see also some examples below
# Insert optional the icon URL - see how to create an icon in the section below
# tick ''plain website''
# confirm with ''OK''

===Create an App Icon (Optional)===
* Search and download respective logo or create it with a screenshot tool. Observe any copyrights and rights of use.
* Max. size of 100x100 px is sufficent. If not available in that size, shrink down by use of any common image editor
* Choose any appropriate Base 64 image encoder, upload the adapted logo and copy the resulting hex dump
* paste the hex dump content including leading <code>data:image/png;base64,</code>into field ''Icon (URL)''
* pay attention to the max supported size of 3072 characters. Shrink down your source image if necessary.
* exampl of the icon URL: https://yourAP-DNSname.com/yoursystemname.com/files/UI/html/youriconfilename.png&fileskey=Y0UrS3cr3tK3Y1234

===Grant access to users===
Tick respective App-Object-Name in ''Apps''-tab at user object or distributing configuration template object

===URL examples===
App html URL: https://your.AppDNSname.com/yoursystemname.com/files/UI/html/redirect_kpe.html? (followed by in theory any website URL that you want to use as the destination URL)
Some example listed:
* Here: <code>https://wego.here.com/p/here:cm:namedplace:20171588?map=48.71042,9.00612,13.24</code>
* Nextcloud: <code>https://nextcloud.com/</code>
* Karls: <code>https://www.karls.nl</code>
Followed by your Fileskey &fileskey=Y0UrS3cr3tK3Y1234

==Known issues==
* No known issues yet,
* Feel free to add if you find some

==Related articles==
* [[Reference13r1:PBX/Objects/App]]
* [[Reference13r2:Concept_Apps#App_Objects_Parameters]]
* [[Courseware:IT_Advanced_-_03_The_Application_Platform#App_objects]]
* [https://www.youtube.com/watch?v=vXgryhUik1U innovaphone video on how to integrate websites as apps]
* [https://www.base64-image.de/ Base 64 image encoder]

Howto13r2:Create Apps for websites

2026-05-13T08:17:51Z

Kpe: /* More Information */

[[Category:Howto]]
==Applies to==
* firmware version 13r2 and higher

==More Information==
Create apps for (external) websites to be opened within myApps

==Configuration==

===App Object===
# Navigate in PBX-AdvancedUI to PBX/Objects
# Choose object type ''App'' from left sided drop down and confirm with ''New''
# Define app-object-name and app-object-longname and confirm with ''Apply''
# switch to tab ''App''
# Insert used URL - see some examples below
# Insert optional icon URL - see how to create below
# tick ''plain website''
# confirm with ''OK''

===Icon (Optional)===
* Search and download respective logo. Observe any copyrights and rights of use.
* Max. size of 100x100 px is sufficent. If not available in that size, shrink down by use of any common image editor
* Choose any appropriate Base 64 image encoder, upload the adapted logo and copy the resulting hex dump
* paste the hex dump content including leading <code>data:image/png;base64,</code>into field ''Icon (URL)''
* pay attention to the max supported size of 3072 characters. Shrink down your source image if necessary.

===Grant access===
Tick respective App-Object-Name in ''Apps''-tab at user object or distributing configuration template object

===URL examples===
(as of November 2022):
* Here: <code>https://wego.here.com/</code>
* Google: <code>https://www.google.com/search?igu=1</code>
* YouTube: <code>https://www.youtube.com/embed/vXgryhUik1U?autoplay=1&controls=0&showinfo=0</code>

==Known issues==
* Websites that don't allow to be opened within an iframe/xframe environment. Some websites do support iframe only with additional parameters for iframe in the URL.
* Websites using iframes are not supported to be displayed via App-objects
* myApps-Launcher does not store passwords entered in websites
* no spell check support in forms

==Related articles==
* [[Reference13r1:PBX/Objects/App]]
* [[Reference13r2:Concept_Apps#App_Objects_Parameters]]
* [[Courseware:IT_Advanced_-_03_The_Application_Platform#App_objects]]
* [https://www.youtube.com/watch?v=vXgryhUik1U innovaphone video on how to integrate websites as apps]
* [https://www.base64-image.de/ Base 64 image encoder]

Howto13r2:Create Apps for websites

2026-05-13T08:16:05Z

Kpe: /* Known issues */

[[Category:Howto]]
==Applies to==
* firmware version 13r2 and higher

==More Information==
Create apps for (external) websites

==Configuration==

===App Object===
# Navigate in PBX-AdvancedUI to PBX/Objects
# Choose object type ''App'' from left sided drop down and confirm with ''New''
# Define app-object-name and app-object-longname and confirm with ''Apply''
# switch to tab ''App''
# Insert used URL - see some examples below
# Insert optional icon URL - see how to create below
# tick ''plain website''
# confirm with ''OK''

===Icon (Optional)===
* Search and download respective logo. Observe any copyrights and rights of use.
* Max. size of 100x100 px is sufficent. If not available in that size, shrink down by use of any common image editor
* Choose any appropriate Base 64 image encoder, upload the adapted logo and copy the resulting hex dump
* paste the hex dump content including leading <code>data:image/png;base64,</code>into field ''Icon (URL)''
* pay attention to the max supported size of 3072 characters. Shrink down your source image if necessary.

===Grant access===
Tick respective App-Object-Name in ''Apps''-tab at user object or distributing configuration template object

===URL examples===
(as of November 2022):
* Here: <code>https://wego.here.com/</code>
* Google: <code>https://www.google.com/search?igu=1</code>
* YouTube: <code>https://www.youtube.com/embed/vXgryhUik1U?autoplay=1&controls=0&showinfo=0</code>

==Known issues==
* Websites that don't allow to be opened within an iframe/xframe environment. Some websites do support iframe only with additional parameters for iframe in the URL.
* Websites using iframes are not supported to be displayed via App-objects
* myApps-Launcher does not store passwords entered in websites
* no spell check support in forms

==Related articles==
* [[Reference13r1:PBX/Objects/App]]
* [[Reference13r2:Concept_Apps#App_Objects_Parameters]]
* [[Courseware:IT_Advanced_-_03_The_Application_Platform#App_objects]]
* [https://www.youtube.com/watch?v=vXgryhUik1U innovaphone video on how to integrate websites as apps]
* [https://www.base64-image.de/ Base 64 image encoder]

Howto13r2:Create Apps for websites

2026-05-13T08:14:42Z

Kpe: added known issue

[[Category:Howto]]
==Applies to==
* firmware version 13r2 and higher

==More Information==
Create apps for (external) websites

==Configuration==

===App Object===
# Navigate in PBX-AdvancedUI to PBX/Objects
# Choose object type ''App'' from left sided drop down and confirm with ''New''
# Define app-object-name and app-object-longname and confirm with ''Apply''
# switch to tab ''App''
# Insert used URL - see some examples below
# Insert optional icon URL - see how to create below
# tick ''plain website''
# confirm with ''OK''

===Icon (Optional)===
* Search and download respective logo. Observe any copyrights and rights of use.
* Max. size of 100x100 px is sufficent. If not available in that size, shrink down by use of any common image editor
* Choose any appropriate Base 64 image encoder, upload the adapted logo and copy the resulting hex dump
* paste the hex dump content including leading <code>data:image/png;base64,</code>into field ''Icon (URL)''
* pay attention to the max supported size of 3072 characters. Shrink down your source image if necessary.

===Grant access===
Tick respective App-Object-Name in ''Apps''-tab at user object or distributing configuration template object

===URL examples===
(as of November 2022):
* Here: <code>https://wego.here.com/</code>
* Google: <code>https://www.google.com/search?igu=1</code>
* YouTube: <code>https://www.youtube.com/embed/vXgryhUik1U?autoplay=1&controls=0&showinfo=0</code>

==Known issues==
* Websites that don't allow to be opened within an iframe/xframe environment
* Websites using iframes are not supported to be displayed via App-objects
* myApps-Launcher does not store passwords entered in websites
* no spell check support in forms

==Related articles==
* [[Reference13r1:PBX/Objects/App]]
* [[Reference13r2:Concept_Apps#App_Objects_Parameters]]
* [[Courseware:IT_Advanced_-_03_The_Application_Platform#App_objects]]
* [https://www.youtube.com/watch?v=vXgryhUik1U innovaphone video on how to integrate websites as apps]
* [https://www.base64-image.de/ Base 64 image encoder]

Howto:Algo 8301 IP Paging Adapter - Algo - 3rd Party Product

2026-04-28T08:33:57Z

Kpe: /* innovaphone WebRTC ready */

[[Image:AlgosolutionsLogo.png|200px|right|/AlgosolutionsLogo.png|algosolutionslogo.png/]]
==Product Name==
Algo [https://www.algosolutions.com/product/8301-ip-paging-adapter-scheduler/ 8301 IP Paging Adapter & Scheduler]

==Certification Status==

{{Template:Compat_Status_referral_terminals|manufacturername=Algo Communication Products Ltd.|certificationdate=in April 2026}}

==Category==

[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty Terminal Devices|{{PAGENAME}}]]

==Vendor==
'''Algo Communication Products Ltd.''' is a manufacturer of network-based IP endpoints for voice paging, emergency alerting, visual notification, intercom, and secure door entry applications. Algo products are designed for integration with unified communications, collaboration, and mass notification platforms. The company’s portfolio includes IP speakers, paging adapters, intercoms, visual alerters, display speakers, and endpoint management tools for commercial, education, healthcare, transportation, and industrial environments.

==Description==
The Algo 8301 IP Paging Adapter & Scheduler is a wideband SIP paging adapter designed to connect traditional analog amplifiers and legacy paging infrastructure to modern IP-based communication environments.

The 8301 emulates a page port similar to what is found on a legacy PBX or key system, allowing a traditional amplifier to be integrated into a VoIP or unified communications environment. This enables organizations to retain existing analog speaker infrastructure while adding SIP paging, multicast distribution, scheduled bells, automated announcements, emergency notifications, and other IP-based communication capabilities.

The device includes a balanced and isolated line output to reduce hum and noise when connected to an amplifier, and it also supports multicast audio transmission to additional Algo IP endpoints and compatible multicast-enabled phones. The 8301 is appropriate for education, retail, manufacturing, transportation, healthcare, and other environments where hybrid analog and IP paging is required.

==Functions==
The '''Algo 8301 IP Paging Adapter & Scheduler''' supports a range of functions for paging, alerting, scheduling, and hybrid analog/IP deployments.

Core functions include:
* SIP-based voice paging through registration as a 3rd-party SIP endpoint
* Integration of traditional analog amplifiers into IP and UC environments
* Scheduled bells, tones, and automated announcements synchronized to NTP
* Emergency, safety, security, and customer service audio notifications
* Multicast transmission to Algo IP speakers, paging adapters, display speakers, and compatible multicast-enabled phones
* Ring, page, and alert extension support
* Relay input and relay output support for connected accessories and external triggers
* Music input and background audio distribution
* Web interface configuration and centralized provisioning support

The 8301 can be deployed either as a SIP extension or as a multicast endpoint, depending on the communication design. In hybrid systems, it can provide local analog paging output while simultaneously distributing audio to IP endpoints over the network.

==innovaphone CTI ready==
n.a.

==innovaphone Reverse Proxy ready==
'''Yes.''' Testing was performed in an innovaphone myApps Cloud environment using registration via the cloud reverse proxy. In the innovaphone user object, the hardware ID must match the Authentication ID configured on the Algo device, and Reverse Proxy plus Media Relay must be enabled. The validated setup used STUN, while TURN and ICE were not used. SIP over TCP was validated. SIP over UDP and SIP over TLS were available but not fully validated in this test case.

* STUN yes
* TURN no
* ICE no
* SIP/TCP yes
* SIP UDP yes (not tested)
* SIP/TLS yes (not tested)

==innovaphone WebRTC ready==
yes, the device supports SRTP, SDES-DTLS

==Supported Codecs==

* G.722 yes
* G.711 A-law yes
* G.711 u-law yes

==DTMF Support==


* RTP DTMF (RFC2833)

==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==



==Support LDAP Phonebook==
n.a.

==Version==
Product versions used for interop testing:

* Algo 8301 IP Paging Adapter & Scheduler
* Algo 8186 SIP Horn
* Algo 8180 SIP Audio Alerter (G2)
* Algo 8128 (G2) SIP Strobe Light
* Algo 8201 SIP PoE Intercom

* Algo firmware requirement: version 5.4 or later

* innovaphone firmware / software version: innovaphone myApps Cloud IPVA, V15r1sr11

These devices represent Algo IP speakers, paging adapters, visual alerters, and door phones, and similar registration steps apply across Algo SIP endpoints.

==Configuration==
Algo SIP endpoints can register to innovaphone as 3rd-party SIP endpoints for voice paging, loud ringing, emergency alerting, visual notification, and secure door entry.

Interoperability testing was conducted using the Algo 8301 IP Paging Adapter & Scheduler, 8186 SIP Horn, 8180 SIP Audio Alerter (G2), 8128 (G2) SIP Strobe Light, and 8201 SIP PoE Intercom. These represent Algo IP speakers, paging adapters, visual alerters, and door phones, and similar registration steps apply to all devices.

=== '''Algo firmware requirements''' ===
All Algo devices must be running firmware version 5.4 or later. The current firmware version can be verified on the device and can be updated in '''System -> Firmware''' tab.

=== '''Algo device configuration''' ===

# Log in to the Algo device web interface. The device's IP address can be found by using an IP scanner tool such as [https://angryip.org/ Angry IP Scanne]r which is free and open-source.
# Go to '''Basic Settings -> SIP'''.
## [[File:Algo SIP Settings.png|none|thumb|/Algo_SIP_Settings.png|algo_sip_settings.png/]]
# Enter the SIP credentials under '''Base/Page''' using the values from innovaphone dashboard:
#* '''SIP Domain (Proxy Server):''' innovaphone System ID
#* '''SIP Extension:''' extension from innovaphone
#* '''Authentication ID:''' SIP username from innovaphone
#* '''Authentication Password:''' SIP password from innovaphone
# Select '''Save'''.
# Go to '''Advanced Settings -> Advanced SIP'''.
# Set '''SIP Transportation''' to '''TCP'''.
# Set the '''Outbound Proxy''' to the DNS name of the innovaphone system. Example: '''algosolutions-p.innovaphone.com'''
# Set '''SDP SRTP''' to '''Optional''' and '''AES CM 128 HMAC SHA1 80'''.
# Set '''STUN''' to '''stun.innovaphone.com'''.
# Select '''Save'''.
## [[File:AlgoSIPSettings2.png|none|thumb|/AlgoSIPSettings2.png|algosipsettings2.png/]]
#Go to the '''Status''' tab and verify that the configured extensions have registered correctly.
[[File:AlgoSIPConfirmation.png|none|thumb|473x473px|/AlgoSIPConfirmation.png|algosipconfirmation.png/]]

=== '''Configuration of the innovaphone user objects in innovaphone myApps''' ===

# Open the '''Users Admin App'''.
# [[File:UsersAdmin.png|thumb|none|/UsersAdmin.png|usersadmin.png/]]
# Create the user account for the Algo device. In this example we created a User account for Algo8180 and Algo8181.
# In the '''Devices''' table of the user account, make sure the '''hardware ID''' is the same as the '''Authentication ID''' used in the Algo device.
# Ensure that '''Reverse Proxy''' and '''Media Relay''' are enabled.
# [[File:Innovaphone Config Status.png|none|thumb|400x400px|/Innovaphone_Config_Status.png|innovaphone_config_status.png/]]
# [[File:Status Confirmation.png|none|thumb|402x402px|/Status_Confirmation.png|status_confirmation.png/]]
# Or, if preferred, the configuration can also be completed using the Advanced GUI, as shown in the example below.
# [[File:Innovaphone Config Status2.png|none|thumb|418x418px|/Innovaphone_Config_Status2.png|innovaphone_config_status2.png/]]
# Registration of the Algo device can then be checked within the innovaphone system.
# [[File:Innovaphone Config Status using GUI.png|none|thumb|400x400px|/Innovaphone_Config_Status_using_GUI.png|innovaphone_config_status_using_gui.png/]]
The same SIP registration workflow applies across Algo IP speakers, paging adapters, visual alerters, and intercoms. Device-specific behaviour and options depend on the endpoint and deployment.

==Summary==
Algo SIP endpoints can integrate with innovaphone as 3rd-party SIP endpoints across key endpoint categories, including paging adapters, IP speakers, visual alerters, and intercoms.

Interoperability in this validation scope was performed using the Algo 8301, 8186, 8180, 8128, and 8201. Similar SIP registration steps apply across these devices, with product-specific options such as analog paging output, multicast, visual alerting, door entry, or local audio behaviour configured according to the endpoint type.

==Contact==
{|
| Algo Communication Products Ltd.
|-
| Burnaby, BC, Canada
|-
| Tel: +1 604-454-3790
|-
| Support: +1 604-454-3792
|-
| Mail: [mailto:info@algosolutions.com info@algosolutions.com]
|}

For additional information please refer to [https://www.algosolutions.com/contact-us/ our contact page].

Howto:Algo 8301 IP Paging Adapter - Algo - 3rd Party Product

2026-04-15T10:18:37Z

Kpe: /* Certification Status */

[[Image:AlgosolutionsLogo.png|200px|right|algosolutionslogo.png/|algosolutionslogo.png/]]
==Product Name==
Algo [https://www.algosolutions.com/product/8301-ip-paging-adapter-scheduler/ 8301 IP Paging Adapter & Scheduler]

==Certification Status==


==Category==

[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty Terminal Devices|{{PAGENAME}}]]

==Vendor==
Algo Communication Products Ltd. is a manufacturer of network-based IP endpoints for voice paging, emergency alerting, visual notification, intercom, and secure door entry applications. Algo products are designed for integration with unified communications, collaboration, and mass notification platforms. The company’s portfolio includes IP speakers, paging adapters, intercoms, visual alerters, display speakers, and endpoint management tools for commercial, education, healthcare, transportation, and industrial environments.

==Description==
The Algo 8301 IP Paging Adapter & Scheduler is a wideband SIP paging adapter designed to connect traditional analog amplifiers and legacy paging infrastructure to modern IP-based communication environments.

The 8301 emulates a page port similar to what is found on a legacy PBX or key system, allowing a traditional amplifier to be integrated into a VoIP or unified communications environment. This enables organizations to retain existing analog speaker infrastructure while adding SIP paging, multicast distribution, scheduled bells, automated announcements, emergency notifications, and other IP-based communication capabilities.

The device includes a balanced and isolated line output to reduce hum and noise when connected to an amplifier, and it also supports multicast audio transmission to additional Algo IP endpoints and compatible multicast-enabled phones. The 8301 is appropriate for education, retail, manufacturing, transportation, healthcare, and other environments where hybrid analog and IP paging is required.

==Functions==
The Algo 8301 IP Paging Adapter & Scheduler supports a range of functions for paging, alerting, scheduling, and hybrid analog/IP deployments.

Core functions include:
* SIP-based voice paging through registration as a 3rd-party SIP endpoint
* Integration of traditional analog amplifiers into IP and UC environments
* Scheduled bells, tones, and automated announcements synchronized to NTP
* Emergency, safety, security, and customer service audio notifications
* Multicast transmission to Algo IP speakers, paging adapters, display speakers, and compatible multicast-enabled phones
* Ring, page, and alert extension support
* Relay input and relay output support for connected accessories and external triggers
* Music input and background audio distribution
* Web interface configuration and centralized provisioning support

The 8301 can be deployed either as a SIP extension or as a multicast endpoint, depending on the communication design. In hybrid systems, it can provide local analog paging output while simultaneously distributing audio to IP endpoints over the network.

==innovaphone CTI ready==
n.a.

==innovaphone Reverse Proxy ready==
Yes, the tests has been performed on an innovaphone myApps Cloud environment with registration via the cloud reverse proxy. In the innovaphone PBX onn the users object hardware ID, media relay needs to be activated.

* STUN yes
* TURN no
* ICE no
* SIP/TCP yes
* SIP UDP yes (not tested)
* SIP/TLS yes (not tested)

==innovaphone WebRTC ready==
n.a.

==Supported Codecs==

* G.722 yes
* G.711 A-law yes
* G.711 u-law yes

==DTMF Support==


* RTP DTMF (RFC2833)

==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==



==Support LDAP Phonebook==
n.a.

==Version==
Product versions used for interop testing:
* Algo 8301 IP Paging Adapter & Scheduler: version to be confirmed!
* innovaphone firmware / software version: innovaphone myApps Cloud IPVA, V15r1sr11

==Configuration==
Configuration details will be completed based on the validated test setup.

The planned configuration section will include:
* innovaphone-side SIP configuration
* Algo 8301 SIP registration settings
* paging behavior and extension mapping
* multicast settings, if used
* audio output connection to amplifier
* relay input / output use, if applicable
* any deployment notes, limitations, or prerequisites identified during testing

==Summary==
The Algo 8301 IP Paging Adapter & Scheduler provides a practical bridge between legacy analog paging infrastructure and modern IP-based communication systems. It enables organizations to preserve existing amplifier and speaker investments while adding SIP paging, scheduling, multicast distribution, and emergency notification capabilities. Final interoperability details with innovaphone will be updated after test validation and configuration review.

==Contact==
{|
| Algo Communication Products Ltd.
|-
| Contact Name: to be confirmed
|-
| Burnaby, BC, Canada
|-
| Tel: +1 604-454-3790
|-
| Support: +1 604-454-3792
|-
| Mail: [mailto:info@algosolutions.com info@algosolutions.com]
|}

For additional information please refer to [https://www.algosolutions.com/contact-us/ our contact page].

Howto:Algo 8301 IP Paging Adapter - Algo - 3rd Party Product

2026-04-15T09:43:47Z

Kpe: /* innovaphone Reverse Proxy ready */

[[Image:AlgosolutionsLogo.png|200px|right|algosolutionslogo.png/|algosolutionslogo.png/]]
==Product Name==
Algo [https://www.algosolutions.com/product/8301-ip-paging-adapter-scheduler/ 8301 IP Paging Adapter & Scheduler]

==Certification Status==


==Category==

[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty Terminal Devices|{{PAGENAME}}]]

==Vendor==
Algo Communication Products Ltd. is a manufacturer of network-based IP endpoints for voice paging, emergency alerting, visual notification, intercom, and secure door entry applications. Algo products are designed for integration with unified communications, collaboration, and mass notification platforms. The company’s portfolio includes IP speakers, paging adapters, intercoms, visual alerters, display speakers, and endpoint management tools for commercial, education, healthcare, transportation, and industrial environments.

==Description==
The Algo 8301 IP Paging Adapter & Scheduler is a wideband SIP paging adapter designed to connect traditional analog amplifiers and legacy paging infrastructure to modern IP-based communication environments.

The 8301 emulates a page port similar to what is found on a legacy PBX or key system, allowing a traditional amplifier to be integrated into a VoIP or unified communications environment. This enables organizations to retain existing analog speaker infrastructure while adding SIP paging, multicast distribution, scheduled bells, automated announcements, emergency notifications, and other IP-based communication capabilities.

The device includes a balanced and isolated line output to reduce hum and noise when connected to an amplifier, and it also supports multicast audio transmission to additional Algo IP endpoints and compatible multicast-enabled phones. The 8301 is appropriate for education, retail, manufacturing, transportation, healthcare, and other environments where hybrid analog and IP paging is required.

==Functions==
The Algo 8301 IP Paging Adapter & Scheduler supports a range of functions for paging, alerting, scheduling, and hybrid analog/IP deployments.

Core functions include:
* SIP-based voice paging through registration as a 3rd-party SIP endpoint
* Integration of traditional analog amplifiers into IP and UC environments
* Scheduled bells, tones, and automated announcements synchronized to NTP
* Emergency, safety, security, and customer service audio notifications
* Multicast transmission to Algo IP speakers, paging adapters, display speakers, and compatible multicast-enabled phones
* Ring, page, and alert extension support
* Relay input and relay output support for connected accessories and external triggers
* Music input and background audio distribution
* Web interface configuration and centralized provisioning support

The 8301 can be deployed either as a SIP extension or as a multicast endpoint, depending on the communication design. In hybrid systems, it can provide local analog paging output while simultaneously distributing audio to IP endpoints over the network.

==innovaphone CTI ready==
n.a.

==innovaphone Reverse Proxy ready==
Yes, the tests has been performed on an innovaphone myApps Cloud environment with registration via the reverse proxy. On the innovaphone users object hardware ID, media relay was activated.

* STUN yes
* TURN no
* ICE no
* SIP/TCP yes
* SIP UDP yes (not tested)
* SIP/TLS yes (not tested)

==innovaphone WebRTC ready==
n.a.

==Supported Codecs==

* G.722 yes
* G.711 A-law yes
* G.711 u-law yes

==DTMF Support==


* RTP DTMF (RFC2833)

==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==



==Support LDAP Phonebook==
n.a.

==Version==
Product versions used for interop testing:
* Algo 8301 IP Paging Adapter & Scheduler: version to be confirmed
* innovaphone firmware / software version: to be confirmed

==Configuration==
Configuration details will be completed based on the validated test setup.

The planned configuration section will include:
* innovaphone-side SIP configuration
* Algo 8301 SIP registration settings
* paging behavior and extension mapping
* multicast settings, if used
* audio output connection to amplifier
* relay input / output use, if applicable
* any deployment notes, limitations, or prerequisites identified during testing

==Summary==
The Algo 8301 IP Paging Adapter & Scheduler provides a practical bridge between legacy analog paging infrastructure and modern IP-based communication systems. It enables organizations to preserve existing amplifier and speaker investments while adding SIP paging, scheduling, multicast distribution, and emergency notification capabilities. Final interoperability details with innovaphone will be updated after test validation and configuration review.

==Contact==
{|
| Algo Communication Products Ltd.
|-
| Contact Name: to be confirmed
|-
| Burnaby, BC, Canada
|-
| Tel: +1 604-454-3790
|-
| Support: +1 604-454-3792
|-
| Mail: [mailto:info@algosolutions.com info@algosolutions.com]
|}

For additional information please refer to [https://www.algosolutions.com/contact-us/ our contact page].

Howto:Algo 8301 IP Paging Adapter - Algo - 3rd Party Product

2026-04-15T09:37:43Z

Kpe: /* innovaphone Reverse Proxy ready */

[[Image:AlgosolutionsLogo.png|200px|right|algosolutionslogo.png/]]
==Product Name==
Algo [https://www.algosolutions.com/product/8301-ip-paging-adapter-scheduler/ 8301 IP Paging Adapter & Scheduler]

==Certification Status==


==Category==

[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty Terminal Devices|{{PAGENAME}}]]

==Vendor==
Algo Communication Products Ltd. is a manufacturer of network-based IP endpoints for voice paging, emergency alerting, visual notification, intercom, and secure door entry applications. Algo products are designed for integration with unified communications, collaboration, and mass notification platforms. The company’s portfolio includes IP speakers, paging adapters, intercoms, visual alerters, display speakers, and endpoint management tools for commercial, education, healthcare, transportation, and industrial environments.

==Description==
The Algo 8301 IP Paging Adapter & Scheduler is a wideband SIP paging adapter designed to connect traditional analog amplifiers and legacy paging infrastructure to modern IP-based communication environments.

The 8301 emulates a page port similar to what is found on a legacy PBX or key system, allowing a traditional amplifier to be integrated into a VoIP or unified communications environment. This enables organizations to retain existing analog speaker infrastructure while adding SIP paging, multicast distribution, scheduled bells, automated announcements, emergency notifications, and other IP-based communication capabilities.

The device includes a balanced and isolated line output to reduce hum and noise when connected to an amplifier, and it also supports multicast audio transmission to additional Algo IP endpoints and compatible multicast-enabled phones. The 8301 is appropriate for education, retail, manufacturing, transportation, healthcare, and other environments where hybrid analog and IP paging is required.

==Functions==
The Algo 8301 IP Paging Adapter & Scheduler supports a range of functions for paging, alerting, scheduling, and hybrid analog/IP deployments.

Core functions include:
* SIP-based voice paging through registration as a 3rd-party SIP endpoint
* Integration of traditional analog amplifiers into IP and UC environments
* Scheduled bells, tones, and automated announcements synchronized to NTP
* Emergency, safety, security, and customer service audio notifications
* Multicast transmission to Algo IP speakers, paging adapters, display speakers, and compatible multicast-enabled phones
* Ring, page, and alert extension support
* Relay input and relay output support for connected accessories and external triggers
* Music input and background audio distribution
* Web interface configuration and centralized provisioning support

The 8301 can be deployed either as a SIP extension or as a multicast endpoint, depending on the communication design. In hybrid systems, it can provide local analog paging output while simultaneously distributing audio to IP endpoints over the network.

==innovaphone CTI ready==
n.a.

==innovaphone Reverse Proxy ready==
Yes, the tests has been performed on an innovaphone myApps Cloud environment with registration via the reverse proxy. On the users object hardware ID, media relay was activated


==innovaphone WebRTC ready==
n.a.

==Supported Codecs==


==DTMF Support==



==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==



==Support LDAP Phonebook==
n.a.

==Version==
Product versions used for interop testing:
* Algo 8301 IP Paging Adapter & Scheduler: version to be confirmed
* innovaphone firmware / software version: to be confirmed

==Configuration==
Configuration details will be completed based on the validated test setup.

The planned configuration section will include:
* innovaphone-side SIP configuration
* Algo 8301 SIP registration settings
* paging behavior and extension mapping
* multicast settings, if used
* audio output connection to amplifier
* relay input / output use, if applicable
* any deployment notes, limitations, or prerequisites identified during testing

==Summary==
The Algo 8301 IP Paging Adapter & Scheduler provides a practical bridge between legacy analog paging infrastructure and modern IP-based communication systems. It enables organizations to preserve existing amplifier and speaker investments while adding SIP paging, scheduling, multicast distribution, and emergency notification capabilities. Final interoperability details with innovaphone will be updated after test validation and configuration review.

==Contact==
{|
| Algo Communication Products Ltd.
|-
| Contact Name: to be confirmed
|-
| Burnaby, BC, Canada
|-
| Tel: +1 604-454-3790
|-
| Support: +1 604-454-3792
|-
| Mail: [mailto:info@algosolutions.com info@algosolutions.com]
|}

For additional information please refer to [https://www.algosolutions.com/contact-us/ our contact page].

Reference13r1:PBX/Objects/Edit Forks

2026-04-13T10:49:50Z

Kpe:

With this page call forking can be configured for a user. This means a call for this user is not only sent to endpoints registered to the user object, but also to the forking destination. If a mobility object is configured for the forking, the phone identified by the forking destination can use the mobility functions. A delay can be configured for the call to the mobile endpoint. This delay is not supported for normal call forking without mobility functions. Operator calls from a waiting queue require a UC license to be sent to forking destinations.

;No/Name: Forking destination, Mobility destination (the mobility destination must be a '''unique''' number, you cannot add the same number for different users)

;Bool/Not: The forking can be turned on and off by a Boolean object. With the '''Not''' checkmark the state is inverted.

== Properties of Mobility==

For the function of the Mobility features a Mobility license must be installed.

;Object: The [[Reference9:PBX/Objects/Mobility| Mobility]] Object (Long Name) must be set, if the mobile endpoint (GSM Phone) needs to use the [[Reference8:Administration/PBX/Objects/Mobility| mobility features]].
: Mobility license is required

;Device: The Device name of the User should be configured here (e.g. "Smartphone"). This name is used by SOAP (TAPI) to address this device for example when initiating a call, by myPBX to enable/disable Mobility for the User (on the Call Forward settings Screen of myPBX) and for Mobility Client OptiCaller for HTTP CallBack/CallThrough.

;App: Field that is used to configure the rcc app for callback feature available in the user profile App. To call the app just enter "rcc".

;Delay: A Delay in seconds can be configured to call the mobile endpoint.

;Disable: Disabling the Mobility features for the mobile device, this can also be en/disabled via [[Reference8:Administration/PBX/Objects/DTMF Features#Enable.2Fdisable mobility|DTMF featurecodes]]

;Call-Waiting: Enable or disable call-waiting for the mobile endpoint, if a mobile endpoint is in a call a call waiting tone will be played from the PBX to the mobile endpoint via the RTP stream. See [[Reference9:PBX/Objects/Mobility| R-Key Functions]] for waiting calls handling options.
: Mobility features are required

;GSM-License: When using the innovaphone GSM client a GSM license is needed and need to be activated. NB: obsolete

;Min-Alert: The minimum time in seconds a call must ring on the mobile phone until it can be accepted. If the call is accepted before this time, the call is rejected by the PBX. This way it can be achieved that the announcement from a mobile provider for phones not available does not accept a call and calls can be accepted on a fixed phone on the same number in case the mobile phone is switched off. The alert time is measured from the alert to the connect signalling. If there is no alert message (e.g. because there is a connect right away), the alert time is counted as null. '''Note: If the carrier doesn't send any Alert/180 Ringing, you may need to enable [[{{NAMESPACE}}:PBX/Objects/Mobility | Carrier w/o Alerting]] .'''
: Mobility features are required

;Max-Alert: Maximum time the mobile phone rings. After this time the PBX terminates the call to the mobile phone. This way it can be avoided that the mobile voicemail accepts the mobility call.
: Mobility features are required

[[Category:Concept App RCC|Related]]

Howto:PBX-Designer - K-Businesscom - Partner App

2026-04-09T08:45:12Z

Kpe: Replaced content with " ==Product Name==   This wiki is obsolete, please check this one instead [https://wiki.innovaphone.com/index.php?title=Howto:PBX-Designer_-_ITM_-_Partner_App Howto:PBX-Designer_-_ITM_-_Partner_App] ===Cloud === For cloud operators please see [https://wiki.innovaphone.com/index.php?title=Howto:Cloud-Designer_-_ITM_-_Partner_App Cloud-Designer] and [https://wik..."

==Product Name==


This wiki is obsolete, please check this one instead [https://wiki.innovaphone.com/index.php?title=Howto:PBX-Designer_-_ITM_-_Partner_App Howto:PBX-Designer_-_ITM_-_Partner_App]

===Cloud ===
For cloud operators please see [https://wiki.innovaphone.com/index.php?title=Howto:Cloud-Designer_-_ITM_-_Partner_App Cloud-Designer] and [https://wiki.innovaphone.com/index.php?title=Howto:Cloud-Manager_-_ITM_-_3rd_Party_Product Cloud-Manager]

Howto16r1:Firmware Upgrade V15r1 V16r1

2026-04-08T15:49:52Z

Kpe: /* Migration Policy */

== Applies To ==
This information applies to:

* All 16r1 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 16r1, see [[Howto:Firmware Upgrade]]
== Licenses ==
In case of cloud or rental model, don't worry about licenses.

If the system is licensed on premise, you'll need to regenerate the license file for v16 in https://portal.innovaphone.com/ and load into the system before upgrade (The system needs to have the SSC up to date).

== Migration Policy ==
Before you begin, be sure that your whole installation is running the latest 15r1 service release. Create backups before you start and store them on an external location 

=== TechAssist Upgrade Helper ===
* Before you start, make sure that all TechAssist tests (you will receive the required tests in the last update in the previous major version) labelled <code>Pre Upgrade: xy</code> are positive, if available
* When you are finished, make sure that all TechAssist tests (you will receive new tests with the upgrade) are positive

=== New TLS Profile ===
Please note that we have changed our TLS profiles ([[Reference16r1:IP4/General/TLS]]). The new ''Normal'' setting, which is the default value, now only allows TLS 1.3 and TLS 1.2.

== Changes visible to the end customers ==
Listed here are changes that should be communicated by resellers to end users prior to a upgrade, as the change will be visible/audible in the behaviour of the application/device.

* ''Nothing''

== Manual steps needed after upgrade ==
If the installer is not used for a new installation, some new default settings are not set. Please evaluate per app whether you want to configure the new default settings manually.

=== Connector for Microsoft 365 ===
If you plan to use the new '''Contact Search''' feature of the Connector for Microsoft 365, you need to perform two manual Steps:
# Create the '''microsoft365-api''' app object by using the Settings template
# Assign the '''microsoft365-api''' app object to every user who should be able to use the new Contact Search feature. (Of cause, you can use a template for that)
 
For a more detailed guide, please refer to the how-to article: [[Howto16r1:Configure Contact Search by Connector for Microsoft365#Creating the PBX app object using the PBX Manager Plugin]]

=== Remote Control ===
In order to use the Admin Configuration Panel of the Settings App – AP Remote Control, it is necessary to grant access to the '''admin''' API, available in the App tab of the Remote Control App object.

=== Working ===
For badge counts to work, the Working Manager app object must have '''Websocket''' and '''PbxSignal''' enabled.
For the Connect integration of the Working app, '''Websocket''', '''Services''' and '''Connect'''(in the Apps tab) must be enabled in the Working User app.

=== Switchboard ===
For the Connect Integration (Call Notes) to work, the Switchboard App must have the '''Services''' (App-tab) and '''connect''' and '''messages-api''' (Apps-tab) enabled.

== New Apps ==
New Apps will not be installed automatically by the upgrade. The installation description of new apps is usually in the concept article. Please rate per app whether you want to install/use the new app and configure it manually.

* App Polls: [[Reference16r1:Concept App Polls]]
* App Service Conference Transcriptions [[Reference16r1:Concept_App_Service_myApps_Assistant]]
* App Service Connector for Whatsapp: [[Reference16r1:Concept_App_Service_Connector_for_Whatsapp]]
* App Conference Scaler: [[Reference16r1:Concept_Conference_Scaler_App]]
* App Service IP: [[Reference16r1:Concept App Service IP]]

== Removed ==
The following software is no longer included.

* IP110A (can still be used with 15r1 firmware on current PBX versions)
* IP240A (can still be used with 15r1 firmware on current PBX versions)
* CA on CF card feature

== Deprecated ==
The following software is based on legacy technology, with no further development and limited maintenance and support.

* ''Nothing''

== Previously deprecated and now no longer supported ==
The following software is based on legacy technology, with no further development and no more maintenance and support.

* ''Nothing''

==Known Problems==
===Long Update-duration===
When you update, it can be up to 10 minutes before you have access to your app platform again.

== Related Articles ==
*[[Howto:Firmware_Upgrade]]
* [[Howto15r1:Firmware_Upgrade_V14r2_V15r1]]
[[Category:Howto|{{PAGENAME}}]]

Reference16r1:Concept App Service Queues

2026-04-08T14:11:52Z

Kpe: /* Right panel */

[[Category:Concept|Apps]]
The Queues App Service can be installed on an innovaphone App Platform and will provide services for several Apps that can be used to manage calls and waiting queues with myApps. For example the Switchboard App.

== Applies To ==

* innovaphone PBX from version 16r1final

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V16r1xx
* UsersAdminApp
* (Soft)PhoneApp
* ProfileApp
* CalllistApp
* Calllist-API
* RCC-API
* configured Waiting Queues in the PBX
* configured group(s) in the PBX assigned as "Static" and "Active" to the Waiting Queue
* License “App(innovaphone-switchboard)13” (order no. 02-00050-007) per application-user
* A dedicated group(queues) in the PBX assigned as "Static" to all Waiting Queues used by the Switchboard App and assigned as "Static and Active" to all Switchboard Users

==V16 Improvements==
'''Show call diversions for the favorites section in the BLF.''' 
This feature shows, with a colored label in the BLF entry, the configured call forwarding from the respective User. The color of the label depends on the type of configured forwarding, CFNR (orange/yellow), CFB (red) or CFU (purple). A click on the label, shows the configured forwarding destination.

'''Breakthrough of call diversions from BLF in favorites section.''' 
With a new icon (handset with arrow) it is possible to call to the User with a Call forward and breakthrough this call forward. This applies for CFB and CFU. In case of a CFNR the CFx-breakthrough does not apply because the call rings first at the user and after the configured timer the CFNR will be executed.

'''Edit mobility destination for users.''' 
An improvement for changing the mobility destination of the users.

'''Enable numeric + key as shortcut for transfer option.''' 
The Switchboard App now supports the shortkey + as shortkey for the transfer functionality.

'''Focus on second call for easier transfer ''' 
When starting a second call in the Switchboard App, the focus will be in the call section on this second call, so that a transfer can be initiated immediately by pressing the configured short-cut, for example the numeric + key. In case the focus is in the search field, press the TAB key first.

'''Call state in outgoing call section.''' 
When having an outgoing call, the status of this call (ringing or connected) will be shown in this outgoing call for a more user-friendly and intuitive feedback.

'''Notes for in- and outgoing calls in connect.''' 
When having an in- or outgoing call, you can add a note for this call in the Connect App. When a new call arrives, the Note can be consulted as additional information about this caller or called number.

'''Callback request email during a call.''' 
When having a call, a callback request per email can be generated. The email will have available callinformation already preloaded, like name, number and email-address of the caller if available.

'''Show Notes button in the Call History.''' 
Action key in the call history items to jump to the corresponding Notes in the Connect App.

'''Show fold/ unfold view for adjusting WQ height in Config''' 
changed design for configuring the showed Waiting Queue call section height.

'''Show Blf slider in Icons only view''' 
when selected the Icons only view of the BLF a slider will be shown.

'''Improved search funcionality.''' 
The improved search functionality is in line with the (Soft)Phone App search showing the source of the search result.

'''Improved search details.''' 
Improved the shown details from a search result and showing more info in the BLF entry details.

'''Create a popup box for already existing shortcuts.''' 
In case you enter a short cut that already excist, it will give you a warning that this shortcut is already created.

'''Fixed breakthrough option/button was not updated.''' 
Fixed breakthrough option/button was not updated (added/removed) when eg a CFu is set/removed.

'''Fix: Issue added users not visible immediately in BLF.''' 
Show users immediately in the BLF after adding them to a group.

'''Fix: Issue missing call-leg2 Info.''' 
Missing Call-leg2 Info now showed after connecting a Call.

'''Fix: Issue to many calls when starting call forward breakthrough.''' 
Fixed call forward breakthrough that leaded to many calls.

'''Fix: Issue to less space between buttons in BLF Details.''' 
Fixed the space between buttons in BLF user details.

'''Fix: Issue with Queues-plugin Group Configuration.''' 
The Display Name was wrongly used as User Identifier/Common Name to assign the 'queue'-group.

'''Fix: Issue Display of mismatched number with name in outgoing calls.''' 
Fixed the display of mismatched number with name in outgoing calls section on pickup.

'''Fix: Issue with missing CFx on a user after a change by the Switchboard App.''' 
Fixed the forwardings stored in PBX after a change by the Switchboard App.

'''Fix: Issue Users displayed multiple times when we click on BLF duplication button.''' 
Fixed the behavior when we click on BLF duplication button.

'''Fix: Issue when Transfer-button clicked twice.''' 
Fixed when transfer-button clicked twice, the transfer button was not removed on second call.

'''Fix: Issue Missing call after selecting IVR option.''' 
Fixed when selecting IVR option, show the waiting Queue again in the call panel section.

'''Fix: Issue transfer button shown on active calls.''' 
Fixed don't show the transfer button on active calls.

'''Fix: Show CFx Icon on toggling from large to small Icon view''' 
Fixed to show the Call Forward Icon in the small view of the Busy Lamp Field.

'''Fix: Favorites did have less actions than other contacts in the BLF''' 
Fixed to show all possibile actions on the BLF entries in the favorites section

'''Fix Add option to fix WQ height in config''' 
Fixed added option to waiting queues height configuration

'''For further fixes to come with future service releases, please consult our release notes accordingly.''' 

== Apps ==
=== Switchboard App (innovaphone-switchboard) ===
[[Image: Switchboard-App.png|50px|switchboard-app.png/|switchboard-app.png/]]

The Switchboard App is an attendant workstation integrated into the myApps user interface. At a switchboard workstation, an employee of a company or a telephone network operator can process incoming calls and connection requests from external or internal callers. An employee can accept connections, request information, put calls on hold, transfer them to the desired destination, or reject the connection. The calls displayed are the ones from the monitorized phone device and they are managed using the RCC-API. The Switchboard App needs a license per Switchboard user, called the Switchboard App.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard</pre>
;Websocket
;TableUsers: to be able to replicate the users for the BLF
;Admin: to be able to edit the User object to monitor or un-monitor a waiting queue
;PbxApi: to edit the presence information
;Services: to be able to connect to extra apis (eg connect/connect-api (*))
;RCC: to use the RCC API to manage the calls
;Impersonation: to get the Phone App favorites

;Apps->messages-api: to be able to see/post call notes (*)

=== Switchboard Admin App (innovaphone-switchboard-admin) ===
[[Image: Innovaphone-switchboard-admin.png|50px|innovaphone-switchboard-admin.png/|innovaphone-switchboard-admin.png/]]

With the Switchboard Admin App an administrator can manage the user(s) rights, can assign waiting queues to users and can pre-configure the Busy Lamp Field BLF.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard-admin</pre>
;Websocket
;TableUsers: to be able to replicate the users from the PBX
;Admin: to be able to assign the waiting queue groups to the user

== PBX Manager Plugins ==

=== Queues ===

With the Queues plugin the Switchboard App and Switchboard Admin App Objects can be created, edited and deleted on the PBX.

==Configuration==
# Install the Queues App
#* Option 1: Settings Apps/App Installer plugin - Search and Install the Queues App or
#* Option 2: AP Manager/App Store:
#** Search and Install the Queues App
#** Create an Instance of the Queues App
#** Start the created instance
# Settings App/Queues Plugin - Create the necessary App Objects:
#* Switchboard App: e.g. 'Switchboard'/'switchboard'
#* Switchboard Admin App: e.g. 'Switchboard Admin'/'switchboard-admin'
# Assign the Switchboard App and License to the correct users (can be done User- or Config Template-based)
# Assign the Switchboard Admin App to the correct Admin-users (can be done User- or Config Template-based)
# Configure Master PBX via the Switchboard Admin App Settings (optional with a single PBX):
#* PBX Name: PBX Name (PBX/Config/General/PBX Name) of the Master PBX
#* DNS (optional): DNS Name (PBX/Config/General/PBX Name) of the Master PBX Restart the Queues Instance after changing (so the App Objects can re-connect).
# Configure Waiting Queues via the Settings App/Waiting Queues Plugin or check existing Waiting Queues:
#* Waiting Queues monitored by the Switchboard App must have a '''Primary Group''' (used by the Switchboard Admin App to assign groups to Users)
#* Waiting Queues monitored by the Switchboard App must '''not''' have the ''''Operator connect for SOAP''''-checkbox ticked (needed to release calls correctly when taken/accepted by another Switchboard User)
# Create a Monitoring Group '''queues''' for the Switchboard (Admin) App. This can be done easily via the Queues Plugin of the Settings App (Groups configuration) or via the Advanced UI of the PBX:
#* '''Waiting Queues''' to be seen by the Switchboard App must have this group assigned '''Static only'''
#* '''Switchboard Users''' must have this group assigned '''Static and Active'''
# Configure the Switchboard Users via Switchboard Admin App:
#* Assign the correct rights / Waiting Queues to be monitored
#* (Optional) Create or Assign an already created Busy Lamp Field
# Adjust the Switchboard User Object and Phone Config (can also be done via a Config Template (desk phones only)):
#* Object: '''Untick 'Twin Phones'''' => Picking alerting calls (BLF or Waiting Queue-section) is possible
#* (Soft)Phone: '''Enable 'Call Waiting'''' => handling of multiple calls is possible (e.g. pickup call while there is an already alerting call)
# (Optional) Adjust the PBX/Phone/myApps/UsersAdmin App Config for better usage:
#* PBX: Configure the Recall Timeout of the PBX (PBX/Config/General/Recall Timeout) => Blind Transferred calls can be taken back
#* Phone: Configure a Park-key on the phone(s) of the Switchboard User(s) => visual/audio reminder of Parked Calls after X seconds
#* myApps: Deselect the default (Soft)Phone App + Untick the "Bring AppSharing/Video always to front" in your (Soft)Phone App => prevention of the (Soft)Phone App to popup.
#* UsersAdmin App: Tick the 'Privacy/Display e-mail address' in the Settings of the Users Admin, so that a callback-button is shown for User-search results.
# Open the Switchboard App and Select a (Soft)Phone to be controlled in the Settings/Hamburger Menu

'''Note''': Make sure to close the Switchboard App of the user when adjusting the config this user via the Switchboard Admin App. This ensure that changes are not overwritten again with the old values.

==Switchboard Admin App - User interface==
When opening the Switchboard Admin App the Switchboard Admin App shows only a search field at start (since release V14r1).
It will not list all users anymore, which speeds up the start of the App in big environments with many users.
At this point, closing the Switchboard Admin App, doesn't make any changes to the Switchboard App database.

Before doing any changes for any switchboard user, make sure that this user has closed the Switchboard App. Perform the changes, and afterward the Switchboard App user can reopen the Switchboard App and the changes will be applied.

===Search field===
Search for the user of your choice by typing its name.
The users details include their configured CFx since V15r1 and up.
When multiple user are shown, select the correct user.
The more detailed information (Rights / Busy lamp field) shown is retrieved from the Switchboard App database, while the existing user's group membership of the configured waiting queues, is retrieved from the PBX.

===Rights===
Here, you can define the rights of the Switchboard App user:
* Edit waiting queues: the user is allowed to add or delete waiting queues in the Switchboard App, to receive calls from.
* Edit presence: the user is allowed to change the presence state and presence note from other users in the system.
* Edit call diversions and mobility: the user is allowed to change other user's call forwards, mobility and its destinations.

===Waiting Queues===
This section shows the membership of primary group activity from the respective waiting queue.
This information is retrieved from the PBX. Changes will be saved into the PBX and the Switchboard App database.
Be aware that when making any changes to the selected user, it will be saved in the PBX and the Switchboard App database as well.
It might overwrite the latest group membership change done by the Switchboard App user itself. 
To make sure that your Administrative group membership settings will apply, make sure that the user's Switchboard App is closed before doing any changes. 
You might want to verify the user's preferred settings before, to apply them respectively with your changes.

The, in the PBX manager, pre-configured waiting queues will be shown to select the possible group membership. The possible choices are:
* Off: this waiting queue will not be shown in the user's Switchboard App for login.
* Dynamic-In: this waiting queue will be shown in the user's Switchboard App and the user is automatically logged-in the group with the start of the App (the user logs off from the group when closing the Switchboard App).
* Dynamic-Out: this waiting queue will be shown in the user's Switchboard App and the user is logged-off at start of the App (the user logs off from the group when closing the Switchboard App).
* Static: this waiting queue will be shown in the user's Switchboard App and the user is static in the group without the option to log-off (the user stays active in the group after closing the Switchboard App).

===Busy Lamp Field===

The Busy Lamp Field (BLF) section in the Switchboard Admin App, allows you, as admin, to pre-define the BLF groups and the PBX Users in the groups.
There is also the option to copy an already configured BLF from another user and edit it to your preferences.

==Switchboard App - User interface==
[[File:Switchboard app user interface.png|thumb|switchboard_app_user_interface.png/|switchboard_app_user_interface.png/]]
The user interface is divided in 3 panels:
* Left panel : Busy Lamp Field and users search
* Central panel: Calls
* Right panel: Waiting queues and calls history

There is also a hamburger menu, where some configuration settings can be edited.

=== Left panel ===
==== Busy Lamp Field ====
[[File:Switchboard app BLF contact.png|thumb|switchboard_app_blf_contact.png/|switchboard_app_blf_contact.png/]]
The '''BLF''' is displayed on the left panel. There all the users replicated from the PBX are displayed and it can be undocked and displayed on another window.
Information displayed by user:
* Profile picture
* Presence
* Common name
* Phone number
* CFx label if a CFx is configured (destination of the CFx is visible with a click on the label)

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a call by using the phone button
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display users detailed contact information
* Create BLF groups
* Re-arrange BLF groups by moving one entry '''on top of''' another entry in order to place it '''before it'''.
* Add a user to a BLF group
* Delete a user from a BLF group by long press left mouse
* Call Breaktrough on configured CFB or CFU

The BLF contacts is limited to PBX users and Contacts from the Contacts App with the proper detailed information. A Name, sip-name and number must be available as minimum information

==== Users search ====
[[File:Switchboard app contact information search result.png|thumb|switchboard_app_contact_information_search_result.png/|switchboard_app_contact_information_search_result.png/]]
The '''users search''' (Search-API) can be done with the input field. This input field can also be used to directly dial using the phone button.
Information displayed by user:
* Profile picture
* Presence
* Common name
* CFx if configured

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a chat
* Start a call
* Start a Breakthrough call on CFB or CFU
* Send an email
[[File:Switchboard app BLF contact information detailed.png|thumb|switchboard_app_blf_contact_information_detailed.png/|switchboard_app_blf_contact_information_detailed.png/]]
The user '''details''' can also be expanded by clicking on the arrow icon.
Data displayed (read only) for the user:
* Profile picture
* Common name
* SIP
* Phone number
* Email
* PBX
* Node

Data displayed that can also be edited for the user (if the user has the appropriate rights):
* Presence note
* Presence
* Call diversions
* Mobility

Actions allowed:
* Start a chat
* Start a call (by SIP and phone number)
* Send an email
* Send a "Call me back" notification by email
* Add the user to a BLF group

=== Center panel ===
On the center panel the calls are displayed.

==== Calls ====
The calls are divided in 5 sections: in the waiting queue, incoming, outgoing, parked and transferred.

Depending on the call state, different '''actions''' are allowed to manage the calls:
* Connect/Disconnect a call
* Mute/Unmute a call
* Hold/Release a call
* Park/Unpark a call
* Transfer a call to a user or connect 2 calls
* Pick up a transferred call or a call from the waiting queue

=== Right panel ===
On the right panel the waiting queues and the calls history are displayed. The Notes Field when beeing used, will be on top off the Waiting Queues and Calls History section.

==== Waiting Queues ====
On the right panel the '''waiting queues''' are displayed. They can be added by clicking on "Add waiting queue" (only displayed if the user has the appropriate right), which will automatically add the user to the given group. The calls will be displayed on the calls section and from there they can be picked up or transferred to an user.

==== Calls history ====
On this panel also the '''calls history''' is displayed, which is received from the Call List-API.

Information displayed on entry:
* Call flow
* Call information (source/destination, date and duration)

Actions allowed:
* Start a call
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display contact information
* Add the user to a BLF group

==== Notes Field ====
During an active call you have the option to add a Note for this call and caller-id. The first notes information like name and/or number is added by the App service. You can add a personal note as additional information related to the call or caller-id.

The notes are stored in the Connect App in the zone Switchboard. To be able to see the Switchboard Notes from the service and other Switchboard operators, the Switchboard user should have read access to the zone Switchboard. To add personal notes to the discussion, the Switchboard User should also have the Connect App license (included in the UCC license)

In the call history you are also able to create, read and add notes.

With a new incoming call and there is already a note available for this caller-id, the note will be shown immediately in the right section of the screen.

=== Hamburger menu ===
On the hamburger menu the '''shortcuts''' can be edited and the size of the users items from the BLF can be customized.
==== Edit shortcuts ====
To edit a shortcut, the shortcut must be selected and then the desired key pressed. Afterwards it has to be clicked again to finish the editing. To remove a shorcut, select the shortcut and press the "Del" key on your keyboard.

==== Size of the user items (BLF) ====
There are 2 different size:
* Icons only: only the profile picture, presence and common name will be displayed.
* Detailed large: the phone number and the call button are displayed too.

==== Limit displayed calls in waiting queues section ====
Different view of incoming calls in the waiting queues section
* If disabled: a long list of incoming calls will be shown.
* If enabled: a short list of incoming calls will be shown and a scrollbar will appear in this section
** Fix WQ height optional with height setting between 0 and 50
The amount of showed calls in both scenarios depends on the used display size and resolution configuration (adaptive design)

==== Select monitored device ====
If a device is selected, all the calls from/to that device will be monitored by the app.

==Additional information==
===Licensing===
* When using the OperatorV13 license in a pre V13r2 release, and you want to use the Switchboard App instead in a > V13r2, you need to download a new license file from my.innovaphone
* Upgrade from Operator, the Operator13 license will result in 3 times App(innovaphone-switchboard)13 in addition.

===Reverse Lookup from Contacts===
For Reverse Lookup to work both for Queue-calls as Operator-calls, the Directory must have the correct Access Rules:
* if the directory has no ACL-rules => will work for Queue- and Operator Calls
* if the directory has ACL-rules => a rule for each object (WQ and Operator) must apply:
** the name of the WQ/Operator-object
** an active group of the WQ/Operator

===Info field for BLF contact details, Operator Note===
The Switchboard Operator can use the Contacts App to add or edit the contact details with the Info field, to show additional information like an "Operator Note".

The information added to the Info field, will be shown in the detailed view of a BLF Contact or in the detailed view of a searched contact at the bottom as additional information aka "Operator Note"

==Known issues==
* When closing the Switchboard App, the user will be logout of all the waiting queues groups. When opening the app again, the user will be automatically logged-in on this groups again. (This is by design)
* Shortcuts may not be triggered on the Switchboard App if the app is not on focus. For this just click on the UI of the app.
* If a softphone is being monitored, the Softphone App must be opened on background. Otherwise the RCC-API will not sent calls information to the Switchboard App. Since >= V13r3 this will be done automatically.
* If no (soft)phone device has been selected on the hamburger menu of the Switboard App, the calls may be displayed duplicated because that means that the app is monitoring all the devices. To avoid this please select your default (Soft)Phone App on the phone devices section.
* When using the Softphone App with the same name and hardware-id on multiple devices (PC and Smartphone) an incoming call will be shown more than once, depending on the amount of used devices. You can add a Softphone with different naming and hardware-ID for the Switchboard User to use with the Switchboard App only.
* As Switchboard App "Operator" you will work mainly with the Switchboard App. To have video from internal callers, you need to have a (Soft)Phone App open in the background. Deselect your Default Phone device in the myApps otherwise this App will get focus during the incoming call and on connect after answering a call. Best Practice to undock the Video from your (Soft)Phone App in the background and deselect the option "Bring AppSharing/Video always to front" as this would bring your (Soft)Phone App to the front as well.
* When using Softphone App on X multiple devices, incoming calls will be displayed X multiple times. In scenarios where the Switchboard App user has multiple devices with myApps(Smartphone, tabblet, PC) it might make sense to create a Softphone with different name for each device or at least for the device where you want to use the Switchboard App with the Softphone App. Using different names for the Softphones, creates respectively different hardware-ID's. This assures that only the selected specific Softphone App and device will be monitored by the Switchboard App based on this specific name and HW-ID.
* If LDAP contacts are not displayed on the search results, please check if the rights for the LDAP object have been given to the Switchboard App.
* It is possible that the app instance needs to be restarted if the PBX name has changed on the hamburger menu of the Switchboard Admin App.
* Use unique group name per waiting queue. The Group and group name, assigned to your waiting queue, should not be (re)used for other Waiting Queues or other groups.

==Trouble shooting==
* If any issue can be reproduced, open the console output of your browser or right-click and inspect in the native client version of the Switchboard App. Clear the console output and reproduce the issue and copy past the output as a textfile and send this attached in your support ticket.

==Related Articles==
* SDK Integration (if the content is available)

Reference15r1:Concept Push Notifications for iOS and Android

2026-03-23T09:18:45Z

Kpe: /* Customer uses HTTP-Proxy for Internet access */

[[Category:Concept|iOS Softwarephone]]
The PBX is able to send Push notifications to the Apple (APNs) or Android Push Notification services. As a result, incoming calls are also indicated when the myApps application is not started or runs in the background mode. The PBX is using a service provided by innovaphone AG at ''push.innovaphone.com'' to send the push notifications to the vendors Notification Service. No call meta data is transmitted, the push notification is only used to wake up the myApps application. Only one Push object is needed for a system.

== Requirements ==
=== PBX ===
* Firmware version 15r1 or higher
* Internet access via HTTPS
* device certificate (also on '''IPVAs''')
** this device certificate is not an own certificate, which you can upload yourself but which you need to retrieve through my.innovaphone (see [[#Initial configuration| Initial configuration]])!

=== Smartphone ===
* iOS Version 12.0.1 or higher
* Android Version 6.0 or higher

== Configuration ==
=== PBX ===
* verify that each pbx has the certificates <code>innovaphone Device Certification Authority 2</code> or the signed <code>push.innovaphone.com</code> in his local trust list. If you use the [[{{NAMESPACE}}:Concept App Service Devices#Certificates configuration|Devices - certificate trustlist concept]] the certificates will be installed automatically.
* create a PUSH object via the PBX manager,by clicking on the plugin Push (Black and White myApps symbol) The Plugin will create a PBX object in the PBX of type [[{{NAMESPACE}}:PBX/Objects/Push|Push]] per system, even in master/slave scenarios
** Name Push and SIP name push can be freely choosen, but the sip name must be used in the push field of user the objects. We advise leave the pre filled Standard names.
** the App URL must be <code>https://push.innovaphone.com/push/ws</code>
After clicking OK a green checkmark should appear, indicating that the Push object has a valid websocket connection to the innovaphone Push service.

=== User Objects ===
* For each user who is to receive push notifications on his myApps-application, the ''Name'' of the push-object must be entered in his userobject at the ''Push'' field in the ''User'' tab.

=== iOS specific settings ===
* On the iOS device make sure to allow push notifications for the myApps application.

=== Android specific settings ===

==How it works==
*First of all the mobile phone opens a connection to Apple or Google. If the phone is in a restricted Wi-Fi network (and has no GSM/LTE data connection to receive Push notifications), the appropriate ports of the firewall needs to opened as explained in the documentation of [https://support.apple.com/en-us/HT203609 apple] or [https://firebase.google.com/docs/cloud-messaging/concept-options#ports_and_your_firewall google].
*If the app is in the background and the user receives an incoming call, the App needs to be woken.
*Therefore the PBX sends a push request to innovaphones push servers (push.innovaphone.com)
*The communication is done with MTLS and our push servers check the client device certificate of the PBX
** the used certificate is the device certificate provided by innovaphone and not a certificate, which you can upload yourself
*push.innovaphone.com forwards the request to the Apple or Google Push service.
*The respective vendor sends the push request to the mobile phone and uses the ports opened in the first step.
*The app then registers at the PBX via H.323.
*In the last step the incoming call is sent (using the H.323 registration) to the mobile phone.

[[Image:push.gif|push.gif/|push.gif/]]

Note: the services.innovaphone.com in the picture must be replaced with push.innovaphone.com

=== Privacy ===
When using the Push service the PBX will send following data/information to [[Howto:Innovaphones public services|innovaphone]]:

* Notification Type (plain)
** ''call'' or ''notification''

* Detailed informations (enrypted)
** ''call''
*** number
*** name
*** callflow
** ''notification''
*** title
*** content

This information will send from the PBX to the Smartphone via the innovaphone Push-Service and forwarded to the Google/Apple push system. The Smartphone receives a decryption key via websocket or H323 (you have to use the secure version to transmit the key encrypted) from the PBX. Neither the push service at innovaphone nor the Apple / Google push system can read the encrypted information.

== Troubleshooting ==
=== Initial configuration ===
* Check the trust list for the certificate of the innovaphone AG.
* Make sure the PBX can resolve the DNS host ''push.innovaphone.com''.
* Make sure the PBX can reach ''push.innovaphone.com'' via HTTPS.
* Make sure that you have a innovaphone ''device certificate'' - even on '''IPVAs'''. The certificate is signed by ''innovaphone Device Certification Authority 2'' or on IPVAs since V14r1 by ''innovaphone Unverified Device CA''. If not, you can acquire a new one on the Gateway via [[{{NAMESPACE}}:General/License/my.innovaphone#Download_Certificate | General/License/my.innovaphone]]. '''This will not conflict with an existing certificate that you installed yourself on the gateway.'''
* Make sure the myApps application has Push Notifications allowed in the OS settings.
** iOS: Also make sure, the iOS device has a valid GSM data connection or a WiFi connection with the internet, especially TCP port 5223 (see [https://developer.apple.com/library/archive/technotes/tn2265/_index.html Troubleshooting Push Notifications] article by Apple).

=== Push looses connected state ===
* If the push object was already connected, and for some reason (after a firmware update or network connection problems), the object is not connected anymore, please check that PBX can reach and resolve "push.innovaphone.com" and the innovaphone AG certificate is still in the trust list.

===myApps for Android push configuration checks ===

[[Image:Troubleshoot_v13_Push_with_myApps_for_Android and iOS_1.jpg|troubleshoot_v13_push_with_myapps_for_android_and_ios_1.jpg/|troubleshoot_v13_push_with_myapps_for_android_and_ios_1.jpg/]]

Open myApps, and check you have a softphone app configured. Then tap on the "burger" menu on the top right, and check your default app is the softphone app.

Scroll down and tap on "More"
# Tap on "myApps events" and enable notification on the smartphone for myApps
# Tap on "Calling account" and enable myApps as call account
# Tap on "Data saver" and enable background data for myApps on the smartphone
# Tap on "Overlaying" and enable them on the smartphone

===myApps for iOS push configuration checks ===
Go through the following steps, to check that in your iPhone, Push is configured correctly.
#Open your iOS Settings app on your iPhone
#Go to the ''Notifications'' (German: Mitteilungen) section
#Find the myApps app and make sure notifications are allowed and that LockScreen, Notification Center and Banners are selected as Alerts 
For more information on howto enable Push notifications for an iOS-app, see also [https://support.apple.com/en-us/HT201925#If%20you%20don't%20see%20notifications%20for%20a%20specific%20app this Apple support page, section If you don't see notifications for a specific app]
===innovaphone Push Service check===
Consult [https://status.innovaphone.com/ innovaphone services overview] to check if any unexpected service outage concerning push exists

== Known limitations ==
=== Number to Name resolution on Android Push Notifications could be missing ===
On incoming call Push Notification to Android the caller number will be included, if the Number to name resolution it's not yet finished no name will be included in this Push notification just the number. The Android doesn't allow a number/name update of that call afterwards so it will remain displaying only the number till we terminate the call. On iOS we don't have such issue since the system allows update of the number/name during call.

=== Push does work even when the myApps app is switched off ===
The Push mechanism will also work when the myApps app is turned off. This can lead to complains about receiving calls after working ours or during holidays.
With myApps as client, you can set the status to DND Do Not Disturb. Then close the myApps.
This will prevent the App to be started by the Push mechanism.
To receive calls again, open the myApps clients and set the status back to available.

You can disable the Push to the myApps by just ending the session for this device by logging out of the myApps application or Alternative you can go to the Hamburger Menu, Account Security and logout the active session.
You can also remove a session from another device for example a myApps Session from another Smartphone or browser.
Deselecting a default Softphone app, will also prevent the Push mechanism.

=== Customer uses HTTP-Proxy for Internet access ===
The WebSocket client does not support HTTP-Proxy connections, more specific HTTP Tunneling using HTTP CONNECT - therefore Push notifications will not work. See also: [[{{NAMESPACE}}:Services/HTTP/Client#Proxy_Servers|Reference15r1:Services/HTTP/Client#Proxy_Servers]]

=== BC Conference Object does NOT trigger the push mechanism ===
The BC Conference Object is not able to trigger the push mechanism for smartphone users. In case you want to have smartphone users as participants in your BC Conference Object, you need to use the folowing workaround.

Create for evey user a dedicated waiting queue object and add the smartphone user as only member to the group of this dedicated waiting queue.

Instead of the user, you add the dedicated waiting queue as a member of the BC Conference Object group.

A BC Conference call will call the dedicated waiting queue and the waiting queue will call the smartphone user which also triggers the push mecahnism.

==Known issues==

===Cloning IPVAs===
If you clone an IPVA with an existing device certificate, you'll also clone this certificate, so you'll have a wrong serial number inside the certificate afterwards. 
So '''do not clone''' IPVAs but setup a new VM and upload a modified configuration file afterwards and create a new certificate for the new machine.

Currently it is not possible to update or delete the device certificate.

== Related Articles ==
* [[Howto:Innovaphones_public_services]]

Reference16r1:Concept App Service Queues

2026-03-16T09:34:15Z

Kpe: /* V16 Improvements */

[[Category:Concept|Apps]]
The Queues App Service can be installed on an innovaphone App Platform and will provide services for several Apps that can be used to manage calls and waiting queues with myApps. For example the Switchboard App.

== Applies To ==

* innovaphone PBX from version 16r1final

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V16r1xx
* UsersAdminApp
* (Soft)PhoneApp
* ProfileApp
* CalllistApp
* Calllist-API
* RCC-API
* configured Waiting Queues in the PBX
* configured group(s) in the PBX assigned as "Static" and "Active" to the Waiting Queue
* License “App(innovaphone-switchboard)13” (order no. 02-00050-007) per application-user
* A dedicated group(queues) in the PBX assigned as "Static" to all Waiting Queues used by the Switchboard App and assigned as "Static and Active" to all Switchboard Users

==V16 Improvements==
'''Show call diversions for the favorites section in the BLF.''' 
This feature shows, with a colored label in the BLF entry, the configured call forwarding from the respective User. The color of the label depends on the type of configured forwarding, CFNR (orange/yellow), CFB (red) or CFU (purple). A click on the label, shows the configured forwarding destination.

'''Breakthrough of call diversions from BLF in favorites section.''' 
With a new icon (handset with arrow) it is possible to call to the User with a Call forward and breakthrough this call forward. This applies for CFB and CFU. In case of a CFNR the CFx-breakthrough does not apply because the call rings first at the user and after the configured timer the CFNR will be executed.

'''Edit mobility destination for users.''' 
An improvement for changing the mobility destination of the users.

'''Enable numeric + key as shortcut for transfer option.''' 
The Switchboard App now supports the shortkey + as shortkey for the transfer functionality.

'''Focus on second call for easier transfer ''' 
When starting a second call in the Switchboard App, the focus will be in the call section on this second call, so that a transfer can be initiated immediately by pressing the configured short-cut, for example the numeric + key. In case the focus is in the search field, press the TAB key first.

'''Call state in outgoing call section.''' 
When having an outgoing call, the status of this call (ringing or connected) will be shown in this outgoing call for a more user-friendly and intuitive feedback.

'''Notes for in- and outgoing calls in connect.''' 
When having an in- or outgoing call, you can add a note for this call in the Connect App. When a new call arrives, the Note can be consulted as additional information about this caller or called number.

'''Callback request email during a call.''' 
When having a call, a callback request per email can be generated. The email will have available callinformation already preloaded, like name, number and email-address of the caller if available.

'''Show Notes button in the Call History.''' 
Action key in the call history items to jump to the corresponding Notes in the Connect App.

'''Show fold/ unfold view for adjusting WQ height in Config''' 
changed design for configuring the showed Waiting Queue call section height.

'''Show Blf slider in Icons only view''' 
when selected the Icons only view of the BLF a slider will be shown.

'''Improved search funcionality.''' 
The improved search functionality is in line with the (Soft)Phone App search showing the source of the search result.

'''Improved search details.''' 
Improved the shown details from a search result and showing more info in the BLF entry details.

'''Create a popup box for already existing shortcuts.''' 
In case you enter a short cut that already excist, it will give you a warning that this shortcut is already created.

'''Fixed breakthrough option/button was not updated.''' 
Fixed breakthrough option/button was not updated (added/removed) when eg a CFu is set/removed.

'''Fix: Issue added users not visible immediately in BLF.''' 
Show users immediately in the BLF after adding them to a group.

'''Fix: Issue missing call-leg2 Info.''' 
Missing Call-leg2 Info now showed after connecting a Call.

'''Fix: Issue to many calls when starting call forward breakthrough.''' 
Fixed call forward breakthrough that leaded to many calls.

'''Fix: Issue to less space between buttons in BLF Details.''' 
Fixed the space between buttons in BLF user details.

'''Fix: Issue with Queues-plugin Group Configuration.''' 
The Display Name was wrongly used as User Identifier/Common Name to assign the 'queue'-group.

'''Fix: Issue Display of mismatched number with name in outgoing calls.''' 
Fixed the display of mismatched number with name in outgoing calls section on pickup.

'''Fix: Issue with missing CFx on a user after a change by the Switchboard App.''' 
Fixed the forwardings stored in PBX after a change by the Switchboard App.

'''Fix: Issue Users displayed multiple times when we click on BLF duplication button.''' 
Fixed the behavior when we click on BLF duplication button.

'''Fix: Issue when Transfer-button clicked twice.''' 
Fixed when transfer-button clicked twice, the transfer button was not removed on second call.

'''Fix: Issue Missing call after selecting IVR option.''' 
Fixed when selecting IVR option, show the waiting Queue again in the call panel section.

'''Fix: Issue transfer button shown on active calls.''' 
Fixed don't show the transfer button on active calls.

'''Fix: Show CFx Icon on toggling from large to small Icon view''' 
Fixed to show the Call Forward Icon in the small view of the Busy Lamp Field.

'''Fix: Favorites did have less actions than other contacts in the BLF''' 
Fixed to show all possibile actions on the BLF entries in the favorites section

'''Fix Add option to fix WQ height in config''' 
Fixed added option to waiting queues height configuration

'''For further fixes to come with future service releases, please consult our release notes accordingly.''' 

== Apps ==
=== Switchboard App (innovaphone-switchboard) ===
[[Image: Switchboard-App.png|50px|switchboard-app.png/|switchboard-app.png/]]

The Switchboard App is an attendant workstation integrated into the myApps user interface. At a switchboard workstation, an employee of a company or a telephone network operator can process incoming calls and connection requests from external or internal callers. An employee can accept connections, request information, put calls on hold, transfer them to the desired destination, or reject the connection. The calls displayed are the ones from the monitorized phone device and they are managed using the RCC-API. The Switchboard App needs a license per Switchboard user, called the Switchboard App.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard</pre>
;Websocket
;TableUsers: to be able to replicate the users for the BLF
;Admin: to be able to edit the User object to monitor or un-monitor a waiting queue
;PbxApi: to edit the presence information
;RCC: to use the RCC API to manage the calls
;Impersonation: to get the Phone App favorites

=== Switchboard Admin App (innovaphone-switchboard-admin) ===
[[Image: Innovaphone-switchboard-admin.png|50px|innovaphone-switchboard-admin.png/|innovaphone-switchboard-admin.png/]]

With the Switchboard Admin App an administrator can manage the user(s) rights, can assign waiting queues to users and can pre-configure the Busy Lamp Field BLF.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard-admin</pre>
;Websocket
;TableUsers: to be able to replicate the users from the PBX
;Admin: to be able to assign the waiting queue groups to the user

== PBX Manager Plugins ==

=== Queues ===

With the Queues plugin the Switchboard App and Switchboard Admin App Objects can be created, edited and deleted on the PBX.

==Configuration==
# Install the Queues App
#* Option 1: Settings Apps/App Installer plugin - Search and Install the Queues App or
#* Option 2: AP Manager/App Store:
#** Search and Install the Queues App
#** Create an Instance of the Queues App
#** Start the created instance
# Settings App/Queues Plugin - Create the necessary App Objects:
#* Switchboard App: e.g. 'Switchboard'/'switchboard'
#* Switchboard Admin App: e.g. 'Switchboard Admin'/'switchboard-admin'
# Assign the Switchboard App and License to the correct users (can be done User- or Config Template-based)
# Assign the Switchboard Admin App to the correct Admin-users (can be done User- or Config Template-based)
# Configure Master PBX via the Switchboard Admin App Settings (optional with a single PBX):
#* PBX Name: PBX Name (PBX/Config/General/PBX Name) of the Master PBX
#* DNS (optional): DNS Name (PBX/Config/General/PBX Name) of the Master PBX Restart the Queues Instance after changing (so the App Objects can re-connect).
# Configure Waiting Queues via the Settings App/Waiting Queues Plugin or check existing Waiting Queues:
#* Waiting Queues monitored by the Switchboard App must have a '''Primary Group''' (used by the Switchboard Admin App to assign groups to Users)
#* Waiting Queues monitored by the Switchboard App must '''not''' have the ''''Operator connect for SOAP''''-checkbox ticked (needed to release calls correctly when taken/accepted by another Switchboard User)
# Create a Monitoring Group '''queues''' for the Switchboard (Admin) App. This can be done easily via the Queues Plugin of the Settings App (Groups configuration) or via the Advanced UI of the PBX:
#* '''Waiting Queues''' to be seen by the Switchboard App must have this group assigned '''Static only'''
#* '''Switchboard Users''' must have this group assigned '''Static and Active'''
# Configure the Switchboard Users via Switchboard Admin App:
#* Assign the correct rights / Waiting Queues to be monitored
#* (Optional) Create or Assign an already created Busy Lamp Field
# Adjust the Switchboard User Object and Phone Config (can also be done via a Config Template (desk phones only)):
#* Object: '''Untick 'Twin Phones'''' => Picking alerting calls (BLF or Waiting Queue-section) is possible
#* (Soft)Phone: '''Enable 'Call Waiting'''' => handling of multiple calls is possible (e.g. pickup call while there is an already alerting call)
# (Optional) Adjust the PBX/Phone/myApps/UsersAdmin App Config for better usage:
#* PBX: Configure the Recall Timeout of the PBX (PBX/Config/General/Recall Timeout) => Blind Transferred calls can be taken back
#* Phone: Configure a Park-key on the phone(s) of the Switchboard User(s) => visual/audio reminder of Parked Calls after X seconds
#* myApps: Deselect the default (Soft)Phone App + Untick the "Bring AppSharing/Video always to front" in your (Soft)Phone App => prevention of the (Soft)Phone App to popup.
#* UsersAdmin App: Tick the 'Privacy/Display e-mail address' in the Settings of the Users Admin, so that a callback-button is shown for User-search results.
# Open the Switchboard App and Select a (Soft)Phone to be controlled in the Settings/Hamburger Menu

'''Note''': Make sure to close the Switchboard App of the user when adjusting the config this user via the Switchboard Admin App. This ensure that changes are not overwritten again with the old values.

==Switchboard Admin App - User interface==
When opening the Switchboard Admin App the Switchboard Admin App shows only a search field at start (since release V14r1).
It will not list all users anymore, which speeds up the start of the App in big environments with many users.
At this point, closing the Switchboard Admin App, doesn't make any changes to the Switchboard App database.

Before doing any changes for any switchboard user, make sure that this user has closed the Switchboard App. Perform the changes, and afterward the Switchboard App user can reopen the Switchboard App and the changes will be applied.

===Search field===
Search for the user of your choice by typing its name.
The users details include their configured CFx since V15r1 and up.
When multiple user are shown, select the correct user.
The more detailed information (Rights / Busy lamp field) shown is retrieved from the Switchboard App database, while the existing user's group membership of the configured waiting queues, is retrieved from the PBX.

===Rights===
Here, you can define the rights of the Switchboard App user:
* Edit waiting queues: the user is allowed to add or delete waiting queues in the Switchboard App, to receive calls from.
* Edit presence: the user is allowed to change the presence state and presence note from other users in the system.
* Edit call diversions and mobility: the user is allowed to change other user's call forwards, mobility and its destinations.

===Waiting Queues===
This section shows the membership of primary group activity from the respective waiting queue.
This information is retrieved from the PBX. Changes will be saved into the PBX and the Switchboard App database.
Be aware that when making any changes to the selected user, it will be saved in the PBX and the Switchboard App database as well.
It might overwrite the latest group membership change done by the Switchboard App user itself. 
To make sure that your Administrative group membership settings will apply, make sure that the user's Switchboard App is closed before doing any changes. 
You might want to verify the user's preferred settings before, to apply them respectively with your changes.

The, in the PBX manager, pre-configured waiting queues will be shown to select the possible group membership. The possible choices are:
* Off: this waiting queue will not be shown in the user's Switchboard App for login.
* Dynamic-In: this waiting queue will be shown in the user's Switchboard App and the user is automatically logged-in the group with the start of the App (the user logs off from the group when closing the Switchboard App).
* Dynamic-Out: this waiting queue will be shown in the user's Switchboard App and the user is logged-off at start of the App (the user logs off from the group when closing the Switchboard App).
* Static: this waiting queue will be shown in the user's Switchboard App and the user is static in the group without the option to log-off (the user stays active in the group after closing the Switchboard App).

===Busy Lamp Field===

The Busy Lamp Field (BLF) section in the Switchboard Admin App, allows you, as admin, to pre-define the BLF groups and the PBX Users in the groups.
There is also the option to copy an already configured BLF from another user and edit it to your preferences.

==Switchboard App - User interface==
[[File:Switchboard app user interface.png|thumb|switchboard_app_user_interface.png/|switchboard_app_user_interface.png/]]
The user interface is divided in 3 panels:
* Left panel : Busy Lamp Field and users search
* Central panel: Calls
* Right panel: Waiting queues and calls history

There is also a hamburger menu, where some configuration settings can be edited.

=== Left panel ===
==== Busy Lamp Field ====
[[File:Switchboard app BLF contact.png|thumb|switchboard_app_blf_contact.png/|switchboard_app_blf_contact.png/]]
The '''BLF''' is displayed on the left panel. There all the users replicated from the PBX are displayed and it can be undocked and displayed on another window.
Information displayed by user:
* Profile picture
* Presence
* Common name
* Phone number
* CFx label if a CFx is configured (destination of the CFx is visible with a click on the label)

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a call by using the phone button
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display users detailed contact information
* Create BLF groups
* Re-arrange BLF groups by moving one entry '''on top of''' another entry in order to place it '''before it'''.
* Add a user to a BLF group
* Delete a user from a BLF group by long press left mouse
* Call Breaktrough on configured CFB or CFU

The BLF contacts is limited to PBX users and Contacts from the Contacts App with the proper detailed information. A Name, sip-name and number must be available as minimum information

==== Users search ====
[[File:Switchboard app contact information search result.png|thumb|switchboard_app_contact_information_search_result.png/|switchboard_app_contact_information_search_result.png/]]
The '''users search''' (Search-API) can be done with the input field. This input field can also be used to directly dial using the phone button.
Information displayed by user:
* Profile picture
* Presence
* Common name
* CFx if configured

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a chat
* Start a call
* Start a Breakthrough call on CFB or CFU
* Send an email
[[File:Switchboard app BLF contact information detailed.png|thumb|switchboard_app_blf_contact_information_detailed.png/|switchboard_app_blf_contact_information_detailed.png/]]
The user '''details''' can also be expanded by clicking on the arrow icon.
Data displayed (read only) for the user:
* Profile picture
* Common name
* SIP
* Phone number
* Email
* PBX
* Node

Data displayed that can also be edited for the user (if the user has the appropriate rights):
* Presence note
* Presence
* Call diversions
* Mobility

Actions allowed:
* Start a chat
* Start a call (by SIP and phone number)
* Send an email
* Send a "Call me back" notification by email
* Add the user to a BLF group

=== Center panel ===
On the center panel the calls are displayed.

==== Calls ====
The calls are divided in 5 sections: in the waiting queue, incoming, outgoing, parked and transferred.

Depending on the call state, different '''actions''' are allowed to manage the calls:
* Connect/Disconnect a call
* Mute/Unmute a call
* Hold/Release a call
* Park/Unpark a call
* Transfer a call to a user or connect 2 calls
* Pick up a transferred call or a call from the waiting queue

=== Right panel ===
On the right panel the waiting queues and the calls history are displayed.

==== Waiting Queues ====
On the right panel the '''waiting queues''' are displayed. They can be added by clicking on "Add waiting queue" (only displayed if the user has the appropriate right), which will automatically add the user to the given group. The calls will be displayed on the calls section and from there they can be picked up or transferred to an user.

==== Calls history ====
On this panel also the '''calls history''' is displayed, which is received from the Call List-API.

Information displayed on entry:
* Call flow
* Call information (source/destination, date and duration)

Actions allowed:
* Start a call
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display contact information
* Add the user to a BLF group

=== Hamburger menu ===
On the hamburger menu the '''shortcuts''' can be edited and the size of the users items from the BLF can be customized.
==== Edit shortcuts ====
To edit a shortcut, the shortcut must be selected and then the desired key pressed. Afterwards it has to be clicked again to finish the editing. To remove a shorcut, select the shortcut and press the "Del" key on your keyboard.

==== Size of the user items (BLF) ====
There are 2 different size:
* Icons only: only the profile picture, presence and common name will be displayed.
* Detailed large: the phone number and the call button are displayed too.

==== Limit displayed calls in waiting queues section ====
Different view of incoming calls in the waiting queues section
* If disabled: a long list of incoming calls will be shown.
* If enabled: a short list of incoming calls will be shown and a scrollbar will appear in this section
** Fix WQ height optional with height setting between 0 and 50
The amount of showed calls in both scenarios depends on the used display size and resolution configuration (adaptive design)

==== Select monitored device ====
If a device is selected, all the calls from/to that device will be monitored by the app.

==Additional information==
===Licensing===
* When using the OperatorV13 license in a pre V13r2 release, and you want to use the Switchboard App instead in a > V13r2, you need to download a new license file from my.innovaphone
* Upgrade from Operator, the Operator13 license will result in 3 times App(innovaphone-switchboard)13 in addition.

===Reverse Lookup from Contacts===
For Reverse Lookup to work both for Queue-calls as Operator-calls, the Directory must have the correct Access Rules:
* if the directory has no ACL-rules => will work for Queue- and Operator Calls
* if the directory has ACL-rules => a rule for each object (WQ and Operator) must apply:
** the name of the WQ/Operator-object
** an active group of the WQ/Operator

===Info field for BLF contact details, Operator Note===
The Switchboard Operator can use the Contacts App to add or edit the contact details with the Info field, to show additional information like an "Operator Note".

The information added to the Info field, will be shown in the detailed view of a BLF Contact or in the detailed view of a searched contact at the bottom as additional information aka "Operator Note"

==Known issues==
* When closing the Switchboard App, the user will be logout of all the waiting queues groups. When opening the app again, the user will be automatically logged-in on this groups again. (This is by design)
* Shortcuts may not be triggered on the Switchboard App if the app is not on focus. For this just click on the UI of the app.
* If a softphone is being monitored, the Softphone App must be opened on background. Otherwise the RCC-API will not sent calls information to the Switchboard App. Since >= V13r3 this will be done automatically.
* If no (soft)phone device has been selected on the hamburger menu of the Switboard App, the calls may be displayed duplicated because that means that the app is monitoring all the devices. To avoid this please select your default (Soft)Phone App on the phone devices section.
* When using the Softphone App with the same name and hardware-id on multiple devices (PC and Smartphone) an incoming call will be shown more than once, depending on the amount of used devices. You can add a Softphone with different naming and hardware-ID for the Switchboard User to use with the Switchboard App only.
* As Switchboard App "Operator" you will work mainly with the Switchboard App. To have video from internal callers, you need to have a (Soft)Phone App open in the background. Deselect your Default Phone device in the myApps otherwise this App will get focus during the incoming call and on connect after answering a call. Best Practice to undock the Video from your (Soft)Phone App in the background and deselect the option "Bring AppSharing/Video always to front" as this would bring your (Soft)Phone App to the front as well.
* When using Softphone App on X multiple devices, incoming calls will be displayed X multiple times. In scenarios where the Switchboard App user has multiple devices with myApps(Smartphone, tabblet, PC) it might make sense to create a Softphone with different name for each device or at least for the device where you want to use the Switchboard App with the Softphone App. Using different names for the Softphones, creates respectively different hardware-ID's. This assures that only the selected specific Softphone App and device will be monitored by the Switchboard App based on this specific name and HW-ID.
* If LDAP contacts are not displayed on the search results, please check if the rights for the LDAP object have been given to the Switchboard App.
* It is possible that the app instance needs to be restarted if the PBX name has changed on the hamburger menu of the Switchboard Admin App.
* Use unique group name per waiting queue. The Group and group name, assigned to your waiting queue, should not be (re)used for other Waiting Queues or other groups.

==Trouble shooting==
* If any issue can be reproduced, open the console output of your browser or right-click and inspect in the native client version of the Switchboard App. Clear the console output and reproduce the issue and copy past the output as a textfile and send this attached in your support ticket.

==Related Articles==
* SDK Integration (if the content is available)

Reference16r1:Concept App Service Queues

2026-03-16T09:31:57Z

Kpe: /* V16 Improvements */

[[Category:Concept|Apps]]
The Queues App Service can be installed on an innovaphone App Platform and will provide services for several Apps that can be used to manage calls and waiting queues with myApps. For example the Switchboard App.

== Applies To ==

* innovaphone PBX from version 16r1final

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V16r1xx
* UsersAdminApp
* (Soft)PhoneApp
* ProfileApp
* CalllistApp
* Calllist-API
* RCC-API
* configured Waiting Queues in the PBX
* configured group(s) in the PBX assigned as "Static" and "Active" to the Waiting Queue
* License “App(innovaphone-switchboard)13” (order no. 02-00050-007) per application-user
* A dedicated group(queues) in the PBX assigned as "Static" to all Waiting Queues used by the Switchboard App and assigned as "Static and Active" to all Switchboard Users

==V16 Improvements==
'''Show call diversions for the favorites section in the BLF.''' 
This feature shows, with a colored label in the BLF entry, the configured call forwarding from the respective User. The color of the label depends on the type of configured forwarding, CFNR (orange/yellow), CFB (red) or CFU (purple). A click on the label, shows the configured forwarding destination.

'''Breakthrough of call diversions from BLF in favorites section.''' 
With a new icon (handset with arrow) it is possible to call to the User with a Call forward and breakthrough this call forward. This applies for CFB and CFU. In case of a CFNR the CFx-breakthrough does not apply because the call rings first at the user and after the configured timer the CFNR will be executed.

'''Edit mobility destination for users.''' 
An improvement for changing the mobility destination of the users.

'''Enable numeric + key as shortcut for transfer option.''' 
The Switchboard App now supports the shortkey + as shortkey for the transfer functionality.

'''Focus on second call for easier transfer ''' 
When starting a second call in the Switchboard App, the focus will be in the call section on this second call, so that a transfer can be initiated immediately by pressing the configured short-cut, for example the numeric + key. In case the focus is in the search field, press the TAB key first.

'''Call state in outgoing call section.''' 
When having an outgoing call, the status of this call (ringing or connected) will be shown in this outgoing call for a more user-friendly and intuitive feedback.

'''Notes for in- and outgoing calls in connect.''' 
When having an in- or outgoing call, you can add a note for this call in the Connect App. When a new call arrives, the Note can be consulted as additional information about this caller or called number.

'''Callback request email during a call.''' 
When having a call, a callback request per email can be generated. The email will have available callinformation already preloaded, like name, number and email-address of the caller if available.

'''Show Notes button in the Call History.'''

Action key in the call history items to jump to the corresponding Notes in the Connect App.

'''Show fold/ unfold view for adjusting WQ height in Config'''

changed design for configuring the showed Waiting Queue call section height.

'''Show Blf slider in Icons only view'''

when selected the Icons only view of the BLF a slider will be shown.

'''Improved search funcionality.'''

The improved search functionality is in line with the (Soft)Phone App search showing the source of the search result.

'''Improved search details.'''

Improved the shown details from a search result and showing more info in the BLF entry details.

'''Create a popup box for already existing shortcuts.'''

In case you enter a short cut that already excist, it will give you a warning that this shortcut is already created.

'''Fixed breakthrough option/button was not updated.''' 
Fixed breakthrough option/button was not updated (added/removed) when eg a CFu is set/removed.

'''Fix: Issue added users not visible immediately in BLF.''' 
Show users immediately in the BLF after adding them to a group.

'''Fix: Issue missing call-leg2 Info.''' 
Missing Call-leg2 Info now showed after connecting a Call.

'''Fix: Issue to many calls when starting call forward breakthrough.''' 
Fixed call forward breakthrough that leaded to many calls.

'''Fix: Issue to less space between buttons in BLF Details.''' 
Fixed the space between buttons in BLF user details.

'''Fix: Issue with Queues-plugin Group Configuration.''' 
The Display Name was wrongly used as User Identifier/Common Name to assign the 'queue'-group.

'''Fix: Issue Display of mismatched number with name in outgoing calls.''' 
Fixed the display of mismatched number with name in outgoing calls section on pickup.

'''Fix: Issue with missing CFx on a user after a change by the Switchboard App.''' 
Fixed the forwardings stored in PBX after a change by the Switchboard App.

'''Fix: Issue Users displayed multiple times when we click on BLF duplication button.''' 
Fixed the behavior when we click on BLF duplication button.

'''Fix: Issue when Transfer-button clicked twice.''' 
Fixed when transfer-button clicked twice, the transfer button was not removed on second call.

'''Fix: Issue Missing call after selecting IVR option.''' 
Fixed when selecting IVR option, show the waiting Queue again in the call panel section.

'''Fix: Issue transfer button shown on active calls.''' 
Fixed don't show the transfer button on active calls.

'''Fix: Show CFx Icon on toggling from large to small Icon view'''

Fixed to show the Call Forward Icon in the small view of the Busy Lamp Field.

'''Fix: Favorites did have less actions than other contacts in the BLF'''

Fixed to show all possibile actions on the BLF entries in the favorites section

'''Fix Add option to fix WQ height in config'''

Fixed added option to waiting queues height configuration

'''For further fixes to come with future service releases, please consult our release notes accordingly.''' 

== Apps ==
=== Switchboard App (innovaphone-switchboard) ===
[[Image: Switchboard-App.png|50px|switchboard-app.png/|switchboard-app.png/]]

The Switchboard App is an attendant workstation integrated into the myApps user interface. At a switchboard workstation, an employee of a company or a telephone network operator can process incoming calls and connection requests from external or internal callers. An employee can accept connections, request information, put calls on hold, transfer them to the desired destination, or reject the connection. The calls displayed are the ones from the monitorized phone device and they are managed using the RCC-API. The Switchboard App needs a license per Switchboard user, called the Switchboard App.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard</pre>
;Websocket
;TableUsers: to be able to replicate the users for the BLF
;Admin: to be able to edit the User object to monitor or un-monitor a waiting queue
;PbxApi: to edit the presence information
;RCC: to use the RCC API to manage the calls
;Impersonation: to get the Phone App favorites

=== Switchboard Admin App (innovaphone-switchboard-admin) ===
[[Image: Innovaphone-switchboard-admin.png|50px|innovaphone-switchboard-admin.png/|innovaphone-switchboard-admin.png/]]

With the Switchboard Admin App an administrator can manage the user(s) rights, can assign waiting queues to users and can pre-configure the Busy Lamp Field BLF.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard-admin</pre>
;Websocket
;TableUsers: to be able to replicate the users from the PBX
;Admin: to be able to assign the waiting queue groups to the user

== PBX Manager Plugins ==

=== Queues ===

With the Queues plugin the Switchboard App and Switchboard Admin App Objects can be created, edited and deleted on the PBX.

==Configuration==
# Install the Queues App
#* Option 1: Settings Apps/App Installer plugin - Search and Install the Queues App or
#* Option 2: AP Manager/App Store:
#** Search and Install the Queues App
#** Create an Instance of the Queues App
#** Start the created instance
# Settings App/Queues Plugin - Create the necessary App Objects:
#* Switchboard App: e.g. 'Switchboard'/'switchboard'
#* Switchboard Admin App: e.g. 'Switchboard Admin'/'switchboard-admin'
# Assign the Switchboard App and License to the correct users (can be done User- or Config Template-based)
# Assign the Switchboard Admin App to the correct Admin-users (can be done User- or Config Template-based)
# Configure Master PBX via the Switchboard Admin App Settings (optional with a single PBX):
#* PBX Name: PBX Name (PBX/Config/General/PBX Name) of the Master PBX
#* DNS (optional): DNS Name (PBX/Config/General/PBX Name) of the Master PBX Restart the Queues Instance after changing (so the App Objects can re-connect).
# Configure Waiting Queues via the Settings App/Waiting Queues Plugin or check existing Waiting Queues:
#* Waiting Queues monitored by the Switchboard App must have a '''Primary Group''' (used by the Switchboard Admin App to assign groups to Users)
#* Waiting Queues monitored by the Switchboard App must '''not''' have the ''''Operator connect for SOAP''''-checkbox ticked (needed to release calls correctly when taken/accepted by another Switchboard User)
# Create a Monitoring Group '''queues''' for the Switchboard (Admin) App. This can be done easily via the Queues Plugin of the Settings App (Groups configuration) or via the Advanced UI of the PBX:
#* '''Waiting Queues''' to be seen by the Switchboard App must have this group assigned '''Static only'''
#* '''Switchboard Users''' must have this group assigned '''Static and Active'''
# Configure the Switchboard Users via Switchboard Admin App:
#* Assign the correct rights / Waiting Queues to be monitored
#* (Optional) Create or Assign an already created Busy Lamp Field
# Adjust the Switchboard User Object and Phone Config (can also be done via a Config Template (desk phones only)):
#* Object: '''Untick 'Twin Phones'''' => Picking alerting calls (BLF or Waiting Queue-section) is possible
#* (Soft)Phone: '''Enable 'Call Waiting'''' => handling of multiple calls is possible (e.g. pickup call while there is an already alerting call)
# (Optional) Adjust the PBX/Phone/myApps/UsersAdmin App Config for better usage:
#* PBX: Configure the Recall Timeout of the PBX (PBX/Config/General/Recall Timeout) => Blind Transferred calls can be taken back
#* Phone: Configure a Park-key on the phone(s) of the Switchboard User(s) => visual/audio reminder of Parked Calls after X seconds
#* myApps: Deselect the default (Soft)Phone App + Untick the "Bring AppSharing/Video always to front" in your (Soft)Phone App => prevention of the (Soft)Phone App to popup.
#* UsersAdmin App: Tick the 'Privacy/Display e-mail address' in the Settings of the Users Admin, so that a callback-button is shown for User-search results.
# Open the Switchboard App and Select a (Soft)Phone to be controlled in the Settings/Hamburger Menu

'''Note''': Make sure to close the Switchboard App of the user when adjusting the config this user via the Switchboard Admin App. This ensure that changes are not overwritten again with the old values.

==Switchboard Admin App - User interface==
When opening the Switchboard Admin App the Switchboard Admin App shows only a search field at start (since release V14r1).
It will not list all users anymore, which speeds up the start of the App in big environments with many users.
At this point, closing the Switchboard Admin App, doesn't make any changes to the Switchboard App database.

Before doing any changes for any switchboard user, make sure that this user has closed the Switchboard App. Perform the changes, and afterward the Switchboard App user can reopen the Switchboard App and the changes will be applied.

===Search field===
Search for the user of your choice by typing its name.
The users details include their configured CFx since V15r1 and up.
When multiple user are shown, select the correct user.
The more detailed information (Rights / Busy lamp field) shown is retrieved from the Switchboard App database, while the existing user's group membership of the configured waiting queues, is retrieved from the PBX.

===Rights===
Here, you can define the rights of the Switchboard App user:
* Edit waiting queues: the user is allowed to add or delete waiting queues in the Switchboard App, to receive calls from.
* Edit presence: the user is allowed to change the presence state and presence note from other users in the system.
* Edit call diversions and mobility: the user is allowed to change other user's call forwards, mobility and its destinations.

===Waiting Queues===
This section shows the membership of primary group activity from the respective waiting queue.
This information is retrieved from the PBX. Changes will be saved into the PBX and the Switchboard App database.
Be aware that when making any changes to the selected user, it will be saved in the PBX and the Switchboard App database as well.
It might overwrite the latest group membership change done by the Switchboard App user itself. 
To make sure that your Administrative group membership settings will apply, make sure that the user's Switchboard App is closed before doing any changes. 
You might want to verify the user's preferred settings before, to apply them respectively with your changes.

The, in the PBX manager, pre-configured waiting queues will be shown to select the possible group membership. The possible choices are:
* Off: this waiting queue will not be shown in the user's Switchboard App for login.
* Dynamic-In: this waiting queue will be shown in the user's Switchboard App and the user is automatically logged-in the group with the start of the App (the user logs off from the group when closing the Switchboard App).
* Dynamic-Out: this waiting queue will be shown in the user's Switchboard App and the user is logged-off at start of the App (the user logs off from the group when closing the Switchboard App).
* Static: this waiting queue will be shown in the user's Switchboard App and the user is static in the group without the option to log-off (the user stays active in the group after closing the Switchboard App).

===Busy Lamp Field===

The Busy Lamp Field (BLF) section in the Switchboard Admin App, allows you, as admin, to pre-define the BLF groups and the PBX Users in the groups.
There is also the option to copy an already configured BLF from another user and edit it to your preferences.

==Switchboard App - User interface==
[[File:Switchboard app user interface.png|thumb|switchboard_app_user_interface.png/|switchboard_app_user_interface.png/]]
The user interface is divided in 3 panels:
* Left panel : Busy Lamp Field and users search
* Central panel: Calls
* Right panel: Waiting queues and calls history

There is also a hamburger menu, where some configuration settings can be edited.

=== Left panel ===
==== Busy Lamp Field ====
[[File:Switchboard app BLF contact.png|thumb|switchboard_app_blf_contact.png/|switchboard_app_blf_contact.png/]]
The '''BLF''' is displayed on the left panel. There all the users replicated from the PBX are displayed and it can be undocked and displayed on another window.
Information displayed by user:
* Profile picture
* Presence
* Common name
* Phone number
* CFx label if a CFx is configured (destination of the CFx is visible with a click on the label)

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a call by using the phone button
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display users detailed contact information
* Create BLF groups
* Re-arrange BLF groups by moving one entry '''on top of''' another entry in order to place it '''before it'''.
* Add a user to a BLF group
* Delete a user from a BLF group by long press left mouse
* Call Breaktrough on configured CFB or CFU

The BLF contacts is limited to PBX users and Contacts from the Contacts App with the proper detailed information. A Name, sip-name and number must be available as minimum information

==== Users search ====
[[File:Switchboard app contact information search result.png|thumb|switchboard_app_contact_information_search_result.png/|switchboard_app_contact_information_search_result.png/]]
The '''users search''' (Search-API) can be done with the input field. This input field can also be used to directly dial using the phone button.
Information displayed by user:
* Profile picture
* Presence
* Common name
* CFx if configured

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a chat
* Start a call
* Start a Breakthrough call on CFB or CFU
* Send an email
[[File:Switchboard app BLF contact information detailed.png|thumb|switchboard_app_blf_contact_information_detailed.png/|switchboard_app_blf_contact_information_detailed.png/]]
The user '''details''' can also be expanded by clicking on the arrow icon.
Data displayed (read only) for the user:
* Profile picture
* Common name
* SIP
* Phone number
* Email
* PBX
* Node

Data displayed that can also be edited for the user (if the user has the appropriate rights):
* Presence note
* Presence
* Call diversions
* Mobility

Actions allowed:
* Start a chat
* Start a call (by SIP and phone number)
* Send an email
* Send a "Call me back" notification by email
* Add the user to a BLF group

=== Center panel ===
On the center panel the calls are displayed.

==== Calls ====
The calls are divided in 5 sections: in the waiting queue, incoming, outgoing, parked and transferred.

Depending on the call state, different '''actions''' are allowed to manage the calls:
* Connect/Disconnect a call
* Mute/Unmute a call
* Hold/Release a call
* Park/Unpark a call
* Transfer a call to a user or connect 2 calls
* Pick up a transferred call or a call from the waiting queue

=== Right panel ===
On the right panel the waiting queues and the calls history are displayed.

==== Waiting Queues ====
On the right panel the '''waiting queues''' are displayed. They can be added by clicking on "Add waiting queue" (only displayed if the user has the appropriate right), which will automatically add the user to the given group. The calls will be displayed on the calls section and from there they can be picked up or transferred to an user.

==== Calls history ====
On this panel also the '''calls history''' is displayed, which is received from the Call List-API.

Information displayed on entry:
* Call flow
* Call information (source/destination, date and duration)

Actions allowed:
* Start a call
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display contact information
* Add the user to a BLF group

=== Hamburger menu ===
On the hamburger menu the '''shortcuts''' can be edited and the size of the users items from the BLF can be customized.
==== Edit shortcuts ====
To edit a shortcut, the shortcut must be selected and then the desired key pressed. Afterwards it has to be clicked again to finish the editing. To remove a shorcut, select the shortcut and press the "Del" key on your keyboard.

==== Size of the user items (BLF) ====
There are 2 different size:
* Icons only: only the profile picture, presence and common name will be displayed.
* Detailed large: the phone number and the call button are displayed too.

==== Limit displayed calls in waiting queues section ====
Different view of incoming calls in the waiting queues section
* If disabled: a long list of incoming calls will be shown.
* If enabled: a short list of incoming calls will be shown and a scrollbar will appear in this section
** Fix WQ height optional with height setting between 0 and 50
The amount of showed calls in both scenarios depends on the used display size and resolution configuration (adaptive design)

==== Select monitored device ====
If a device is selected, all the calls from/to that device will be monitored by the app.

==Additional information==
===Licensing===
* When using the OperatorV13 license in a pre V13r2 release, and you want to use the Switchboard App instead in a > V13r2, you need to download a new license file from my.innovaphone
* Upgrade from Operator, the Operator13 license will result in 3 times App(innovaphone-switchboard)13 in addition.

===Reverse Lookup from Contacts===
For Reverse Lookup to work both for Queue-calls as Operator-calls, the Directory must have the correct Access Rules:
* if the directory has no ACL-rules => will work for Queue- and Operator Calls
* if the directory has ACL-rules => a rule for each object (WQ and Operator) must apply:
** the name of the WQ/Operator-object
** an active group of the WQ/Operator

===Info field for BLF contact details, Operator Note===
The Switchboard Operator can use the Contacts App to add or edit the contact details with the Info field, to show additional information like an "Operator Note".

The information added to the Info field, will be shown in the detailed view of a BLF Contact or in the detailed view of a searched contact at the bottom as additional information aka "Operator Note"

==Known issues==
* When closing the Switchboard App, the user will be logout of all the waiting queues groups. When opening the app again, the user will be automatically logged-in on this groups again. (This is by design)
* Shortcuts may not be triggered on the Switchboard App if the app is not on focus. For this just click on the UI of the app.
* If a softphone is being monitored, the Softphone App must be opened on background. Otherwise the RCC-API will not sent calls information to the Switchboard App. Since >= V13r3 this will be done automatically.
* If no (soft)phone device has been selected on the hamburger menu of the Switboard App, the calls may be displayed duplicated because that means that the app is monitoring all the devices. To avoid this please select your default (Soft)Phone App on the phone devices section.
* When using the Softphone App with the same name and hardware-id on multiple devices (PC and Smartphone) an incoming call will be shown more than once, depending on the amount of used devices. You can add a Softphone with different naming and hardware-ID for the Switchboard User to use with the Switchboard App only.
* As Switchboard App "Operator" you will work mainly with the Switchboard App. To have video from internal callers, you need to have a (Soft)Phone App open in the background. Deselect your Default Phone device in the myApps otherwise this App will get focus during the incoming call and on connect after answering a call. Best Practice to undock the Video from your (Soft)Phone App in the background and deselect the option "Bring AppSharing/Video always to front" as this would bring your (Soft)Phone App to the front as well.
* When using Softphone App on X multiple devices, incoming calls will be displayed X multiple times. In scenarios where the Switchboard App user has multiple devices with myApps(Smartphone, tabblet, PC) it might make sense to create a Softphone with different name for each device or at least for the device where you want to use the Switchboard App with the Softphone App. Using different names for the Softphones, creates respectively different hardware-ID's. This assures that only the selected specific Softphone App and device will be monitored by the Switchboard App based on this specific name and HW-ID.
* If LDAP contacts are not displayed on the search results, please check if the rights for the LDAP object have been given to the Switchboard App.
* It is possible that the app instance needs to be restarted if the PBX name has changed on the hamburger menu of the Switchboard Admin App.
* Use unique group name per waiting queue. The Group and group name, assigned to your waiting queue, should not be (re)used for other Waiting Queues or other groups.

==Trouble shooting==
* If any issue can be reproduced, open the console output of your browser or right-click and inspect in the native client version of the Switchboard App. Clear the console output and reproduce the issue and copy past the output as a textfile and send this attached in your support ticket.

==Related Articles==
* SDK Integration (if the content is available)

Reference16r1:Concept App Service Queues

2026-03-16T09:29:41Z

Kpe: /* V16 Improvements */

[[Category:Concept|Apps]]
The Queues App Service can be installed on an innovaphone App Platform and will provide services for several Apps that can be used to manage calls and waiting queues with myApps. For example the Switchboard App.

== Applies To ==

* innovaphone PBX from version 16r1final

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V16r1xx
* UsersAdminApp
* (Soft)PhoneApp
* ProfileApp
* CalllistApp
* Calllist-API
* RCC-API
* configured Waiting Queues in the PBX
* configured group(s) in the PBX assigned as "Static" and "Active" to the Waiting Queue
* License “App(innovaphone-switchboard)13” (order no. 02-00050-007) per application-user
* A dedicated group(queues) in the PBX assigned as "Static" to all Waiting Queues used by the Switchboard App and assigned as "Static and Active" to all Switchboard Users

==V16 Improvements==
'''Show call diversions for the favorites section in the BLF.''' 
This feature shows, with a colored label in the BLF entry, the configured call forwarding from the respective User. The color of the label depends on the type of configured forwarding, CFNR (orange/yellow), CFB (red) or CFU (purple). A click on the label, shows the configured forwarding destination.

'''Breakthrough of call diversions from BLF in favorites section.''' 
With a new icon (handset with arrow) it is possible to call to the User with a Call forward and breakthrough this call forward. This applies for CFB and CFU. In case of a CFNR the CFx-breakthrough does not apply because the call rings first at the user and after the configured timer the CFNR will be executed.

'''Edit mobility destination for users.''' 
An improvement for changing the mobility destination of the users.

'''Enable numeric + key as shortcut for transfer option.''' 
The Switchboard App now supports the shortkey + as shortkey for the transfer functionality.

'''Focus on second call for easier transfer ''' 
When starting a second call in the Switchboard App, the focus will be in the call section on this second call, so that a transfer can be initiated immediately by pressing the configured short-cut, for example the numeric + key. In case the focus is in the search field, press the TAB key first.

'''Call state in outgoing call section.''' 
When having an outgoing call, the status of this call (ringing or connected) will be shown in this outgoing call for a more user-friendly and intuitive feedback.

'''Notes for in- and outgoing calls in connect.''' 
When having an in- or outgoing call, you can add a note for this call in the Connect App. When a new call arrives, the Note can be consulted as additional information about this caller or called number.

'''Callback request email during a call.''' 
When having a call, a callback request per email can be generated. The email will have available callinformation already preloaded, like name, number and email-address of the caller if available.

'''Show Notes button in the Call History.'''

Action key in the call history items to jump to the corresponding Notes in the Connect App.

'''Show fold/ unfold view for adjusting WQ height in Config'''

changed design for configuring the showed Waiting Queue call section height.

'''Show Blf slider in Icons only view'''

when selected the Icons only view of the BLF a slider will be shown.

'''Improved search funcionality.'''

The improved search functionality is in line with the (Soft)Phone App search showing the source of the search result.

'''Improved search details.'''

Improved the shown details from a search result and showing more info in the BLF entry details.

'''Create a popup box for already existing shortcuts.'''

In case you enter a short cut that already excist, it will give you a warning that this shortcut is already created.

'''ed.''' 
Fixed breakthrough option/button was not updated (added/removed) when eg a CFu is set/removed.

'''Fix: Issue added users not visible immediately in BLF.''' 
Show users immediately in the BLF after adding them to a group.

'''Fix: Issue missing call-leg2 Info.''' 
Missing Call-leg2 Info now showed after connecting a Call.

'''Fix: Issue to many calls when starting call forward breakthrough.''' 
Fixed call forward breakthrough that leaded to many calls.

'''Fix: Issue to less space between buttons in BLF Details.''' 
Fixed the space between buttons in BLF user details.

'''Fix: Issue with Queues-plugin Group Configuration.''' 
The Display Name was wrongly used as User Identifier/Common Name to assign the 'queue'-group.

'''Fix: Issue Display of mismatched number with name in outgoing calls.''' 
Fixed the display of mismatched number with name in outgoing calls section on pickup.

'''Fix: Issue with missing CFx on a user after a change by the Switchboard App.''' 
Fixed the forwardings stored in PBX after a change by the Switchboard App.

'''Fix: Issue Users displayed multiple times when we click on BLF duplication button.''' 
Fixed the behavior when we click on BLF duplication button.

'''Fix: Issue when Transfer-button clicked twice.''' 
Fixed when transfer-button clicked twice, the transfer button was not removed on second call.

'''Fix: Issue Missing call after selecting IVR option.''' 
Fixed when selecting IVR option, show the waiting Queue again in the call panel section.

'''Fix: Issue transfer button shown on active calls.''' 
Fixed don't show the transfer button on active calls.

'''Fix: Show CFx Icon on toggling from large to small Icon view'''

Fixed to show the Call Forward Icon in the small view of the Busy Lamp Field.

'''Fix: Favorites did have less actions than other contacts in the BLF'''

Fixed to show all possibile actions on the BLF entries in the favorites section

'''Fix Add option to fix WQ height in config'''

Fixed added option to waiting queues height configuration

'''For further fixes to come with future service releases, please consult our release notes accordingly.''' 

== Apps ==
=== Switchboard App (innovaphone-switchboard) ===
[[Image: Switchboard-App.png|50px|switchboard-app.png/|switchboard-app.png/]]

The Switchboard App is an attendant workstation integrated into the myApps user interface. At a switchboard workstation, an employee of a company or a telephone network operator can process incoming calls and connection requests from external or internal callers. An employee can accept connections, request information, put calls on hold, transfer them to the desired destination, or reject the connection. The calls displayed are the ones from the monitorized phone device and they are managed using the RCC-API. The Switchboard App needs a license per Switchboard user, called the Switchboard App.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard</pre>
;Websocket
;TableUsers: to be able to replicate the users for the BLF
;Admin: to be able to edit the User object to monitor or un-monitor a waiting queue
;PbxApi: to edit the presence information
;RCC: to use the RCC API to manage the calls
;Impersonation: to get the Phone App favorites

=== Switchboard Admin App (innovaphone-switchboard-admin) ===
[[Image: Innovaphone-switchboard-admin.png|50px|innovaphone-switchboard-admin.png/|innovaphone-switchboard-admin.png/]]

With the Switchboard Admin App an administrator can manage the user(s) rights, can assign waiting queues to users and can pre-configure the Busy Lamp Field BLF.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard-admin</pre>
;Websocket
;TableUsers: to be able to replicate the users from the PBX
;Admin: to be able to assign the waiting queue groups to the user

== PBX Manager Plugins ==

=== Queues ===

With the Queues plugin the Switchboard App and Switchboard Admin App Objects can be created, edited and deleted on the PBX.

==Configuration==
# Install the Queues App
#* Option 1: Settings Apps/App Installer plugin - Search and Install the Queues App or
#* Option 2: AP Manager/App Store:
#** Search and Install the Queues App
#** Create an Instance of the Queues App
#** Start the created instance
# Settings App/Queues Plugin - Create the necessary App Objects:
#* Switchboard App: e.g. 'Switchboard'/'switchboard'
#* Switchboard Admin App: e.g. 'Switchboard Admin'/'switchboard-admin'
# Assign the Switchboard App and License to the correct users (can be done User- or Config Template-based)
# Assign the Switchboard Admin App to the correct Admin-users (can be done User- or Config Template-based)
# Configure Master PBX via the Switchboard Admin App Settings (optional with a single PBX):
#* PBX Name: PBX Name (PBX/Config/General/PBX Name) of the Master PBX
#* DNS (optional): DNS Name (PBX/Config/General/PBX Name) of the Master PBX Restart the Queues Instance after changing (so the App Objects can re-connect).
# Configure Waiting Queues via the Settings App/Waiting Queues Plugin or check existing Waiting Queues:
#* Waiting Queues monitored by the Switchboard App must have a '''Primary Group''' (used by the Switchboard Admin App to assign groups to Users)
#* Waiting Queues monitored by the Switchboard App must '''not''' have the ''''Operator connect for SOAP''''-checkbox ticked (needed to release calls correctly when taken/accepted by another Switchboard User)
# Create a Monitoring Group '''queues''' for the Switchboard (Admin) App. This can be done easily via the Queues Plugin of the Settings App (Groups configuration) or via the Advanced UI of the PBX:
#* '''Waiting Queues''' to be seen by the Switchboard App must have this group assigned '''Static only'''
#* '''Switchboard Users''' must have this group assigned '''Static and Active'''
# Configure the Switchboard Users via Switchboard Admin App:
#* Assign the correct rights / Waiting Queues to be monitored
#* (Optional) Create or Assign an already created Busy Lamp Field
# Adjust the Switchboard User Object and Phone Config (can also be done via a Config Template (desk phones only)):
#* Object: '''Untick 'Twin Phones'''' => Picking alerting calls (BLF or Waiting Queue-section) is possible
#* (Soft)Phone: '''Enable 'Call Waiting'''' => handling of multiple calls is possible (e.g. pickup call while there is an already alerting call)
# (Optional) Adjust the PBX/Phone/myApps/UsersAdmin App Config for better usage:
#* PBX: Configure the Recall Timeout of the PBX (PBX/Config/General/Recall Timeout) => Blind Transferred calls can be taken back
#* Phone: Configure a Park-key on the phone(s) of the Switchboard User(s) => visual/audio reminder of Parked Calls after X seconds
#* myApps: Deselect the default (Soft)Phone App + Untick the "Bring AppSharing/Video always to front" in your (Soft)Phone App => prevention of the (Soft)Phone App to popup.
#* UsersAdmin App: Tick the 'Privacy/Display e-mail address' in the Settings of the Users Admin, so that a callback-button is shown for User-search results.
# Open the Switchboard App and Select a (Soft)Phone to be controlled in the Settings/Hamburger Menu

'''Note''': Make sure to close the Switchboard App of the user when adjusting the config this user via the Switchboard Admin App. This ensure that changes are not overwritten again with the old values.

==Switchboard Admin App - User interface==
When opening the Switchboard Admin App the Switchboard Admin App shows only a search field at start (since release V14r1).
It will not list all users anymore, which speeds up the start of the App in big environments with many users.
At this point, closing the Switchboard Admin App, doesn't make any changes to the Switchboard App database.

Before doing any changes for any switchboard user, make sure that this user has closed the Switchboard App. Perform the changes, and afterward the Switchboard App user can reopen the Switchboard App and the changes will be applied.

===Search field===
Search for the user of your choice by typing its name.
The users details include their configured CFx since V15r1 and up.
When multiple user are shown, select the correct user.
The more detailed information (Rights / Busy lamp field) shown is retrieved from the Switchboard App database, while the existing user's group membership of the configured waiting queues, is retrieved from the PBX.

===Rights===
Here, you can define the rights of the Switchboard App user:
* Edit waiting queues: the user is allowed to add or delete waiting queues in the Switchboard App, to receive calls from.
* Edit presence: the user is allowed to change the presence state and presence note from other users in the system.
* Edit call diversions and mobility: the user is allowed to change other user's call forwards, mobility and its destinations.

===Waiting Queues===
This section shows the membership of primary group activity from the respective waiting queue.
This information is retrieved from the PBX. Changes will be saved into the PBX and the Switchboard App database.
Be aware that when making any changes to the selected user, it will be saved in the PBX and the Switchboard App database as well.
It might overwrite the latest group membership change done by the Switchboard App user itself. 
To make sure that your Administrative group membership settings will apply, make sure that the user's Switchboard App is closed before doing any changes. 
You might want to verify the user's preferred settings before, to apply them respectively with your changes.

The, in the PBX manager, pre-configured waiting queues will be shown to select the possible group membership. The possible choices are:
* Off: this waiting queue will not be shown in the user's Switchboard App for login.
* Dynamic-In: this waiting queue will be shown in the user's Switchboard App and the user is automatically logged-in the group with the start of the App (the user logs off from the group when closing the Switchboard App).
* Dynamic-Out: this waiting queue will be shown in the user's Switchboard App and the user is logged-off at start of the App (the user logs off from the group when closing the Switchboard App).
* Static: this waiting queue will be shown in the user's Switchboard App and the user is static in the group without the option to log-off (the user stays active in the group after closing the Switchboard App).

===Busy Lamp Field===

The Busy Lamp Field (BLF) section in the Switchboard Admin App, allows you, as admin, to pre-define the BLF groups and the PBX Users in the groups.
There is also the option to copy an already configured BLF from another user and edit it to your preferences.

==Switchboard App - User interface==
[[File:Switchboard app user interface.png|thumb|switchboard_app_user_interface.png/|switchboard_app_user_interface.png/]]
The user interface is divided in 3 panels:
* Left panel : Busy Lamp Field and users search
* Central panel: Calls
* Right panel: Waiting queues and calls history

There is also a hamburger menu, where some configuration settings can be edited.

=== Left panel ===
==== Busy Lamp Field ====
[[File:Switchboard app BLF contact.png|thumb|switchboard_app_blf_contact.png/|switchboard_app_blf_contact.png/]]
The '''BLF''' is displayed on the left panel. There all the users replicated from the PBX are displayed and it can be undocked and displayed on another window.
Information displayed by user:
* Profile picture
* Presence
* Common name
* Phone number
* CFx label if a CFx is configured (destination of the CFx is visible with a click on the label)

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a call by using the phone button
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display users detailed contact information
* Create BLF groups
* Re-arrange BLF groups by moving one entry '''on top of''' another entry in order to place it '''before it'''.
* Add a user to a BLF group
* Delete a user from a BLF group by long press left mouse
* Call Breaktrough on configured CFB or CFU

The BLF contacts is limited to PBX users and Contacts from the Contacts App with the proper detailed information. A Name, sip-name and number must be available as minimum information

==== Users search ====
[[File:Switchboard app contact information search result.png|thumb|switchboard_app_contact_information_search_result.png/|switchboard_app_contact_information_search_result.png/]]
The '''users search''' (Search-API) can be done with the input field. This input field can also be used to directly dial using the phone button.
Information displayed by user:
* Profile picture
* Presence
* Common name
* CFx if configured

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a chat
* Start a call
* Start a Breakthrough call on CFB or CFU
* Send an email
[[File:Switchboard app BLF contact information detailed.png|thumb|switchboard_app_blf_contact_information_detailed.png/|switchboard_app_blf_contact_information_detailed.png/]]
The user '''details''' can also be expanded by clicking on the arrow icon.
Data displayed (read only) for the user:
* Profile picture
* Common name
* SIP
* Phone number
* Email
* PBX
* Node

Data displayed that can also be edited for the user (if the user has the appropriate rights):
* Presence note
* Presence
* Call diversions
* Mobility

Actions allowed:
* Start a chat
* Start a call (by SIP and phone number)
* Send an email
* Send a "Call me back" notification by email
* Add the user to a BLF group

=== Center panel ===
On the center panel the calls are displayed.

==== Calls ====
The calls are divided in 5 sections: in the waiting queue, incoming, outgoing, parked and transferred.

Depending on the call state, different '''actions''' are allowed to manage the calls:
* Connect/Disconnect a call
* Mute/Unmute a call
* Hold/Release a call
* Park/Unpark a call
* Transfer a call to a user or connect 2 calls
* Pick up a transferred call or a call from the waiting queue

=== Right panel ===
On the right panel the waiting queues and the calls history are displayed.

==== Waiting Queues ====
On the right panel the '''waiting queues''' are displayed. They can be added by clicking on "Add waiting queue" (only displayed if the user has the appropriate right), which will automatically add the user to the given group. The calls will be displayed on the calls section and from there they can be picked up or transferred to an user.

==== Calls history ====
On this panel also the '''calls history''' is displayed, which is received from the Call List-API.

Information displayed on entry:
* Call flow
* Call information (source/destination, date and duration)

Actions allowed:
* Start a call
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display contact information
* Add the user to a BLF group

=== Hamburger menu ===
On the hamburger menu the '''shortcuts''' can be edited and the size of the users items from the BLF can be customized.
==== Edit shortcuts ====
To edit a shortcut, the shortcut must be selected and then the desired key pressed. Afterwards it has to be clicked again to finish the editing. To remove a shorcut, select the shortcut and press the "Del" key on your keyboard.

==== Size of the user items (BLF) ====
There are 2 different size:
* Icons only: only the profile picture, presence and common name will be displayed.
* Detailed large: the phone number and the call button are displayed too.

==== Limit displayed calls in waiting queues section ====
Different view of incoming calls in the waiting queues section
* If disabled: a long list of incoming calls will be shown.
* If enabled: a short list of incoming calls will be shown and a scrollbar will appear in this section
** Fix WQ height optional with height setting between 0 and 50
The amount of showed calls in both scenarios depends on the used display size and resolution configuration (adaptive design)

==== Select monitored device ====
If a device is selected, all the calls from/to that device will be monitored by the app.

==Additional information==
===Licensing===
* When using the OperatorV13 license in a pre V13r2 release, and you want to use the Switchboard App instead in a > V13r2, you need to download a new license file from my.innovaphone
* Upgrade from Operator, the Operator13 license will result in 3 times App(innovaphone-switchboard)13 in addition.

===Reverse Lookup from Contacts===
For Reverse Lookup to work both for Queue-calls as Operator-calls, the Directory must have the correct Access Rules:
* if the directory has no ACL-rules => will work for Queue- and Operator Calls
* if the directory has ACL-rules => a rule for each object (WQ and Operator) must apply:
** the name of the WQ/Operator-object
** an active group of the WQ/Operator

===Info field for BLF contact details, Operator Note===
The Switchboard Operator can use the Contacts App to add or edit the contact details with the Info field, to show additional information like an "Operator Note".

The information added to the Info field, will be shown in the detailed view of a BLF Contact or in the detailed view of a searched contact at the bottom as additional information aka "Operator Note"

==Known issues==
* When closing the Switchboard App, the user will be logout of all the waiting queues groups. When opening the app again, the user will be automatically logged-in on this groups again. (This is by design)
* Shortcuts may not be triggered on the Switchboard App if the app is not on focus. For this just click on the UI of the app.
* If a softphone is being monitored, the Softphone App must be opened on background. Otherwise the RCC-API will not sent calls information to the Switchboard App. Since >= V13r3 this will be done automatically.
* If no (soft)phone device has been selected on the hamburger menu of the Switboard App, the calls may be displayed duplicated because that means that the app is monitoring all the devices. To avoid this please select your default (Soft)Phone App on the phone devices section.
* When using the Softphone App with the same name and hardware-id on multiple devices (PC and Smartphone) an incoming call will be shown more than once, depending on the amount of used devices. You can add a Softphone with different naming and hardware-ID for the Switchboard User to use with the Switchboard App only.
* As Switchboard App "Operator" you will work mainly with the Switchboard App. To have video from internal callers, you need to have a (Soft)Phone App open in the background. Deselect your Default Phone device in the myApps otherwise this App will get focus during the incoming call and on connect after answering a call. Best Practice to undock the Video from your (Soft)Phone App in the background and deselect the option "Bring AppSharing/Video always to front" as this would bring your (Soft)Phone App to the front as well.
* When using Softphone App on X multiple devices, incoming calls will be displayed X multiple times. In scenarios where the Switchboard App user has multiple devices with myApps(Smartphone, tabblet, PC) it might make sense to create a Softphone with different name for each device or at least for the device where you want to use the Switchboard App with the Softphone App. Using different names for the Softphones, creates respectively different hardware-ID's. This assures that only the selected specific Softphone App and device will be monitored by the Switchboard App based on this specific name and HW-ID.
* If LDAP contacts are not displayed on the search results, please check if the rights for the LDAP object have been given to the Switchboard App.
* It is possible that the app instance needs to be restarted if the PBX name has changed on the hamburger menu of the Switchboard Admin App.
* Use unique group name per waiting queue. The Group and group name, assigned to your waiting queue, should not be (re)used for other Waiting Queues or other groups.

==Trouble shooting==
* If any issue can be reproduced, open the console output of your browser or right-click and inspect in the native client version of the Switchboard App. Clear the console output and reproduce the issue and copy past the output as a textfile and send this attached in your support ticket.

==Related Articles==
* SDK Integration (if the content is available)

Howto:How to Reset IPXXX

2026-02-20T11:32:10Z

Kpe: /* More Information */

==Summary==
Reset options for innovaphone devices

==Applies To==
This information applies to

* All innovaphone products with the latest boot code.


==More Information==
Different options resetting innovaphone devices.

* bringing to Factory default
* bringing to TFTP mode for GWLoad
* clearing config
* explaining the LED behavior

Additional Information for the following table, TFTP-Mode or TFTP-Mode + FACTORY RESET for the phones IP110, IP150, IP200, IP202, IP230, IP240

Seperating the phone from the power, press the Key/Button, keep on pressing the Key/Button, plug in the PSU or ethernet cable (in case of PoE), watch the status of the device (table: visual display), release the Key/Button after time shown in the table. If you want to reanimate this devices now with GWLoad, do not powercycle the device again. If the factory reset was successful the device is now in the defined TFTP-Mode and ready for GWLoad. If you just wanted to factory reset the device you can do a powercycle for sure.

If the factory reset was not successful please contact rma@innovaphone.com

or look at [[Howto:Get Access to Gateways if the Assistant doesn't boot the Device]].

{| border=1
!Device (visual display)
!Reset Button/Key
!Button pressed
!Clear Config
Firmware
Boot code update
!Pressing Button to TFTP without deleting config in seconds ca.
!Pressing Button to factory reset in seconds ca.
!GWLoad- / TFTP-Mode
!Firmware starting
!Firmware ready
!Firmware Error
|----
|IP21
(all LED's)
|Button
|ready: <5s blink, >5s constant flash

line1 + line2 + door + aux constant flash / link + act off

with plugged in ethernet cable 100M + link: <3s off, >3s normal operating state
|...

ready fast blink, line1 + line2 + door + aux off link + 100M normal operating

|3
|25
|all LED’s are constant flashing

link is blinking
|ready + line1/2 + door + aux + 100M (if link)

permanent for ca. 5s

link blinking
|ready + 100M (if link)

link blinking
|
|----
|IP400
(all LED’s)
|Button
|PPP+Tel.1+Tel.2: <5s blink, [5;8] constant flash, >8 ready + link + act constant flash

without ethernet cable plugged in: <8s off, 8s one blink, >8s off
|
|3
|25
|ready + link + act flashing constant
|<8 ready + PPP + tel1 + tel2 constant flash,

[3;10] link + act. uncoordinated flashing

>10s ready + link (if link) constant act. blinking
|ready + 100M (if link)

link blinking
|
|----
|IP3000
(all LED’s)
|Button
|<6s PRI1+PRI2+S/T+ready blink, [6;10] PRI1 + PRI2 + S/T + ready constant flash,

act + speed + link off

>10s PRI1 + PRI2 + S/T constant flash, ready + act + speed + link off

with ethernet cable plugged in: act + speed + link normal working state
|fast blink (green)
|3
|25
|all LED’s flashing permanent

ready off

link blinking
|>2 link + speed constant flashing, act blinking

<5s PRI1 + PRI2 + S/T constant flash

>5s ready constant flash, (if link) link + speed constant flashing, act blinking
|ready constant flash, (if link) link + speed constant flashing, act blinking
|blinking (green)
|----
|IP800/IP6000/IPx010
(red/green/orange ready LED )
|Button
|<6 slow gn blink

[6;10] constant red

[10;13] fast gn blink

<13 constant orange
|fast blink (green)
|3
|15 (IP800)

15-20 (IP6000/IPx010)
|constant orange
|red
|green
|blinking (red)
|----
|IP1200
|Button
|<2s alarm red constant flash, ready off

[2;7] alarm off, ready slow blink green

[7;13] alarm off, ready fast blink green

>13s alarm off, ready 2 Hz blink green
|fast blink
|3
|10
|slow flash ca. 2 Hz
|<2s alarm red constant flash

ready green constant flash

power orange constant flash

[2;4] alarm off, ready off, power orange

>4s alarm off, ready constant green flash, power constant green flash
|ready constant green flash and power constant orange flash
|alarm (red)
|----
|IP1202/IP1203
|Button
|<3s LED off

[3;10] LED blink fast blue 1 sec

>10s LED blink fast blue 1 sec,
than blink slow blue until factory reset completed,
than constant yellow/amber
|fast blink in blue
|3
|10
|constant yellow/amber
|LED red until firmware lstarted

LED blink fast red until ethernet link up

LED blink fast blue until Air Sync established

LED constant blue if Air Sync OK

|LED constant blue
|LED constant red
|----
|IP200/IP202
(red handset)
|alt key
|slow blink
|slow blink
|3
|5
|constant flash
|slow blink
|off
|constant flash
|----
|IP200A/IP210
(red handset)
|alt key
|slow blink
|fast blink
|3
|15
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP110
(LED’s in F1 key)
|save key
|slow blink
|F1 off
|3
|10 - 15
|slow flash
ca. 2 Hz
|constant F1 flash
|off
|blinking
|----
|IP101
(MWI LED)
|backspace key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP102
(MWI LED)
|backspace key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP111
(MWI LED)
|home key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP112
(MWI LED)
|home key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP150
|menu key
|press key when power cycle, hold till display flashing and goes off. Power cycle again
|
|
|
|
|
|
|
|----
|IP160
|star key
|press key when power cycle, hold ca 15 sec till display is on
|
|
|
|
|
|
|
|-
|IP17x
|button
|press button on PCB board when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP230
(menu key)
|menu key
|slow blink
|fast blink
|3
|10
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP240
(menu key)
|menu key
|slow blink
|fast blink
|3
|10
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP241
(menu key)
|alt key
|slow blink
|fast blink
|3
|10
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP222
(MWI LED)
|ESC key or Home key
|slow blink
|fast blink
|3
|15
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP232
(MWI LED)
|ESC key or Home key
|slow blink
|fast blink
|3
|15
|slow flash
ca. 2 Hz
|on
|off
|blinking
|-
|IP270
|Home key
|press key when power cycle, hold until LED remains steady
|
|
|
|
|
|
|
|}

== Related Articles ==
* [[Howto:How to use gwload]]
* [[Howto:How_to_Reset_IPXXX_(V10...)]]

[[Category:Howto|{{PAGENAME}}]]

Howto:How to Reset IPXXX

2026-02-20T11:31:04Z

Kpe: /* More Information */

==Summary==
Reset options for innovaphone devices

==Applies To==
This information applies to

* All innovaphone products with the latest boot code.


==More Information==
Different options resetting innovaphone devices.

* bringing to Factory default
* bringing to TFTP mode for GWLoad
* clearing config
* explaining the LED behavior

Additional Information for the following table, TFTP-Mode or TFTP-Mode + FACTORY RESET for the phones IP110, IP150, IP200, IP202, IP230, IP240

Seperating the phone from the power, press the Key/Button, keep on pressing the Key/Button, plug in the PSU or ethernet cable (in case of PoE), watch the status of the device (table: visual display), release the Key/Button after time shown in the table. If you want to reanimate this devices now with GWLoad, do not powercycle the device again. If the factory reset was successful the device is now in the defined TFTP-Mode and ready for GWLoad. If you just wanted to factory reset the device you can do a powercycle for sure.

If the factory reset was not successful please contact rma@innovaphone.com

or look at [[Howto:Get Access to Gateways if the Assistant doesn't boot the Device]].

{| border=1
!Device (visual display)
!Reset Button/Key
!Button pressed
!Clear Config
Firmware
Boot code update
!Pressing Button to TFTP without deleting config in seconds ca.
!Pressing Button to factory reset in seconds ca.
!GWLoad- / TFTP-Mode
!Firmware starting
!Firmware ready
!Firmware Error
|----
|IP21
(all LED's)
|Button
|ready: <5s blink, >5s constant flash

line1 + line2 + door + aux constant flash / link + act off

with plugged in ethernet cable 100M + link: <3s off, >3s normal operating state
|...

ready fast blink, line1 + line2 + door + aux off link + 100M normal operating

|3
|25
|all LED’s are constant flashing

link is blinking
|ready + line1/2 + door + aux + 100M (if link)

permanent for ca. 5s

link blinking
|ready + 100M (if link)

link blinking
|
|----
|IP400
(all LED’s)
|Button
|PPP+Tel.1+Tel.2: <5s blink, [5;8] constant flash, >8 ready + link + act constant flash

without ethernet cable plugged in: <8s off, 8s one blink, >8s off
|
|3
|25
|ready + link + act flashing constant
|<8 ready + PPP + tel1 + tel2 constant flash,

[3;10] link + act. uncoordinated flashing

>10s ready + link (if link) constant act. blinking
|ready + 100M (if link)

link blinking
|
|----
|IP3000
(all LED’s)
|Button
|<6s PRI1+PRI2+S/T+ready blink, [6;10] PRI1 + PRI2 + S/T + ready constant flash,

act + speed + link off

>10s PRI1 + PRI2 + S/T constant flash, ready + act + speed + link off

with ethernet cable plugged in: act + speed + link normal working state
|fast blink (green)
|3
|25
|all LED’s flashing permanent

ready off

link blinking
|>2 link + speed constant flashing, act blinking

<5s PRI1 + PRI2 + S/T constant flash

>5s ready constant flash, (if link) link + speed constant flashing, act blinking
|ready constant flash, (if link) link + speed constant flashing, act blinking
|blinking (green)
|----
|IP800/IP6000/IPx010
(red/green/orange ready LED )
|Button
|<6 slow gn blink

[6;10] constant red

[10;13] fast gn blink

<13 constant orange
|fast blink (green)
|3
|15 (IP800)

15-20 (IP6000/IPx010)
|constant orange
|red
|green
|blinking (red)
|----
|IP1200
|Button
|<2s alarm red constant flash, ready off

[2;7] alarm off, ready slow blink green

[7;13] alarm off, ready fast blink green

>13s alarm off, ready 2 Hz blink green
|fast blink
|3
|10
|slow flash ca. 2 Hz
|<2s alarm red constant flash

ready green constant flash

power orange constant flash

[2;4] alarm off, ready off, power orange

>4s alarm off, ready constant green flash, power constant green flash
|ready constant green flash and power constant orange flash
|alarm (red)
|----
|IP1202/IP1203
|Button
|<3s LED off

[3;10] LED blink fast blue 1 sec

>10s LED blink fast blue 1 sec,
than blink slow blue until factory reset completed,
than constant yellow/amber
|fast blink in blue
|3
|10
|constant yellow/amber
|LED red until firmware lstarted

LED blink fast red until ethernet link up

LED blink fast blue until Air Sync established

LED constant blue if Air Sync OK

|LED constant blue
|LED constant red
|----
|IP200/IP202
(red handset)
|alt key
|slow blink
|slow blink
|3
|5
|constant flash
|slow blink
|off
|constant flash
|----
|IP200A/IP210
(red handset)
|alt key
|slow blink
|fast blink
|3
|15
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP110
(LED’s in F1 key)
|save key
|slow blink
|F1 off
|3
|10 - 15
|slow flash
ca. 2 Hz
|constant F1 flash
|off
|blinking
|----
|IP101
(MWI LED)
|backspace key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP102
(MWI LED)
|backspace key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP111
(MWI LED)
|home key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP112
(MWI LED)
|home key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP150
|menu key
|press key when power cycle, hold till display flashing and goes off. Power cycle again
|
|
|
|
|
|
|
|----
|IP160
|star key
|press key when power cycle, hold ca 15 sec till display is on
|
|
|
|
|
|
|
|-
|IP17x
|button
|press button when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP230
(menu key)
|menu key
|slow blink
|fast blink
|3
|10
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP240
(menu key)
|menu key
|slow blink
|fast blink
|3
|10
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP241
(menu key)
|alt key
|slow blink
|fast blink
|3
|10
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP222
(MWI LED)
|ESC key or Home key
|slow blink
|fast blink
|3
|15
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP232
(MWI LED)
|ESC key or Home key
|slow blink
|fast blink
|3
|15
|slow flash
ca. 2 Hz
|on
|off
|blinking
|-
|IP270
|Home key
|press key when power cycle, hold until LED remains steady
|
|
|
|
|
|
|
|}

== Related Articles ==
* [[Howto:How to use gwload]]
* [[Howto:How_to_Reset_IPXXX_(V10...)]]

[[Category:Howto|{{PAGENAME}}]]

Howto:Update innovaphone.com Wildcard-Certificate in a Device Trustlist

2026-02-05T14:58:50Z

Kpe: /* Applies To */

'''This article is obsolete for the push service, please see [[Howto13r2:12r2/13r1 legacy push server will be migrated to push.innovaphone.com]]'''

==Applies To==
This information applies to
* All innovaphone IP-Phones and -Gateways with 12r2, 13r3, 14r1, 14r2 firmware and > V15r1 firmware and no Devices certificate deployment configured.

==More Information==

===Problem Details===
On the end date of the current certificate <code>*.innovaphone.com</code> it will expire. '''We will renew this certificate every year on time.''' This certificate is used in the PBX trust list to establish an encrypted connection between your PBX and the innovaphone services.
To ensure that a service also works for your customers after the excisting certificate end date, a new vlid certificate must be added to the trust list of the respective PBX.
After the excisting certificate end date, the old <code>*.innovaphone.com</code> certificate can be deleted.
This certificate is currently only relevant for gateways on which a service connection to innovaphone is established. During the transition period of the release of a new certificate and the end date of the old certificate, both <code>*.innovaphone.com</code> certificates are required.

Additionally, every time an innovaphone devices is restarted, the current <code>*.innovaphone.com</code> certificate generates a [[Reference9:Event/0x000c1001| x509: A certificate has expired or will expire soon]] event.

'''If you use the [[Reference14r2:Concept App Service Devices#Certificates configuration|Devices - certificate trustlist concept]] you are not affected, and the certificate will be installed automatically.'''

===Resolution===
Here are three ways to replace the certificate on all innovaphone devices.

1. In the version 12r2sr72, 13r3sr22, 14r1sr10 and 14r2sr5 the certificate will be added automatically during the update.
After the old certificate end date, it can be manually deleted. Also, current firmware includes a mechanism to prevent ''Certificate expiration events'' in case that a new certificate exists for the same CN.
Finally, devices with 12r2sr72, 13r3sr22, 14r1sr10 and 14r2sr5 firmware will have after a factory reset only the new *.innovaphone.com certificate.

2. The certificate can be added manually on the PBX. It can be downloaded [[:File:Star innovaphone cert 2025.zip|here]] and then be uploaded on the PBX under [[Reference14r2:General/Certificates&action=edit&redlink=1|General/Certificates/Trust list]].
After 27.12.2024, the old certificate can be manually deleted.

3. The new certificate can be added, and the old certificate can be deleted via commands (which can be sent using an update server or the [[Reference14r2:Concept App Service Devices#Expert configuration| Expert configuration]] in ''Devices''). This needs a reboot of the device.
Save the new certificate in the trust list:
!vars create X509/TRUSTED pba 3082063e30820526a00302010202107ac11bffa149788852b63d5a31ce0959300d06092a864886f70d01010b050030818f310b3009060355040613024742311b30190603550408131247726561746572204d616e636865737465723110300e0603550407130753616c666f726431183016060355040a130f5365637469676f204c696d69746564313730350603550403132e5365637469676f2052534120446f6d61696e2056616c69646174696f6e2053656375726520536572766572204341301e170d3234313132393030303030305a170d3235313233303233353935395a301c311a301806035504030c112a2e696e6e6f766170686f6e652e636f6d30820122300d06092a864886f70d01010105000382010f003082010a0282010100b94fa779dc824ea7e561d83ed2f2b3fd293752832526af285af8e728668323b3d7444e724dbd4a2792998c0eabbac0ec1fcb1ebc7db5dcb174cd74a8aa9763e3eeb2541f2302bcad45b3f4d09a95876ef15e670db519f5bd0b5092389f995e8e0a9241ee462fd34d3af41df4693b571b1bf1dfb4a74ab5a70e68e87c2c12c0e3be5b408ec4d61099f79338dcfa73277d4a237065946795753edb89c9f234329a7b5a47ebc87e86f779281b9381072e1db4f57a3b9f8df67bf65e6090d2ea2ab93deb0b9013b0f762977726c6708b33137d599f82c15c2d72a76e568e22a3fb717c9ddbc9e33b12aacb9fcb543df52f3520f117d0647617801a24d651709645fd0203010001a382030630820302301f0603551d230418301680148d8c5ec454ad8ae177e99bf99b05e1b8018d61e1301d0603551d0e04160414172bc6fe5fa1ed78d9f49257924a714a950d4503300e0603551d0f0101ff0404030205a0300c0603551d130101ff04023000301d0603551d250416301406082b0601050507030106082b0601050507030230490603551d20044230403034060b2b06010401b231010202073025302306082b06010505070201161768747470733a2f2f7365637469676f2e636f6d2f4350533008060667810c01020130818406082b0601050507010104783076304f06082b060105050730028643687474703a2f2f6372742e7365637469676f2e636f6d2f5365637469676f525341446f6d61696e56616c69646174696f6e53656375726553657276657243412e637274302306082b060105050730018617687474703a2f2f6f6373702e7365637469676f2e636f6d302d0603551d110426302482112a2e696e6e6f766170686f6e652e636f6d820f696e6e6f766170686f6e652e636f6d30820180060a2b06010401d679020402048201700482016c016a007700dddcca3495d7e11605e79532fac79ff83d1c50dfdb003a1412760a2cacbbc82a00000193788b6e35000004030048304602210095e474cfc8cb1391e90503117fbb02b3f218adc046ad654a742c554cea1aabb50221009ec6324267f294e3fd82042edc4f75b3d5045186a2c8d7a132cfb930040e6813007700ccfb0f6a85710965fe959b53cee9b27c22e9855c0d978db6a97e54c0fe4c0db000000193788b6df6000004030048304602210096c02ff89884ff81f1d1e06965cc8639e5775eda2548cdf6f1492fe9388edf1a022100f67955e0066763ba7f23020130fe625f9c41cbe5f49626ca71076202ffdece3300760012f14e34bd53724c840619c38f3f7a13f8e7b56287889c6d300584ebe586263a00000193788b6dd50000040300473045022100abec85798805aafecc03b4b9b6e0dbb2beab28b9a5d36ed5021a4fb40e477ed40220131255263bdf66bc618f9f531dedb249c30c6b5f98be23ced37100c7166571c2300d06092a864886f70d01010b05000382010100592acc609c02195145ee6abf875f3ced94e039f83e2f88022013ea40c65ae4738d80a07e518a28f996726422fefa2f53d04aa3635fe98c4c882132f86d92924bace80c185f6fea710bbf48ce12da24440651e6b58cf4f2101634a4c6ca506ea0a75a00266eca09f275d3389ae673fb48e9b587477ba642f95000b4331dd682426be4ac59dfc8e859f8771d1bf98fe7a95dade3f53844c774376f4ca2067953202ac4e1089bd179f124f3eac09d020eadf36b1b018caece0f7159c279801358f9b9b6f15e0d92b4784f5f49ba343b36baa1faab04ab29d6377ba2f9b8760b4a8ae88009de395c580ad97518697cb3a950762fe218b6d965a46eb0c6733f2017f7

Remove old certificate (optional):
!mod cmd X509 form /item-trusted-3ccaa98ee59e6fd2ae91299fab78970d4f9f39a37eed987b32982e6a8a201afb70f7068f on /trusted-delete Remove

===Additional Recommendation===

If you are still connected to the ''old'' push-service (services.innovaphone.com), we recommend switching to the new push-service described in the [[Howto13r2:12r2/13r1 legacy push server will be migrated to push.innovaphone.com| Push Migration (Shutdown planned for 31.12.2024)]]. We currently evaluate to change the certificate used on the push-service to an innovaphone CA-signed one, with a longer duration time.

== Related Articles ==
* [[Howto13r2:12r2/13r1_legacy_push_server_will_be_migrated_to_push.innovaphone.com]]
* [[Reference15r1:Concept App Service Devices#Certificates configuration]]

[[Category:Howto|{{PAGENAME}}]]

Howto:Update innovaphone.com Wildcard-Certificate in a Device Trustlist

2026-02-05T14:40:34Z

Kpe: /* Resolution */

'''This article is obsolete for the push service, please see [[Howto13r2:12r2/13r1 legacy push server will be migrated to push.innovaphone.com]]'''

==Applies To==
This information applies to
* All innovaphone IP-Phones and -Gateways with 12r2, 13r3, 14r1, 14r2, V15r1 firmware and no Devices certificate deployment configured.

==More Information==

===Problem Details===
On the end date of the current certificate <code>*.innovaphone.com</code> it will expire. '''We will renew this certificate every year on time.''' This certificate is used in the PBX trust list to establish an encrypted connection between your PBX and the innovaphone services.
To ensure that a service also works for your customers after the excisting certificate end date, a new vlid certificate must be added to the trust list of the respective PBX.
After the excisting certificate end date, the old <code>*.innovaphone.com</code> certificate can be deleted.
This certificate is currently only relevant for gateways on which a service connection to innovaphone is established. During the transition period of the release of a new certificate and the end date of the old certificate, both <code>*.innovaphone.com</code> certificates are required.

Additionally, every time an innovaphone devices is restarted, the current <code>*.innovaphone.com</code> certificate generates a [[Reference9:Event/0x000c1001| x509: A certificate has expired or will expire soon]] event.

'''If you use the [[Reference14r2:Concept App Service Devices#Certificates configuration|Devices - certificate trustlist concept]] you are not affected, and the certificate will be installed automatically.'''

===Resolution===
Here are three ways to replace the certificate on all innovaphone devices.

1. In the version 12r2sr72, 13r3sr22, 14r1sr10 and 14r2sr5 the certificate will be added automatically during the update.
After the old certificate end date, it can be manually deleted. Also, current firmware includes a mechanism to prevent ''Certificate expiration events'' in case that a new certificate exists for the same CN.
Finally, devices with 12r2sr72, 13r3sr22, 14r1sr10 and 14r2sr5 firmware will have after a factory reset only the new *.innovaphone.com certificate.

2. The certificate can be added manually on the PBX. It can be downloaded [[:File:Star innovaphone cert 2025.zip|here]] and then be uploaded on the PBX under [[Reference14r2:General/Certificates&action=edit&redlink=1|General/Certificates/Trust list]].
After 27.12.2024, the old certificate can be manually deleted.

3. The new certificate can be added, and the old certificate can be deleted via commands (which can be sent using an update server or the [[Reference14r2:Concept App Service Devices#Expert configuration| Expert configuration]] in ''Devices''). This needs a reboot of the device.
Save the new certificate in the trust list:
!vars create X509/TRUSTED pba 3082063e30820526a00302010202107ac11bffa149788852b63d5a31ce0959300d06092a864886f70d01010b050030818f310b3009060355040613024742311b30190603550408131247726561746572204d616e636865737465723110300e0603550407130753616c666f726431183016060355040a130f5365637469676f204c696d69746564313730350603550403132e5365637469676f2052534120446f6d61696e2056616c69646174696f6e2053656375726520536572766572204341301e170d3234313132393030303030305a170d3235313233303233353935395a301c311a301806035504030c112a2e696e6e6f766170686f6e652e636f6d30820122300d06092a864886f70d01010105000382010f003082010a0282010100b94fa779dc824ea7e561d83ed2f2b3fd293752832526af285af8e728668323b3d7444e724dbd4a2792998c0eabbac0ec1fcb1ebc7db5dcb174cd74a8aa9763e3eeb2541f2302bcad45b3f4d09a95876ef15e670db519f5bd0b5092389f995e8e0a9241ee462fd34d3af41df4693b571b1bf1dfb4a74ab5a70e68e87c2c12c0e3be5b408ec4d61099f79338dcfa73277d4a237065946795753edb89c9f234329a7b5a47ebc87e86f779281b9381072e1db4f57a3b9f8df67bf65e6090d2ea2ab93deb0b9013b0f762977726c6708b33137d599f82c15c2d72a76e568e22a3fb717c9ddbc9e33b12aacb9fcb543df52f3520f117d0647617801a24d651709645fd0203010001a382030630820302301f0603551d230418301680148d8c5ec454ad8ae177e99bf99b05e1b8018d61e1301d0603551d0e04160414172bc6fe5fa1ed78d9f49257924a714a950d4503300e0603551d0f0101ff0404030205a0300c0603551d130101ff04023000301d0603551d250416301406082b0601050507030106082b0601050507030230490603551d20044230403034060b2b06010401b231010202073025302306082b06010505070201161768747470733a2f2f7365637469676f2e636f6d2f4350533008060667810c01020130818406082b0601050507010104783076304f06082b060105050730028643687474703a2f2f6372742e7365637469676f2e636f6d2f5365637469676f525341446f6d61696e56616c69646174696f6e53656375726553657276657243412e637274302306082b060105050730018617687474703a2f2f6f6373702e7365637469676f2e636f6d302d0603551d110426302482112a2e696e6e6f766170686f6e652e636f6d820f696e6e6f766170686f6e652e636f6d30820180060a2b06010401d679020402048201700482016c016a007700dddcca3495d7e11605e79532fac79ff83d1c50dfdb003a1412760a2cacbbc82a00000193788b6e35000004030048304602210095e474cfc8cb1391e90503117fbb02b3f218adc046ad654a742c554cea1aabb50221009ec6324267f294e3fd82042edc4f75b3d5045186a2c8d7a132cfb930040e6813007700ccfb0f6a85710965fe959b53cee9b27c22e9855c0d978db6a97e54c0fe4c0db000000193788b6df6000004030048304602210096c02ff89884ff81f1d1e06965cc8639e5775eda2548cdf6f1492fe9388edf1a022100f67955e0066763ba7f23020130fe625f9c41cbe5f49626ca71076202ffdece3300760012f14e34bd53724c840619c38f3f7a13f8e7b56287889c6d300584ebe586263a00000193788b6dd50000040300473045022100abec85798805aafecc03b4b9b6e0dbb2beab28b9a5d36ed5021a4fb40e477ed40220131255263bdf66bc618f9f531dedb249c30c6b5f98be23ced37100c7166571c2300d06092a864886f70d01010b05000382010100592acc609c02195145ee6abf875f3ced94e039f83e2f88022013ea40c65ae4738d80a07e518a28f996726422fefa2f53d04aa3635fe98c4c882132f86d92924bace80c185f6fea710bbf48ce12da24440651e6b58cf4f2101634a4c6ca506ea0a75a00266eca09f275d3389ae673fb48e9b587477ba642f95000b4331dd682426be4ac59dfc8e859f8771d1bf98fe7a95dade3f53844c774376f4ca2067953202ac4e1089bd179f124f3eac09d020eadf36b1b018caece0f7159c279801358f9b9b6f15e0d92b4784f5f49ba343b36baa1faab04ab29d6377ba2f9b8760b4a8ae88009de395c580ad97518697cb3a950762fe218b6d965a46eb0c6733f2017f7

Remove old certificate (optional):
!mod cmd X509 form /item-trusted-3ccaa98ee59e6fd2ae91299fab78970d4f9f39a37eed987b32982e6a8a201afb70f7068f on /trusted-delete Remove

===Additional Recommendation===

If you are still connected to the ''old'' push-service (services.innovaphone.com), we recommend switching to the new push-service described in the [[Howto13r2:12r2/13r1 legacy push server will be migrated to push.innovaphone.com| Push Migration (Shutdown planned for 31.12.2024)]]. We currently evaluate to change the certificate used on the push-service to an innovaphone CA-signed one, with a longer duration time.

== Related Articles ==
* [[Howto13r2:12r2/13r1_legacy_push_server_will_be_migrated_to_push.innovaphone.com]]
* [[Reference15r1:Concept App Service Devices#Certificates configuration]]

[[Category:Howto|{{PAGENAME}}]]