innovaphone wiki - User contributions [en]

Technische gegevens IP174

2026-05-21T11:17:38Z

Vsc: Created page with "{{datasheet_header|innovaphone IP174|Opbouw intercom station}} <div class="datasheets-mehrspaltig"> Image:IP174-x.png ===Firmware=== Het toestel is compatibel met firmware versie 16 en hoger ===Behuizing=== * Wandmontage, Opbouwmontage behuizing * Voorijde speaker-80mm, 4 Ohm, plastic * IP66 Behuizing voor gebruik in de buitenlucht, stof- en waterdicht, bestand tegen zout en nevel * Folie toetsenbord * IP174-1: een snelkeuze toets * IP174-4: 4 snelkeuze toetsen * IP1..."

{{datasheet_header|innovaphone IP174|Opbouw intercom station}}
<div class="datasheets-mehrspaltig">
[[Image:IP174-x.png]]
===Firmware===
Het toestel is compatibel met firmware versie 16 en hoger
===Behuizing===
* Wandmontage, Opbouwmontage behuizing
* Voorijde speaker-80mm, 4 Ohm, plastic
* IP66 Behuizing voor gebruik in de buitenlucht, stof- en waterdicht, bestand tegen zout en nevel
* Folie toetsenbord
* IP174-1: een snelkeuze toets
* IP174-4: 4 snelkeuze toetsen
* IP174-15: 12 snelkeuze toets en telefoontoetsenbord
* Elke model: 3 toetsen voor gespreksmodus (handenvrij, direct/prioriteit, PTT), 2 volumetoetsen
Oproep indicator
* Afmetingen (W x D x H): 130 x 70 x 303 mm
* Gewicht: ca. 1500 grams

===Interfaces===
* 10/100-BASE-TX (auto negotiation), RJ-45 (modular Jack 8P8C)
* 24V PSU external power supply (input)
* 24V DC output (500mA)
* Relay (NO/NC)
* Handset (6-draads)
* Headset (6-draads) PTT ondersteuning
* Externe Speaker
* Achterzijde USB port - enkel voor intern gebruik

===Hardware===
* Voeding: „Power over Ethernet+“ volgens IEEE 802.3at, klasse 4
* 128MByte RAM, 16MByte Flash
* Werk temperatuur: +5 °C to +55 °C
* Luchtvochtigheid: 10% to 90% (niet condenserend)
* Opslag temperatuur: -10 °C to +70 °C
{{Template:Leistungsmerkmale NL - Sprach Coder|G.722, Opus-NB, Opus-WB}}
{{Template:Leistungsmerkmale NL - Voip Protokolle13}}
{{Template:Leistungsmerkmale NL - Netzwerk13}}

PPTP Tunneling tot 4 tunnels gelijktijdig, encoding via MPPE
{{Template:Leistungsmerkmale NL - Administration13}}
===Aanvullende functies===
* Handenvrij toets – Full duplex handenvrij bellen
* Directe oproep toets – Full duplex inbreken op toestellen die vrij of bezet zijn (kan uitgeschakeld worden)
* PTT toets – Terugspreken en klasieke PTT funktie gebruik (microfoon mute functie)
* Zone announcements – ongelimiteerde zones
{{Template:Leistungsmerkmale NL - Lizenzen Telefone}}
{{Template:CE-Decl_Phones|Conformiteiten|zie afzonderlijk informatieblad}}
===Bestelnummer IP174-1: 01-01741-001===
===Bestelnummer IP174-4: 01-01744-001===
===Bestelnummer IP174-15: 01-17415-001===
</div>
{{Template:Datasheet_footer|NL}}
[[Category:Technische gegevens Phones NL|{{PAGENAME}}]]

Technische gegevens IP172

2026-05-21T11:17:17Z

Vsc: Created page with "{{datasheet_header|innovaphone IP172|Industrieel opbouw intercom station}} <div class="datasheets-mehrspaltig"> Image:IP172.png ===Firmware=== Het toestel is compatibel met firmware versie 16 en hoger ===Behuizing=== * Wandmontage, Opbouwmontage behuizing * Achterzijde speaker-46mm, 50 Ohm, plastic, voor belsignaal * IP66 Behuizing voor gebruik in de buitenlucht, stof- en waterdicht, bestand tegen zout en nevel * Folie toetsenbord * 12 toetsen telefoontoetsenbord * 3..."

{{datasheet_header|innovaphone IP172|Industrieel opbouw intercom station}}
<div class="datasheets-mehrspaltig">
[[Image:IP172.png]]
===Firmware===
Het toestel is compatibel met firmware versie 16 en hoger
===Behuizing===
* Wandmontage, Opbouwmontage behuizing
* Achterzijde speaker-46mm, 50 Ohm, plastic, voor belsignaal
* IP66 Behuizing voor gebruik in de buitenlucht, stof- en waterdicht, bestand tegen zout en nevel
* Folie toetsenbord
* 12 toetsen telefoontoetsenbord
* 3 toetsen voor gespreksmodus (handenvrij, direct/prioriteit, PTT), 2 volumetoetsen
* Oproep indicator
* Afmetingen (W x D x H): 130 x 70 x 303 mm
* Gewicht: ca. 1500 grams

===Interfaces===
* 10/100-BASE-TX (auto negotiation), RJ-45 (modular Jack 8P8C)
* 24V PSU external power supply (input)
* 24V DC output (500mA)
* Relay (NO/NC)
* Handset (6-draads)
* Headset (6-draads) PTT ondersteuning
* Externe Speaker
* Achterzijde USB port - enkel voor intern gebruik

===Hardware===
* Voeding: „Power over Ethernet+“ volgens IEEE 802.3at, klasse 4
* 128MByte RAM, 16MByte Flash
* Werk temperatuur: +5 °C to +55 °C
* Luchtvochtigheid: 10% to 90% (niet condenserend)
* Opslag temperatuur: -10 °C to +70 °C
{{Template:Leistungsmerkmale NL - Sprach Coder|G.722, Opus-NB, Opus-WB}}
{{Template:Leistungsmerkmale NL - Voip Protokolle13}}
{{Template:Leistungsmerkmale NL - Netzwerk13}}

PPTP Tunneling tot 4 tunnels gelijktijdig, encoding via MPPE
{{Template:Leistungsmerkmale NL - Administration13}}
===Aanvullende functies===
* Handenvrij toets – Full duplex handenvrij bellen
* Directe oproep toets – Full duplex inbreken op toestellen die vrij of bezet zijn (kan uitgeschakeld worden)
* PTT toets – Terugspreken en klasieke PTT funktie gebruik (microfoon mute functie)
* Zone announcements – ongelimiteerde zones
{{Template:Leistungsmerkmale NL - Lizenzen Telefone}}
{{Template:CE-Decl_Phones|Conformiteiten|zie afzonderlijk informatieblad}}
===Bestelnummer IP172: 01-00172-001===
</div>
{{Template:Datasheet_footer|NL}}
[[Category:Technische gegevens Phones NL|{{PAGENAME}}]]

Technische gegevens IP171

2026-05-21T11:16:54Z

Vsc: Created page with "{{datasheet_header|innovaphone IP171|Opbouw intercom station}} <div class="datasheets-mehrspaltig"> Image:IP171.png ===Firmware=== Het toestel is compatibel met firmware versie 16 en hoger ===Behuizing=== * Wandmontage, Opbouwmontage behuizing * Voorijde speaker-60mm, 8 Ohm, plastic * IP66 Behuizing voor gebruik in de buitenlucht, stof- en waterdicht, bestand tegen zout en nevel * OLED display, 128 x 64 pixels * Silicone achtergrondverlichte funktietoetsen (3 x dynam..."

{{datasheet_header|innovaphone IP171|Opbouw intercom station}}
<div class="datasheets-mehrspaltig">
[[Image:IP171.png]]
===Firmware===
Het toestel is compatibel met firmware versie 16 en hoger
===Behuizing===
* Wandmontage, Opbouwmontage behuizing
* Voorijde speaker-60mm, 8 Ohm, plastic
* IP66 Behuizing voor gebruik in de buitenlucht, stof- en waterdicht, bestand tegen zout en nevel
* OLED display, 128 x 64 pixels
* Silicone achtergrondverlichte funktietoetsen (3 x dynamisch toewijsbaar, 3 x navigatie)
* Silicone achtergrondverlichte numeriek telefoontoetsenbord
* Silicone achtergrondverlichte bel funktietoetsen (handenvrij, direct/prioriteit, PTT)
* Oproep indicator
* Omgevingslichtsensor
* Afmetingen (W x D x H): 132 x 70 x 303 mm
* Gewicht: ca. 1500 grams

===Interfaces===
* 10/100-BASE-TX (auto negotiation), RJ-45 (modular Jack 8P8C)
* 24V PSU external power supply (input)
* 24V DC output (500mA)
* Relay (NO/NC)
* Handset (6-draads)
* Headset (6-draads) PTT ondersteuning
* Externe Speaker
* Achterzijde USB port - enkel voor intern gebruik

===Hardware===
* Voeding: „Power over Ethernet+“ volgens IEEE 802.3at, klasse 4
* 128MByte RAM, 16MByte Flash
* Werk temperatuur: +5 °C to +55 °C
* Luchtvochtigheid: 10% to 90% (niet condenserend)
* Opslag temperatuur: -10 °C to +70 °C
{{Template:Leistungsmerkmale NL - Sprach Coder|G.722, Opus-NB, Opus-WB}}
{{Template:Leistungsmerkmale NL - Voip Protokolle13}}
{{Template:Leistungsmerkmale NL - Netzwerk13}}

PPTP Tunneling tot 4 tunnels gelijktijdig, encoding via MPPE
{{Template:Leistungsmerkmale NL - Administration13}}
===Aanvullende functies===
* Handenvrij toets – Full duplex handenvrij bellen
* Directe oproep toets – Full duplex inbreken op toestellen die vrij of bezet zijn (kan uitgeschakeld worden)
* PTT toets – Terugspreken en klasieke PTT funktie gebruik (microfoon mute functie)
* Zone announcements – ongelimiteerde zones
{{Template:Leistungsmerkmale NL - Lizenzen Telefone}}
{{Template:CE-Decl_Phones|Conformiteiten|zie afzonderlijk informatieblad}}
===Bestelnummer: 01-00171-001===
</div>
{{Template:Datasheet_footer|NL}}
[[Category:Technische gegevens Phones NL|{{PAGENAME}}]]

Technische gegevens IP170

2026-05-21T11:15:09Z

Vsc: Created page with "{{datasheet_header|innovaphone IP170|Inbouw intercom station}} <div class="datasheets-mehrspaltig"> Image:IP170.png ===Firmware=== Het toestel is compatibel met firmware versie 16 en hoger ===Behuizing=== * Inbouwmontage * Voorzijde Speaker-61mm, 4 Ohm * IP20 beschermingsklasse * OLED display, 128 x 64 pixels * Silicone achtergrondverlichte funktietoetsen (3 x dynamisch toewijsbaar, 3 x navigatie) * Silicone achtergrondverlichte numeriek telefoontoetsenbord * Silicon..."

{{datasheet_header|innovaphone IP170|Inbouw intercom station}}
<div class="datasheets-mehrspaltig">
[[Image:IP170.png]]
===Firmware===
Het toestel is compatibel met firmware versie 16 en hoger
===Behuizing===
* Inbouwmontage
* Voorzijde Speaker-61mm, 4 Ohm
* IP20 beschermingsklasse
* OLED display, 128 x 64 pixels
* Silicone achtergrondverlichte funktietoetsen (3 x dynamisch toewijsbaar, 3 x navigatie)
* Silicone achtergrondverlichte numeriek telefoontoetsenbord
* Silicone achtergrondverlichte bel funktietoetsen (handenvrij, direct/prioriteit, PTT)
* Oproep indicator
* Omgevingslichtsensor
* Afmetingen (W x D x H): 94 x 31 x 269 mm
* Gewicht: ca. 650 gram

===Interfaces===
* 10/100-BASE-TX (auto negotiation), RJ-45 (modular Jack 8P8C)
* 24V PSU external power supply (input)
* 24V DC output (500mA)
* Relay (NO/NC)
* Handset (6-draads)
* Headset (6-draads) PTT ondersteuning
* Externe Speaker
* Achterzijde USB port - enkel voor intern gebruik

===Hardware===
* Voeding: „Power over Ethernet+“ volgens IEEE 802.3at, klasse 4
* 128MByte RAM, 16MByte Flash
* Werk temperatuur: +5 °C to +55 °C
* Luchtvochtigheid: 10% to 90% (niet condenserend)
* Opslag temperatuur: -10 °C to +70 °C
{{Template:Leistungsmerkmale NL - Sprach Coder|G.722, Opus-NB, Opus-WB}}
{{Template:Leistungsmerkmale NL - Voip Protokolle13}}
{{Template:Leistungsmerkmale NL - Netzwerk13}}

PPTP Tunneling tot 4 tunnels gelijktijdig, encoding via MPPE
{{Template:Leistungsmerkmale NL - Administration13}}
===Aanvullende functies===
* Handenvrij toets – Full duplex handenvrij bellen
* Directe oproep toets – Full duplex inbreken op toestellen die vrij of bezet zijn (kan uitgeschakeld worden)
* PTT toets – Terugspreken en klasieke PTT funktie gebruik (microfoon mute functie)
* Zone announcements – ongelimiteerde zones
{{Template:Leistungsmerkmale NL - Lizenzen Telefone}}
{{Template:CE-Decl_Phones|Conformiteiten|zie afzonderlijk informatieblad}}
===Bestelnummer: 01-00170-001===
</div>
{{Template:Datasheet_footer|NL}}
[[Category:Technische gegevens Phones NL|{{PAGENAME}}]]

Howto:How to IPxx13

2026-05-21T09:00:17Z

Vsc: /* SSD */

[[Category:Howto]]
[[Category:Concept IPxx13]]

== Applies to ==
* IP0013
* IP6013
* V13+

== Brief ==

=== IP0013 ===
* VoIP-PBX and routing gateway including reverse proxy and SBC functionalities
* Orderno.: 01-00013-001

=== IP6013 ===
* VoIP-PBX and routing gateway for four ISDN-S2M interfaces plus Reverse Proxy and SBC functionalities
* Orderno.: 01-06013-001

== SSD ==

IPxx13 owns two internal slots for '''M.2 SSD'''.

Slot interface is '''NVMe''' - [https://en.wikipedia.org/wiki/NVM_Express non volatile memory express].

Slot formfactor is M.2 2242 M-Key - dimensioning 22mm*42mm.

Maximum power consumption per M.2 SSD is 2.5W.

SSD has to be plugged in outer slot named '''SSD0''' on the PCB. Use of secondary inner slot SSD1 is not supported.

[[image:xx13_ssd.png]]

innovaphone offers and supports M.2 SSD 1 TB with order no 03-00010-031.

No technical support is provided for models other than those offered by innovaphone.

Note: '''These information DO NOT APPLY to IPxx11 and IP11xx based mSATA SSDs!''' For information to those devices, refer to [[Howto:Tested mSata modules|this article]].

== Power supply ==

The devices mandatorily require Power over Ethernet+ supply according to IEEE 802.3at, Class 4 (PoE+) for operation.

Currently, innovaphone offers no POE+ injector.

According to customer feedback, the following PoE+ injectors that meet the performance requirements of IPxx13 are used in projects:
* [https://docs.rs-online.com/c557/A700000010094578.pdf Edimax GP-103IT]
* [https://ww1.microchip.com/downloads/aemDocuments/documents/POE/ProductDocuments/DataSheets/PD-9001GR-Data-Sheet.pdf Microchip PD-9001GR/AT]
* LANCOM POE++ injector (type unknown)
Please note that this information are subject to change and have not been verified by innovaphone.

== Firmware ==
Available in [https://store.innovaphone.com/release/download.htm official release store]

===IP0013===
Following firmware versions are available for the IP0013 gateway itself:
* V13r2: available via release store since V13r2sr10, build no 136337

===IP6013===
Following firmware versions are available for the IP6013 gateway itself:
* V13r1: available via release store since V13r1sr25, build no 132894
* V13r2: starting with 13r2final, build no 136094

=== Application Platform ===
The device hosts an 64-bit-ARM-processor which requires use of 64bit-architecture application platform.

Respective arm64-AP is available for 13r1 and 13r2 in offical release store.

== Use cases ==
IP0013 and IP6013 host 150 software conference channels for audio conferencing (since 13r3sr4, before 60).

IP6013 additionally hosts 60 hardware digital signal processors for support of PCM traffic via PRI interfaces, audio faxes and audio conferencing.

Cumulating hardware and software conference channels at IP6013 into a single room is not supported.

Use of features such as PBX-operation, PRI- and fax traffic, audio/video conferencing and Application Sharing influence the CPU load.

Exceeding the maximum CPU limit may lead to device outage.

innovaphone supports following use cases:

'''All-in-one-box'''
* operation of PBX-functionality
* IP0013: for conferencing use SCNF interface
* IP6013: use HW-DSPs for PCM-Audio and Fax only, for conferencing use CONF '''or''' SCNF interface only

'''Gateway only'''
* operation as gateway only '''without activated PBX functionality and no AP installed'''
* IP0013: use SCNF for conferencing
* IP6013: use PRI-interfaces and HW-DSPs for S2M-Audio and Fax and SCNF for conferencing, '''or''' in case of no PRI/FAX traffic, both CONF and SCNF can be used for conferencing

[[Howto:How to implement large PBXs|Herefore mentioned basic conditions]] apply at any time for all kind of configurations and usecases.

==Known Issues==
* IP6013: FAX interface will provide audio-fax capabilities starting with 13r1sr26

File:Xx13 ssd.png

2026-05-21T08:51:38Z

Vsc: Vsc uploaded a new version of File:Xx13 ssd.png

Howto:How to IPxx13

2026-05-21T08:43:02Z

Vsc: /* SSD */

[[Category:Howto]]
[[Category:Concept IPxx13]]

== Applies to ==
* IP0013
* IP6013
* V13+

== Brief ==

=== IP0013 ===
* VoIP-PBX and routing gateway including reverse proxy and SBC functionalities
* Orderno.: 01-00013-001

=== IP6013 ===
* VoIP-PBX and routing gateway for four ISDN-S2M interfaces plus Reverse Proxy and SBC functionalities
* Orderno.: 01-06013-001

== SSD ==

IPxx13 owns two internal slots for '''M.2 SSD'''.

Slot interface is '''NVMe''' - [https://en.wikipedia.org/wiki/NVM_Express non volatile memory express].

Slot formfactor is M.2 2242 M-Key - dimensioning 22mm*42mm.

Maximum power consumption per M.2 SSD is 2.5W.

SSD has to be plugged in outer slot SSD0. Use of secondary inner slot SSD1 is not supported.

[[image:xx13_ssd.png]]

innovaphone offers and supports M.2 SSD 1 TB with order no 03-00010-031.

No technical support is provided for models other than those offered by innovaphone.

Note: '''These information DO NOT APPLY to IPxx11 and IP11xx based mSATA SSDs!''' For information to those devices, refer to [[Howto:Tested mSata modules|this article]].

== Power supply ==

The devices mandatorily require Power over Ethernet+ supply according to IEEE 802.3at, Class 4 (PoE+) for operation.

Currently, innovaphone offers no POE+ injector.

According to customer feedback, the following PoE+ injectors that meet the performance requirements of IPxx13 are used in projects:
* [https://docs.rs-online.com/c557/A700000010094578.pdf Edimax GP-103IT]
* [https://ww1.microchip.com/downloads/aemDocuments/documents/POE/ProductDocuments/DataSheets/PD-9001GR-Data-Sheet.pdf Microchip PD-9001GR/AT]
* LANCOM POE++ injector (type unknown)
Please note that this information are subject to change and have not been verified by innovaphone.

== Firmware ==
Available in [https://store.innovaphone.com/release/download.htm official release store]

===IP0013===
Following firmware versions are available for the IP0013 gateway itself:
* V13r2: available via release store since V13r2sr10, build no 136337

===IP6013===
Following firmware versions are available for the IP6013 gateway itself:
* V13r1: available via release store since V13r1sr25, build no 132894
* V13r2: starting with 13r2final, build no 136094

=== Application Platform ===
The device hosts an 64-bit-ARM-processor which requires use of 64bit-architecture application platform.

Respective arm64-AP is available for 13r1 and 13r2 in offical release store.

== Use cases ==
IP0013 and IP6013 host 150 software conference channels for audio conferencing (since 13r3sr4, before 60).

IP6013 additionally hosts 60 hardware digital signal processors for support of PCM traffic via PRI interfaces, audio faxes and audio conferencing.

Cumulating hardware and software conference channels at IP6013 into a single room is not supported.

Use of features such as PBX-operation, PRI- and fax traffic, audio/video conferencing and Application Sharing influence the CPU load.

Exceeding the maximum CPU limit may lead to device outage.

innovaphone supports following use cases:

'''All-in-one-box'''
* operation of PBX-functionality
* IP0013: for conferencing use SCNF interface
* IP6013: use HW-DSPs for PCM-Audio and Fax only, for conferencing use CONF '''or''' SCNF interface only

'''Gateway only'''
* operation as gateway only '''without activated PBX functionality and no AP installed'''
* IP0013: use SCNF for conferencing
* IP6013: use PRI-interfaces and HW-DSPs for S2M-Audio and Fax and SCNF for conferencing, '''or''' in case of no PRI/FAX traffic, both CONF and SCNF can be used for conferencing

[[Howto:How to implement large PBXs|Herefore mentioned basic conditions]] apply at any time for all kind of configurations and usecases.

==Known Issues==
* IP6013: FAX interface will provide audio-fax capabilities starting with 13r1sr26

File:Xx13 ssd.png

2026-05-21T08:41:12Z

Vsc:

Reference16r1:Concept IP270

2026-05-18T14:31:29Z

Vsc: /* Firmware Update */

== Applies To ==
* innovaphone IP270
* Firmware V16r1final 1610869 onwards

== Requirements ==
* innovaphone PBX with at least firmware 16r1final 1610869
* innovaphone App Platform with Devices and Users Application with at least firmware 16r1final 1610869
* IP270 firmware with at least version 16r1final 1610869
* PhonePlatform with at least build 2165
* PBX-Port-license (once per user)
* App(softphone)-License (Order Number: 02-00050-004) and App(phone)-License (Order Number: 02-00050-005) required (once per user)
* optional app licenses (once per user)

== Concept ==
myApps-powered phone for use with the innovaphone PBX

New hardware running a Yocto-based Linux distribution and hosting a native myApps IP270 client

Telephony via the myApps-Softphone-application provided by the innovaphone PBX

Additional services of the myApps application platform

== Features ==
=== myApps-Features ===
See respective column for IP270 in [[Reference16r1:Concept_myApps_platform_services#Features|myApps-platform services]].

=== Telephony-Features ===
See columns for IP270 in [[Reference16r1:Concept_App_SoftphoneApp#Features|myApps-SoftphoneApp features]].

=== Headphone support ===
myApps-IP270 supports use of [[Reference9:Concept_USB_Headset|USB devices known for innovaphone desk phones]].

== Configuration ==
=== Start ===
The IP270 is factory-configured as a DHCP client and obtains an IP address from a DHCP server—if available—via the LAN connection.

When the device starts up, myApps launches automatically and offers the following configuration options upon first startup after delivery:
* Provisioning Code input field
* Start provisioning
* Skip provisioning

Text input after a factory reset or upon delivery can be performed using the [[#On-screen keyboard|onscreen keyboard]] or the device’s hardware keypad.

After successful provisioning, this page is no longer displayed.

The device can be reset to factory settings by performing a power cycle while holding down the Home button until the LED stops flashing. This resets the home screen to the provisioning state and disables SSH login and remote browser debugging.

=== Automatic Provisioning (Recommended) ===
When the device is started for the first time after delivery or factory reset, it displays the provisioning page, where a provisioning code can be entered.

The required provisioning code can be generated either by the administrator via UsersAdmin or by the user themselves via Profiles. In this process, the device is set up as a '''standard innovaphone phone'''.
The generated provisioning code can be entered on the device via the provisioning page.

After the provisioning code has been successfully entered, the device is added to Devices and assigned to the user. The myApps login page is displayed and the device may attempt to load latest firmware. The LED flashes during this process.

The device automatically reboots after approx. 5 minutes.

Afterwards, externally connected input devices such as a mouse and keyboard can be used for myApps login and navigation.

In the user object, a device entry in the format “<ip270-mac> | Phone IP270, Softphone IP270 | phone,softphone” is created.

Upon successful connection to the server, the user’s login credentials can be entered.

=== Manual Configuration ===
==== Domain Assignment ====
After the device starts up, skip the provisioning process and go to “Change Server” on the myApps login screen.

There, select “Platform Setup” and enter your own Sysclient URL under / CONFIG / Sysclient URL.

Adapt the URL to your own domain in the following format

wss://<ap>.<domain>/<domain>/devices/sysclients

After confirming with Set, the device MAC appears in Devices and can be renamed and categorized there by the administrator.

==== User Assignment ====
* The administrator creates the device for the respective user via UsersAdmin
* A device entry is made in the User Object in the following format: HW-ID | Name1, Name2 | softphone,phone
* The HW-ID is the device MAC in the format 00903365xxxx, where xxxx are the last 4 digits of the serial number on the back label
* Name1 (e.g. Softphone IP270) identifies the SoftphoneApp. This must be set as the default telephony application on the IP270. It does not need to be visible on the home screen.
* Name2 (e.g. Phone IP270) identifies the PhoneApp, which allows the IP270 to be controlled from a PC. This must be launched on the PC.

=== myApps ===
Log in to myApps via the login screen using the on-screen keyboard.
If the on-screen keyboard doesn't disappear automatically afterwards, tap an empty field in myApps.

The "Softphone IP270" mandatorily must be set as the default telephony application.
 It is recommended to set the SoftphoneApp as focus application or to pin it.

==== Settings ====
* Lock: Lock screen manually
* Default Apps: "Softphone IP270" as telephony application
* More:
** Display: Backlight brightness for active and standby modes, power-saving options with display switch-off for adjustable start and end times
** Audio: Volume settings for ringtone, handset, speakerphone and headphone. Use with caution.
** Lockscreen: Pin code and timeout in minutes, three different c-lock screens, emergency number list.
** Trace: Definition of trace flags for error analysis. The trace file can be downloaded via the administrative UI.

==== Task bar ====
* Loudspeaker symbol: indicates set handsfree volume
* Counter [optional]: indicates active firmware upgrade process
* Warning sign [optional]: indicates enabled SSH and/or Remotebrowser debug connection. To be set via Administrative UI in Devices.

==== On-screen keyboard ====
Alphabetical keyboard with access to additional symbols via the Cmp key (Compose):
* Cmp + . to access more punctuation
* Cmp + - or , to access 'mathematical' symbols (+,-,=,etc)
* Cmp + ' or 0 or 9 to access more brackets and quotes
* Cmp + a to access variants with diacritics like á,à,â,ä,
* Cmp + q to access emojis
Return to alphabetical keyboard using the ABC key.

=== Administrative UI ===
Access via Devices or directly from the device via Platform Setup without myApps login. Following options are available:

* SHOW - display system status
** ENET : NIC status, IP@ and MAC
** OS-VERSION : used yocto build & publication date
** SshD : SSH login status
** SshD toggle : de/activate SSH login
** UIDbg : Remotebrowserdebug status
** UIDbg toggle : de/activate remote browser debugging

* UPDATE - manual update according to provided update server path
** myApps Update : available myApps version to be installed upon selection
** rootfs2 Update : available phone platform build to be installed upon selection

* CONFIG
** Sysclient URL : URL to system device application for device management. Format : wss://<ap>.<domain>/<domain>/devices/sysclients Confirm entry with SET

* DEBUG - to be used when instructed by support
** various menus to display dedicated function status.
** TRACES : trace output according to set trace flags. Upon selection download to default download folder and opened in standard editor.
** COREDUMP : list of present compressed core dump files. Upon selection download to default download folder. Download may take a while - do not select multiple times.

* REBOOT
** restart system : reboot complete device
** restart myApps : restart myApps only

== Firmware Update ==
Device is operated with its own device firmware and hosts a native myApps client on top of it.

In the [https://store.innovaphone.com/ innovaphone Store], the device firmware can be found under the "Phone Platform" tab.

In Devices, the device can access the device firmware via the domain upgrade using the URL https://store.innovaphone.com/release/download/phoneplatform.json.

The native IP270 myApps client is available in the Store under “Firmware” and is provided via https://store.innovaphone.com/release/download/firmware.json for the Devices upgrade.

During firmware update, the LED flashes. In the myApps taskbar, a yellow indicator displays firmware download progress in percent; a red indicator that the firmware is being installed.

== Factory Reset ==
Reset the device to factory settings is performed by power cycle whilst holding down the Home button until the LED stops flashing.

==Best practice use cases==
The device can be used locally or controlled remotely. Intended use cases are described below.

===Prerequisites===
* Audio device used must always be connected locally to the IP270
* Video devices can be connected to the IP270 and/or the PC

===Device Security===
It is recommended to set a personal PIN and lock timer via myApps/Settings/More.
After lock timer expiry and the device is locked automatically. Alternatively, the device can be locked manually via the myApps menu.
The lock timer is not interrupted by input from an external device such as mouce or keyboard.

As security measure in case of forgotten PIN, after six incorrect PIN entries the user is logged out and system switches back to login screen.

Unlock using the button on the screen and enter the unlock code with the phone’s hardware keypad or an external hardware keyboard.

===Audio Device Handling===
General prioritization of audio devices when answering a call
# Handset when lifted
# Headphone if available and handset is not used
# Speakerphone if no headphone is available and handset is not used

Switching audio devices during an active call:
* In the SoftphoneApp using the button
* On the device using the Microphone (= handset), Headphone, or Speaker buttons

=== Local Telephony ===
==== Outgoing calls ====
* Use the hardware keypad or SoftphoneApp to dial. When entering a number via the hardware keypad, the SoftphoneApp opens.
* When lifting the handset, outgoing call and all signaling tones are played through it.
* To route the call to a connected headphone, initiate the call using the headphone-button either on the headphone or the IP270.
* To play audio in hands-free mode, initiate the call using the speaker button.

==== Incoming calls ====
* When answering a call using the headphone-button either on the headphone or the IP270, the call is played through the headphone.
* When answering by lifting the handset, the call is played through the handset
* Answering via the speaker button on the device plays the call through the speaker in hands-free mode
* Alternatively, answer via the SoftphoneApp using the green handset icon. If no headphone is connected and the handset is on the cradle, the call is answered in hands-free mode.

====Video====
* Video playback takes place in myApps on the IP270 if a video camera is connected to the IP270-PhoneApp.
* No Remote Phone app may be open at the same time.

=== Remote Control via PC ===
IP270 can be remote controlled using the PhoneApp. It is recommended to set the IP270-PhoneApp as default telephony application on the PC.

==== Outgoing calls ====
* Dial via PhoneApp. A headphone connected to the IP270 is the default audio device; otherwise, the handset is used.
* During an active call, lifting the handset routes the call to the handset.
* Switch to speakerphone using the speakerphone button.

==== Incoming calls ====
* When answering a call using the headphone button either on the headphone or the IP270, the call is played through the headphone.
* When answering by lifting the handset, the call is played through the handset.
* Answering via the speaker button on the device plays the call through the speaker in hands-free mode.
* If the call is answered via the PhoneApp on the PC, it will be played through the headphone; otherwise the handset will be used.

====Video====
* If the remote PhoneApp is opened on the PC or defined as default telephony application, the video call will be displayed there.

== Troubleshooting ==
* Set trace options as told by innovaphone support via myApps-Client/More/Trace
* Collect traces at Devices/<IP270>/Debug TRACES and/or COREDUMPS . Tracefiles will be downloaded and opened automatically - stay patient and do not doubleclick!

== Known issues ==
* No file downloads from applications
* No LLDP-med support
* USB input devices are detected after the provisioning reboot
* USB ports are not intended for charging devices such as cell phones, power banks, or similar items
* An external resource, such as a document, opened in myapps can be closed using the hardware Home button

== Related Articles ==
[[Reference16r1:Concept_myApps_platform_services]]

https://wiki.innovaphone.com/index.php?title=Reference14r1:Concept_App_SoftphoneApp

https://wiki.innovaphone.com/index.php?title=Reference9:Concept_USB_Headset

https://wiki.innovaphone.com/index.php?title=Datasheet_IP270

Reference16r1:Concept IP270

2026-05-18T14:28:06Z

Vsc: /* Video */

== Applies To ==
* innovaphone IP270
* Firmware V16r1final 1610869 onwards

== Requirements ==
* innovaphone PBX with at least firmware 16r1final 1610869
* innovaphone App Platform with Devices and Users Application with at least firmware 16r1final 1610869
* IP270 firmware with at least version 16r1final 1610869
* PhonePlatform with at least build 2165
* PBX-Port-license (once per user)
* App(softphone)-License (Order Number: 02-00050-004) and App(phone)-License (Order Number: 02-00050-005) required (once per user)
* optional app licenses (once per user)

== Concept ==
myApps-powered phone for use with the innovaphone PBX

New hardware running a Yocto-based Linux distribution and hosting a native myApps IP270 client

Telephony via the myApps-Softphone-application provided by the innovaphone PBX

Additional services of the myApps application platform

== Features ==
=== myApps-Features ===
See respective column for IP270 in [[Reference16r1:Concept_myApps_platform_services#Features|myApps-platform services]].

=== Telephony-Features ===
See columns for IP270 in [[Reference16r1:Concept_App_SoftphoneApp#Features|myApps-SoftphoneApp features]].

=== Headphone support ===
myApps-IP270 supports use of [[Reference9:Concept_USB_Headset|USB devices known for innovaphone desk phones]].

== Configuration ==
=== Start ===
The IP270 is factory-configured as a DHCP client and obtains an IP address from a DHCP server—if available—via the LAN connection.

When the device starts up, myApps launches automatically and offers the following configuration options upon first startup after delivery:
* Provisioning Code input field
* Start provisioning
* Skip provisioning

Text input after a factory reset or upon delivery can be performed using the [[#On-screen keyboard|onscreen keyboard]] or the device’s hardware keypad.

After successful provisioning, this page is no longer displayed.

The device can be reset to factory settings by performing a power cycle while holding down the Home button until the LED stops flashing. This resets the home screen to the provisioning state and disables SSH login and remote browser debugging.

=== Automatic Provisioning (Recommended) ===
When the device is started for the first time after delivery or factory reset, it displays the provisioning page, where a provisioning code can be entered.

The required provisioning code can be generated either by the administrator via UsersAdmin or by the user themselves via Profiles. In this process, the device is set up as a '''standard innovaphone phone'''.
The generated provisioning code can be entered on the device via the provisioning page.

After the provisioning code has been successfully entered, the device is added to Devices and assigned to the user. The myApps login page is displayed and the device may attempt to load latest firmware. The LED flashes during this process.

The device automatically reboots after approx. 5 minutes.

Afterwards, externally connected input devices such as a mouse and keyboard can be used for myApps login and navigation.

In the user object, a device entry in the format “<ip270-mac> | Phone IP270, Softphone IP270 | phone,softphone” is created.

Upon successful connection to the server, the user’s login credentials can be entered.

=== Manual Configuration ===
==== Domain Assignment ====
After the device starts up, skip the provisioning process and go to “Change Server” on the myApps login screen.

There, select “Platform Setup” and enter your own Sysclient URL under / CONFIG / Sysclient URL.

Adapt the URL to your own domain in the following format

wss://<ap>.<domain>/<domain>/devices/sysclients

After confirming with Set, the device MAC appears in Devices and can be renamed and categorized there by the administrator.

==== User Assignment ====
* The administrator creates the device for the respective user via UsersAdmin
* A device entry is made in the User Object in the following format: HW-ID | Name1, Name2 | softphone,phone
* The HW-ID is the device MAC in the format 00903365xxxx, where xxxx are the last 4 digits of the serial number on the back label
* Name1 (e.g. Softphone IP270) identifies the SoftphoneApp. This must be set as the default telephony application on the IP270. It does not need to be visible on the home screen.
* Name2 (e.g. Phone IP270) identifies the PhoneApp, which allows the IP270 to be controlled from a PC. This must be launched on the PC.

=== myApps ===
Log in to myApps via the login screen using the on-screen keyboard.
If the on-screen keyboard doesn't disappear automatically afterwards, tap an empty field in myApps.

The "Softphone IP270" mandatorily must be set as the default telephony application.
 It is recommended to set the SoftphoneApp as focus application or to pin it.

==== Settings ====
* Lock: Lock screen manually
* Default Apps: "Softphone IP270" as telephony application
* More:
** Display: Backlight brightness for active and standby modes, power-saving options with display switch-off for adjustable start and end times
** Audio: Volume settings for ringtone, handset, speakerphone and headphone. Use with caution.
** Lockscreen: Pin code and timeout in minutes, three different c-lock screens, emergency number list.
** Trace: Definition of trace flags for error analysis. The trace file can be downloaded via the administrative UI.

==== Task bar ====
* Loudspeaker symbol: indicates set handsfree volume
* Counter [optional]: indicates active firmware upgrade process
* Warning sign [optional]: indicates enabled SSH and/or Remotebrowser debug connection. To be set via Administrative UI in Devices.

==== On-screen keyboard ====
Alphabetical keyboard with access to additional symbols via the Cmp key (Compose):
* Cmp + . to access more punctuation
* Cmp + - or , to access 'mathematical' symbols (+,-,=,etc)
* Cmp + ' or 0 or 9 to access more brackets and quotes
* Cmp + a to access variants with diacritics like á,à,â,ä,
* Cmp + q to access emojis
Return to alphabetical keyboard using the ABC key.

=== Administrative UI ===
Access via Devices or directly from the device via Platform Setup without myApps login. Following options are available:

* SHOW - display system status
** ENET : NIC status, IP@ and MAC
** OS-VERSION : used yocto build & publication date
** SshD : SSH login status
** SshD toggle : de/activate SSH login
** UIDbg : Remotebrowserdebug status
** UIDbg toggle : de/activate remote browser debugging

* UPDATE - manual update according to provided update server path
** myApps Update : available myApps version to be installed upon selection
** rootfs2 Update : available phone platform build to be installed upon selection

* CONFIG
** Sysclient URL : URL to system device application for device management. Format : wss://<ap>.<domain>/<domain>/devices/sysclients Confirm entry with SET

* DEBUG - to be used when instructed by support
** various menus to display dedicated function status.
** TRACES : trace output according to set trace flags. Upon selection download to default download folder and opened in standard editor.
** COREDUMP : list of present compressed core dump files. Upon selection download to default download folder. Download may take a while - do not select multiple times.

* REBOOT
** restart system : reboot complete device
** restart myApps : restart myApps only

== Firmware Update ==
Device is operated with its own device firmware and hosts a native myApps client on top of it.

In the innovaphone Store (https://store.innovaphone.com/), the device firmware can be found under the "Phone Platform" tab.

In Devices, the device can access the device firmware via the domain upgrade using the URL https://store.innovaphone.com/release/download/phoneplatform.json.

The native IP270 myApps client is available in the Store under “Firmware” and is provided via https://store.innovaphone.com/release/download/firmware.json for the Devices upgrade.

During firmware update, the LED flashes. In the myApps taskbar, a yellow indicator displays firmware download progress in percent; a red indicator that the firmware is being installed.

== Factory Reset ==
Reset the device to factory settings is performed by power cycle whilst holding down the Home button until the LED stops flashing.

==Best practice use cases==
The device can be used locally or controlled remotely. Intended use cases are described below.

===Prerequisites===
* Audio device used must always be connected locally to the IP270
* Video devices can be connected to the IP270 and/or the PC

===Device Security===
It is recommended to set a personal PIN and lock timer via myApps/Settings/More.
After lock timer expiry and the device is locked automatically. Alternatively, the device can be locked manually via the myApps menu.
The lock timer is not interrupted by input from an external device such as mouce or keyboard.

As security measure in case of forgotten PIN, after six incorrect PIN entries the user is logged out and system switches back to login screen.

Unlock using the button on the screen and enter the unlock code with the phone’s hardware keypad or an external hardware keyboard.

===Audio Device Handling===
General prioritization of audio devices when answering a call
# Handset when lifted
# Headphone if available and handset is not used
# Speakerphone if no headphone is available and handset is not used

Switching audio devices during an active call:
* In the SoftphoneApp using the button
* On the device using the Microphone (= handset), Headphone, or Speaker buttons

=== Local Telephony ===
==== Outgoing calls ====
* Use the hardware keypad or SoftphoneApp to dial. When entering a number via the hardware keypad, the SoftphoneApp opens.
* When lifting the handset, outgoing call and all signaling tones are played through it.
* To route the call to a connected headphone, initiate the call using the headphone-button either on the headphone or the IP270.
* To play audio in hands-free mode, initiate the call using the speaker button.

==== Incoming calls ====
* When answering a call using the headphone-button either on the headphone or the IP270, the call is played through the headphone.
* When answering by lifting the handset, the call is played through the handset
* Answering via the speaker button on the device plays the call through the speaker in hands-free mode
* Alternatively, answer via the SoftphoneApp using the green handset icon. If no headphone is connected and the handset is on the cradle, the call is answered in hands-free mode.

====Video====
* Video playback takes place in myApps on the IP270 if a video camera is connected to the IP270-PhoneApp.
* No Remote Phone app may be open at the same time.

=== Remote Control via PC ===
IP270 can be remote controlled using the PhoneApp. It is recommended to set the IP270-PhoneApp as default telephony application on the PC.

==== Outgoing calls ====
* Dial via PhoneApp. A headphone connected to the IP270 is the default audio device; otherwise, the handset is used.
* During an active call, lifting the handset routes the call to the handset.
* Switch to speakerphone using the speakerphone button.

==== Incoming calls ====
* When answering a call using the headphone button either on the headphone or the IP270, the call is played through the headphone.
* When answering by lifting the handset, the call is played through the handset.
* Answering via the speaker button on the device plays the call through the speaker in hands-free mode.
* If the call is answered via the PhoneApp on the PC, it will be played through the headphone; otherwise the handset will be used.

====Video====
* If the remote PhoneApp is opened on the PC or defined as default telephony application, the video call will be displayed there.

== Troubleshooting ==
* Set trace options as told by innovaphone support via myApps-Client/More/Trace
* Collect traces at Devices/<IP270>/Debug TRACES and/or COREDUMPS . Tracefiles will be downloaded and opened automatically - stay patient and do not doubleclick!

== Known issues ==
* No file downloads from applications
* No LLDP-med support
* USB input devices are detected after the provisioning reboot
* USB ports are not intended for charging devices such as cell phones, power banks, or similar items
* An external resource, such as a document, opened in myapps can be closed using the hardware Home button

== Related Articles ==
[[Reference16r1:Concept_myApps_platform_services]]

https://wiki.innovaphone.com/index.php?title=Reference14r1:Concept_App_SoftphoneApp

https://wiki.innovaphone.com/index.php?title=Reference9:Concept_USB_Headset

https://wiki.innovaphone.com/index.php?title=Datasheet_IP270

Especificações IP270

2026-05-18T13:24:18Z

Vsc: Created page with "{{datasheet_header|innovaphone IP270|O telefone myapps}} <div class="datasheets-mehrspaltig"> Image:IP270.png ===Firmware=== Telefone compatível com a versão 16r1final e superior ===Carcaça=== Tela sensível ao toque de 7 polegadas, 1280 x 800 pixels Teclado do telefone e teclado alfanumérico com exibição gradual LED 9 teclas de função para controle de volume, rediscagem, mudo, controle de fone de ouvido e alto-falante Base ajustável em quatro ângulos..."

{{datasheet_header|innovaphone IP270|O telefone myapps}}
<div class="datasheets-mehrspaltig">
[[Image:IP270.png]]
===Firmware===
Telefone compatível com a versão 16r1final e superior
===Carcaça===
Tela sensível ao toque de 7 polegadas, 1280 x 800 pixels

Teclado do telefone e teclado alfanumérico com exibição gradual

LED

9 teclas de função para controle de volume, rediscagem, mudo, controle de fone de ouvido e alto-falante

Base ajustável em quatro ângulos

Dimensões com base padrão (L x A x P): 260 x 200 x 160 mm

Peso: aprox. 1000 gramas com base padrão
===Interfaces===
1 x Gigabit Ethernet: 1000-BASE-T (negociação automática), RJ-45 (conector modular 8P8C) com “Power over Ethernet” de acordo com a norma 802.3af e “Energy Efficient Ethernet” de acordo com a norma 802.3az

1 x Gigabit Ethernet: 1000-BASE-T (negociação automática), RJ-45 (conector modular 8P8C) para conexão com PC

2 x porta USB 2.0 tipo A na parte traseira

2 x porta USB 2.0 tipo C na parte traseira

1 x porta USB 2.0 tipo C na parte traseira para fonte de alimentação externa

1 x porta USB 2.0 tipo C na parte frontal
===Hardware===
Alimentação: Power over Ethernet 802.3af, Classe 3 ou fonte de alimentação USB-C externa de 20 V, 6 W a máx. 2 A

2 GB de RAM LPDDR4, 8 GB de memória flash eMMC

Temperatura de operação: 0 °C a +45 °C

Temperatura de armazenamento: -10 °C a +70 °C

Umidade: 10% a 90% (sem condensação)

Modo de economia de energia com escurecimento automático da tela

Dois microfones, modo mãos-livres e escuta aberta
===Rede===
Suporte a IPv4/IPv6

SRTP (SDES, DTLS 1.2), ICE

STUN, TURN sobre UDP/TCP

Suporte a cliente DHCP

Suporte a NTP
===Administração===
* Administração centralizada por meio do aplicativo myApps-Devices para alterações de configuração e atualizações de firmware
* Geração de arquivos de rastreamento e exibição do registro de status
===Comunicação===
Aplicativo myApps-Linux-ClientSoftphone integrado para telefonia. Resumo dos recursos:
* Acesso com autenticação de dois fatores, bloqueio de tela
* Suporte a vários idiomas
* Suporte à conectividade de dispositivos USB (fone de ouvido, teclado, mouse, câmera)
* Serviços de cliente integrados (resumo):
** Aplicativos empresariais – Intranet social, gerenciamento de projetos, controle de horas
** Aplicativos de UC – Softphone, vídeo, chat, fax, correio de voz, conferência
** Agenda telefônica central Contatos
* Suporte a áudio e vídeo
* Chamada em espera, sinalização respectiva de chamada em espera para o chamador
* Transferência de chamada, com/sem consulta
* Chamada em espera, com suporte a música de espera
* Lista de favoritos exibindo presença e status da chamada
* Atendimento de chamadas a partir da lista de favoritos
* Desvio de chamadas: incondicional, em ocupado e em caso de não atendimento
* Login e logout em grupos de chamadas
* Silenciamento para desativação do microfone
* Conferência a três, inclusive com assinantes externos
* Gravação de chamadas
* Vários toques integrados
===Licenças===
* São necessárias a Licença do aplicativo de softphone (Número do pedido: 02-00050-004) e a Licença do aplicativo de telefone (Número do pedido: 02-00050-005) (uma vez por usuário)
* Para o registro de usuários do PBX, é necessária a Licença de porta do PBX (uma vez por usuário)
* Para o uso de aplicativos opcionais, podem ser necessárias licenças específicas de aplicativos (uma vez por usuário)
{{Template:CE-Decl_Phones|Declaração de conformidade|consulte a ficha informativa separada}}
===Código do produto: 01-00270-001===
</div>
{{Template:Datasheet_footer|PT}}
[[Category:Fichas técnicas Phones PT|{{PAGENAME}}]]

Especificações IP232

2026-05-18T13:14:32Z

Vsc:

{{datasheet_header|innovaphone IP232|Telefone IP de design com grande display touch e 3 x USB}}
<div class="datasheets-mehrspaltig">
[[Image:IP232.png]]
===Firmware===
Telefone compatível com a versão 9 e superior
===Características===
Display colorido, 480 x 272 pixels (4,3 polegadas)

Teclado do telefone, com opção alfanumérica

2 x 6 teclas de função dinâmica (uso múltiplo de 16 teclas dinamicamente atribuíveis)

Touch-screen

Teclas de navegação

Dimensões: 21,5 x 15 x 3 cm (base)

Peso: aprox. 870 g com pé standard

===Interfaces===
1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) com “Power over Ethernet” conforme IEEE 802.3af e Eficiência energética segundo IEEE 802.3az

1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) para conexão de PC

Entrada para alimentação externa

4 x USB-A 2.0 para conexão de headfone / auscultadores e módulo de expansão

===Hardware===
Alimentação: PSU externa 12 V, 6 W (opcional) ou “Power over Ethernet” conforme IEEE 802.3af, Class 2

Memória interna: 16 MB DDR3, 8 MB Flash

{{Template:Leistungsmerkmale PT - Hardware Telefone}}

{{Template:Leistungsmerkmale PT - Sprach Coder|G.729A, G.722}}

{{Endgeräte_Firmware_Technische_Daten_PT}}
===Características especiais===
Função Viva Voz (função mãos livres, sem escuta amplificada)

{{Template:Leistungsmerkmale PT - Lizenzen Telefone}}

{{Template:CE-Decl_Phones|Declaração de conformidade|ver ficha de informação em separado}}
===Código do produto: 01-00232-001===
</div>
{{Template:Datasheet_footer|PT}}
[[Category:Fichas técnicas Phones PT|{{PAGENAME}}]]

Especificações IP222

2026-05-18T13:14:11Z

Vsc: /* Código do produto IP112A: 01-00222-001 */

{{datasheet_header|innovaphone IP222/IP222A|Telefone IP com display colorido, teclas de função e 3 x UBS}}
<div class="datasheets-mehrspaltig">
[[Image:IP222.png]]
===Tipos===
* IP222: Orchid-HW-Plataforma
* IP222A: IMX6-HW-Plataforma (substitui o IP222, Start-MAC 00-90-33-5A-6D-C5)
===Firmware===
* IP222: Telefone compatível com a versão 9 e superior
* IP222A: Telefone compatível com a versão 13r3sr2 e superior
===Características===
Display colorido, 320 x 240 pixels (3,5 polegadas)

Teclado do telefone

2 x 6 teclas de função dinâmica (uso múltiplo de 16 teclas dinamicamente atribuíveis)

Teclas de navegação

Dimensões: 21,5 x 15 x 3 cm (base)

Peso: aprox. 835 g com pé standard

===Interfaces===
1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) com “Power over Ethernet” conforme IEEE 802.3af e Eficiência energética segundo IEEE 802.3az

1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) para conexão de PC

Entrada para alimentação externa

4 x USB-A 2.0 para conexão de headfone / auscultadores e módulo de expansão

===Hardware===
Alimentação: PSU externa 12 V, 6 W (opcional) ou “Power over Ethernet” conforme IEEE 802.3af, Class 2

Memória interna
* IP222: 16 MB DDR3, 8 MB Flash
* IP222A: 128 MB DDR3, 16 MB Flash

{{Template:Leistungsmerkmale PT - Hardware Telefone}}

{{Template:Leistungsmerkmale PT - Sprach Coder|G.722, IP222A adicional: Opus-NB, Opus-WB}}

{{Endgeräte_Firmware_Technische_Daten_PT}}
===Características especiais===
* IP222: Função Viva Voz (função mãos livres, sem escuta amplificada)
* IP222A: Mãos livres, escuta aberta

{{Template:Leistungsmerkmale PT - Lizenzen Telefone}}

{{Template:CE-Decl_Phones|Declaração de conformidade|ver ficha de informação em separado}}
===Código do produto: 01-00222-001===
</div>
{{Template:Datasheet_footer|PT}}
[[Category:Fichas técnicas Phones PT|{{PAGENAME}}]]

Ficha técnica IP270

2026-05-18T12:25:06Z

Vsc: Created page with "{{datasheet_header|innovaphone IP270|El teléfono myApps}} <div class="datasheets-mehrspaltig"> Image:IP270.png ===Firmware=== Compatible a partir de la versión 16r1final o superior ===Carcasa=== Pantalla táctil de 7 pulgadas, 1280 x 800 píxeles Teclado del teléfono y teclado alfanumérico emergente LED 9 teclas de función para control de volumen, rellamada, silencio y control de auriculares y altavoz Base regulable en cuatro posiciones Dimensiones con la b..."

{{datasheet_header|innovaphone IP270|El teléfono myApps}}
<div class="datasheets-mehrspaltig">
[[Image:IP270.png]]
===Firmware===
Compatible a partir de la versión 16r1final o superior
===Carcasa===
Pantalla táctil de 7 pulgadas, 1280 x 800 píxeles

Teclado del teléfono y teclado alfanumérico emergente

LED

9 teclas de función para control de volumen, rellamada, silencio y control de auriculares y altavoz

Base regulable en cuatro posiciones

Dimensiones con la base estándar: 260 x 200 x 160 mm

Peso: aprox. 1000 g con soporte estándar
===Interfaces===
1 x Gigabit Ethernet: 1000-BASE-T (negociación automática), RJ-45 (conector modular 8P8C) con «Power over Ethernet» según IEEE 802.3af y «Energy Efficient Ethernet» según IEEE 802.3az

1 x Gigabit Ethernet: 1000-BASE-T (negociación automática), RJ-45 (conector modular 8P8C) para conexión a PC

2 x puertos USB 2.0 tipo A en la parte trasera

2 x puertos USB 2.0 tipo C en la parte trasera

1 x puerto USB 2.0 tipo C en la parte trasera para alimentación externa

1 x puerto USB 2.0 tipo C en la parte delantera
===Hardware===
Fuente de alimentación: Power over Ethernet según IEEE 802.3af, Clase 3, o fuente de alimentación USB-C externa de 20 V, 6 W a un máximo de 2 A

2 GB de RAM LPDDR4, 8 GB de memoria flash eMMC

Temperatura de funcionamiento: de 0 °C a +45 °C

Temperatura de almacenamiento: de -10 °C a +70 °C

Humedad: del 10 % al 90 % (sin condensación)

Modo de ahorro de energía con atenuación automática de la pantalla

Dos micrófonos, manos libres y escucha abierta
===Red===
Compatibilidad con IPv4/IPv6

SRTP (SDES, DTLS 1.2), ICE

STUN, TURN mediante UDP/TCP

Compatibilidad con DHCP

Compatibilidad con NTP
===Administración===
* Administración centralizada mediante myApps Devices para cambios de configuración y actualizaciones de firmware
* Creación de archivos de seguimiento y visualización del registro de estado
===Comunicación===
Cliente Linux myApps integrado
* Autenticación de dos factores, bloqueo de pantalla
* Compatibilidad multilingüe
* Compatibilidad con dispositivos USB (auriculares, teclado, ratón, cámara)
* Servicios cliente (extracto):
** Aplicaciones empresariales – intranet social, gestión de proyectos, registro horario
** Aplicaciones UC – softphone, vídeo, chat, fax, buzón de voz, conferencias
** Directorio telefónico central
Softphone integrado para telefonía. Resumen de funciones:
* Compatibilidad con audio y vídeo
* Llamada en espera con la señalización correspondiente para el usuario que llama
* Transferencia de llamadas con/sin consulta
* Poner una llamada en espera, con música de espera
* Lista de favoritos con indicación de presencia y estado de la llamada
* Aceptación de llamadas desde la lista de favoritos
* Transferencia de llamadas desde la lista de favoritos
* Desvío de llamadas: permanente, en caso de ocupado y en caso de no respuesta
* Inicio y cierre de sesión en grupos de llamadas
* Silenciamiento, desactivación temporal del micrófono
* Conferencia a tres, también con participantes externos
* Grabación de llamadas
* Varios tonos de llamada integrados
===Licencias===
* Se requiere una licencia para la aplicación Softphone (número de pedido: 02-00050-004) y una licencia para la aplicación Phone (número de pedido: 02-00050-005) (una por usuario)
* Para el registro de usuarios PBX se requiere una licencia de puerto PBX (una vez por usuario)
* Para el uso de aplicaciones opcionales pueden requerirse licencias específicas de aplicación (una vez por usuario)
{{Template:CE-Decl_Phones|Conformidades|Véase la hoja informativa independiente}}
===Cód. Art.: 01-00270-001===
</div>
{{Template:Datasheet_footer|ES}}
[[Category:Fichas técnicas Phones ES|{{PAGENAME}}]]

Reference13r1:Concept App Service AppStore

2026-05-18T09:23:56Z

Vsc:

[[Category:Concept|Apps]]

The App Services AppStore is an App Service which can be installed on an innovaphone App Platform. It is used to store apps, firmware, software and app platforms. Once uploaded they can be downloaded from the download page. These items can also be cascaded from another AppStore using it as a source AppStore. This can be configured on the config menu (upper-right corner button).

The concept described below is not suited for an offline Appstore (e.g. when the innovaphone Appstore is not reachable by the customer devices).
If needed, use the method based on an [[Howto13r1:Step-by-Step_Offline_Firmware/App_Store_on_SSD | WebDav server]].

If you are a PartnerApp developer, please refer to [https://sdk.innovaphone.com/16r1/doc/appstoreguide.htm the Appstore guide in the SDK documentation].

== Applies To ==

* innovaphone PBX from version 13r1

== Apps ==

=== App Store App (innovaphone-appstore) ===
This is an App, where an administrator can upload apps, firmware, software and app platforms. These can be downloaded from the own app or from the download page (/download.htm).

== PBX Manager Plugins ==

=== AppStore ===

With the App Store plugin App objects can be created, edited and deleted on the PBX.

== Folder Structure ==
To upload apps, firmware, software and app platforms a path is required, which has to point to a folder containing the builds. These must be named after the build number.

[[Image:Path builds.JPG]]

=== Apps ===

Every build folder must contain an appid_files file where a list of the files that must be uploaded will be splited by commas (without white spaces). For example, "appstore.bin,appstore.debug,appstore.png".

The binaries must be placed inside 2 paths like this:
;..130001\arm\appstore
;..130001\x86_64\appstore

So if '''path''' is the path given in the appstore, the paths of all the files must be:
;'''path'''\130001\appstore_files
;'''path'''\130001\arm\appstore\appstore.bin
;'''path'''\130001\arm\appstore\appstore.debug
;'''path'''\130001\arm\appstore\appstore.png
;'''path'''\130001\x86_64\appstore\appstore.bin
;'''path'''\130001\x86_64\appstore\appstore.debug
;'''path'''\130001\x86_64\appstore\appstore.png

=== Firmware ===

Every build folder must contain an firmwareid_files file where a list of the files that must be uploaded will be splited by commas (without white spaces). For example, "ip0001.bin,boot0001.bin".

So if '''path''' is the path given in the appstore, the paths of all the files must be:
;'''path'''\130001\ip0001_files
;'''path'''\130001\ip0001.bin
;'''path'''\130001\boot0001.bin

=== Software ===

Every build folder must contain an softwareid_files file where a list of the files that must be uploaded will be splited by commas (without white spaces). For example, "myAppsSetup.exe".

So if '''path''' is the path given in the appstore, the paths of all the files must be:
;'''path'''\130001\myappswindows_files
;'''path'''\130001\myAppsSetup.exe

=== App Platform ===

The files that must be uploaded must be specified inside the fields File, Update, ZIP and ZIP2. Those must be inside a folder named as the build number, which is inside a folder named app-platform (i.e. app-platform\80008\…).

== Download files from the App Store ==
To download the files from the App Store the the App Store URL can be used replacing "innovaphone-appstore" by "download". This URL can be used to create a new source on the App Store to get items from another App Store. It can also be used to download single files from the App Store just adding the right folder structure at the end of the URL. For example, to download the Icon from the Apidemo from build 130001 it will be: ''URL/download/130001/arm/apidemo/apidemo.png''

For more information about the App Store, you could check [http://sdk.innovaphone.com/doc/howto/AppStore.htm this article].

Reference:Device Health Check

2026-05-18T09:16:21Z

Vsc: /* Finding a DRAM Memory Hog */

==Applies To==
This information applies to

* all innovaphone devices



==More Information==

This article advises how to perform a quick ''health check'' on an innovaphone device. This may serve as guidance for routine checking of a PBX systems state as well as to start debugging when a device malfunctions.

===Overview===

To perform a device health check, the following steps are recommended

* Inspect the device alarm table
* Inspect the device event list
* Inspect performance counters
* Check volatile memory (RAM) usage
* Check CPU usage
* Check persistent memory (Flash) usage
* Check CF card usage
* Examine system log
* Check for efficient PBX configuration

Depending on the device type, some of the steps may or may not apply.

=== The Alarm Table ===
The systems alarm table ([[Reference13r3:Maintenance/Diagnostics/Alarms|Maintenance/Diagnostics/Alarms]]) should always be empty. If there are entries in it, examine them carefully and fix the problem so that the alarms disappears. The reason for this is pretty simple: if the alarm table is filled with entries that you already have checked but considered ''acceptable'', then it will not take long until a severe problem will hide itself in between the harmless entries. So make it a habit that your alarm table is empty always.

The alarms have a ''details page'' available in the ''Code'' columns. These sometimes show useful further information. Also, many of the error codes have a dedicated wiki help page, available through the details page ''Help'' button.

=== The Event List ===
The systems [[Reference9:Maintenance/Diagnostics/Events|events list]] available under ''Administration/Diagnostics/Events'' may contain a fair amount of entry types. As opposed to the alarm table, where the entry is removed when the problem is fixed, entries in the event list are not removed (except the list exceeds its allowable size in which case the oldest entries will be removed). As a result, your event list will likely rarely be empty. You need to work through the list and analyse each entry to determine if or if not it is still relevant. To avoid analysing entries again and again, you can clear the whole list when finished, or (from V8 on), you can declare it as ''already taken care of'' using the ''Mark'' button in the detail page (which will render the entries ''Code'' column in green instead of red).

As for alarms, it is important to take care of problems which frequently create entries in the event list, as otherwise you will most likely overlook severe problems in a crowded event list.

=== The Calls Screen ===
One important issue is consistently good voice quality. In a life system, you can do a quick check on voice quality simply by looking at the PBX's [[Reference:Administration/PBX/Calls | Administration/PBX/Calls ]] screen.

<pre>
Number Name Protocol Media Dir Number Name Protocol Media Uptime State
13 abc H323EFC:TRANSIT G711A (2,0,0) x >> 001730 H323EFC:TRANSIT G711A (2,0,0) x 0d 0h 29m 31s Connected SRTP
0017200 H323EFC:TRANSIT G711A (46,5,3) >> 37 cba H323EFC:TRANSIT G711A (39,8,29) 0d 0h 7m 2s Connected
</pre>

Have an eye on the values within round parentheses in the ''Media'' column, most notably the third ''packet loss'' value. These should be low, more than 5/minute for ''packet loss'' e.g. is a good reason to be worried (so in our example, the second call is still acceptable but on the lower end of satisfaction). More information about the call screen can be found in [[Howto:How_to_read_the_call_screen | How to read the call screen]].

==== Recent Call Data ====
While the calls screen is a good tool to see how your calls feel like right now, they do not allow you to review data for terminated calls. A rule of thumb however says that everything is fine as long as you look at it, but gets worse as soon as your end customers are left alone with the system. A nice tool to get at past data easily is the internal [[ Reference7:Administration/Gateway/CDR0 | Administration/Gateway/CDR0 ]] CDR logging. You can save call detail records on your local CF card (using the <code>LOCAL</code> ''Log Server Type'' which will save them to <code>/DRIVE/CF0/log/CDR*.txt</code>. You can open these files with any text editor and although they look a bit strange, you can search straight for entries like <code>&xcoder=G711A,30(0,10,0)&rcoder=G711A,30(0,0,0)</code>. The values in parentheses have the same meaning as in the PBX's calls screen.

=== The Performance Counters ===
The systems [[Reference13r2:Maintenance/Diagnostics/Counters|performance counters ]] available under ''Maintenance/Diagnostics/Counters'' are another valuable tool to determine its health status. These are graphs which show the status of certain resource over the last 24 hours (8 hours are shown, you can scroll through time using the arrow buttons). Each individual value on the x-axis is a 2-minutes average. Lets have look at the resource counters currently available:

==== CPU ====
This counter shows the total CPU usage. A system that runs near to 100% all the time is a candidate for unpleasant behaviour, obviously. However, running on 100% simply says that things are getting slow. It does not necessarily say that things don't work. But as a rule of life, demand is always increasing, not decreasing, so there are two options in such a situation:
* be prepared for an upgrade
* eliminate the reason for excessive CPU usage
We will discuss in a later section of this article how to determine who the CPU hog is.

We generally recommend to make sure CPU load is not more than two thirds in average. This of course is just a rule of thumb. You may well run with a system with higher load or you may experience problems with a system with lower load. Still, if your system continuously runs with more than 2/3 of its CPU power, you should ask yourself if this is expected behaviour.

Also, watch out for unusual peaks. When you have a system that has a healthy looking CPU load graph, see if there are perhaps thin peaks. These would indicate short time frames with high load. They do not look impressive in the graph, still they may create severely bad user experience. Suppose for example there is a CPU usage pattern which creates 100% CPU load for a minute every once in a while. This would look like a comfortable 50% value in the 2-minutes graph slice. The end user though may experience service outages, signalling time-outs, frustrating response times etc. during this period of time. Such patterns usually look like a sharp ''needle'' in the graph and you should pay attention if you observe such.

==== CPU-R ====
This counter shows the amount of ''reserved CPU'' time. As opposed to the CPU counter, this is not CPU load that actually is used, but CPU performance which needs to be reserved for real-time application. Sending/receiving RTP data is considered real-time, for example. As opposed to, say HTTP access, where missing CPU performance merely makes things running slower, missing CPU performance for transmission of RTP data results in voice drop-outs and thus is considered a failure. This is why calls are rejected right away when no CPU performance can be reserved. When your CPU-R counter runs near to 100% often, then your system is overloaded and needs to be upgraded. Note that real-time apps do not suffer from 100% CPU values though, as the innovaphone operating system features a very efficient real-time prioritization.

You can take a look over the used mips. With this command you get the exact information of the used mips in this moment. You can also use the CPU-R counter and move the cursor over the diagram. This method is a little bit inexact. This command is much faster than the CPU-R counter. The counter has a 5 Sec delay.
<pre>
ip-PBX/!mod cmd CPU mips-usage
</pre>

==== MEM ====
This counter shows the total volatile memory (RAM) usage. Memory usage is in fact more critical than the CPU usage, as a system with low or no CPU resources left will still run, albeit slowly. A system with no memory resources will stop working and re-boot instead! It is thus crucial to have an eye on memory usage. You may observe that the memory usage graph usually is flat, that is, the value never decreases and rarely increases, especially once the device ran for a while after a re-boot. This is because the memory allocation strategy eventually claims memory for a specific purpose if needed, but never de-allocates it further on. Instead, objects allocated but no longer used are marked as ''free'' and re-used when an object of the same type is needed later on. The memory allocation graph shows all allocated objects, including those which are used and those which are currently free (as they are not available for use by objects of other types).

If memory usage grows steadily, there is most likely a memory leak somehow. That is, a function in the device allocates objects and thus claims memory but fails to mark those objects as free when done. If this happens, each function invocation will result in lost memory and the only way to recover from this situation is to re-boot the system. We will discuss how to track down memory hogs in a later section.

==== PRIx / BRIx ====
These counters show the number of B-channels used on the respective ISDN interfaces. Its interpretation should be fairly straight forward.

=== Finding a CPU Hog ===
In the event that you observe excessive CPU load, you need to find out which function actually consumes it. Once you have done so, you can either try to re-configure the system so that the causing function is used less, or you can add an extra device and move this function to the new device. For example, if you find that your PBX runs out of CPU resources because of heavy load on the system's CF-card, you may want to move the CF card to a different device which has more CPU cycles left.

Unfortunately, you cannot determine which ''function'' takes your CPU cycles away easily. However, you can determine which ''module'' does. In our previous example, you won't be able to determine that it's excessive config save operations on the CF card that produces the load, but you will be able to determine that its the CF card that does.

A ''module'' is a piece of code in the devices firmware that performs a certain task. You can think of it as a ''thread'' in an operating system such as Windows or Linux. ''Modules'' are named and you can retrieve a list of modules currently running on your device using the <code>!mod</code> command. Assuming your device has the IP address 172.16.0.10, you would open [http://172.16.0.10/!mod http://172.16.0.10/!mod] with your browser. You will receive a list of modules such as this one:

[[Image:Debugging_check-list_1.png]]

In this table, the first column (modules) and the second column (ticks) are of interest. The second column shows the number of ticks used by the module since the counters were reset the last time. The system never resets the counters on its own. They will be reset if you add the <code>clr</code> option to the <code>mod</code> command ([http://172.16.0.10/!mod+clr http://172.16.0.10/!mod clr]). A ''tick'' by the way corresponds to some clock-tick found in the devices CPU (platform specific), so be prepared for large values.

For easier analysis, you may want to import this table into your favourite spread sheet application. In Microsoft's Excel (c) for example, you would highlight the whole table, copy it in to your copy&paste buffer, then use ''Inhalte einfügen / Paste Content'' with ''Quelle: Text / Source: Text'' so you get each column in a separate Excel column (you may need to use the ''Import Assistant'' then, later V8 and V9 firmware builds output a more excel friendly table format). After some cleanup (remove unused columns), your spread sheet should then look something like this:

[[Image:Device Health Check - mod-cmd-excel-1.png | Excel Import]]

You can then add a column (column D in our example) which relates the number of ticks used by a module to the total number of ticks used (<code>=B96/($D$98)</code>). This is the relative load imposed by a certain module. Finally, sort the table by this column and you get a list of CPU hog candidates:

[[Image:Device Health Check - mod-cmd-excel-2.png | Excel Analysis]]

Unfortunately, there is no list of ''which module has which name'', but a look at the module name will give a good indication of what it is. The typical scenario is that IP0 (the IP stack), ETHx (the ethernet drivers) and H323 (the H.323 signalling stack) will be on top. If the device is a gateway too, the DSP drivers (AC-DSPx) and SRTP encryption drivers (MV78X00_CRYPT) will be in the top 10 too. In our example, you can see that the compact flash driver (CFLASH) is also prominent. Compared to that, the PBX itself - accounting for 2% of the cycles consumed - is a side-note only in our example.

Be aware that these figures are counted from the last counter reset. To identify the source of a CPU resource problem, you would wait for the situation to happen (i.e. you would wait for a time the CPU usage is high) and then do the math. However, you should start the analysis by resetting the counters (<code>!mod clr</code>), then wait a significant amount of time (half a minute may be a good starter), then get the stats (<code>!mod</code>) and analyse. If you fail to reset the counters, your picture will be distorted as it is influenced by previous (and probably unknown) activity.

=== Finding a DRAM Memory Hog ===

The strategy to find a dram memory hog is pretty much similar to the one to find the CPU hog. However, rather than using the <code>!mod</code> command, you would use the <code>!mem</code> ([http://172.16.0.10/!mem http://172.16.0.10/!mem]) command. The output will look something like this (again, later builds have somewhat different layout, so excel import will be easier):

<pre>
Total Memory Usage = 1061428
name size used free usage
client_gui_button 64 0 0 0
client_gui_text 64 0 0 0
client_gui_break 60 0 0 0
client_gui_ruler 60 0 0 0
client_gui_list_element 60 0 0 0
client_gui_list 64 0 0 0
client_gui_table_cell 60 0 0 0
client_gui_table_row 60 0 0 0
client_gui_table 60 0 0 0
</pre>

The table has a line for each type of internal object (e.g. <code>client_gui_button</code>). The ''size'' column gives the size of a single instance in byte, the ''used'' and ''free'' columns the number of allocated objects which are still in use or free for re-use again, while ''usage'' is <code>size * (used + free)</code>. So clearly, the ''usage'' column is the amount of bytes what you are interested in. Again, we will do some spread-sheet math.

[[Image:Device Health Check - mem-cmd-excel-1.png | Excel Analysis]]

In our example, we relate the values in the ''usage'' column (E) to
* the currently allocated memory (column B541)
* and the total allocatable memory size (column B543)
Resulting columns G and F are defined as percent-formatted. 
The table is then sorted by column F, resulting in a list of memory using objects.

As for the modules, there is no ''which object type has which name'' list, but looking at the object names will give some indication on what kind of object it is and which function it may be related to. The screen-shot was taken from an idle system, this is why column G is all zero. In a life system, the result may look more like this:

<pre>
Name Size Used Free Sum % of allocated %of available
cmd_exec 376 36 74 41360 1% 0%
flashdir_item 120 418 0 50160 1% 0%
pbx_connector 508 67 47 57912 2% 0%
h323_call 552 67 46 62376 2% 0%
gk_map 448 176 1 79296 2% 0%
tcp_socket 408 150 176 133008 4% 0%
pbx_user 584 270 0 157680 4% 0%
packet 52 4997 488 285220 8% 0%
http_request 5472 33 75 590976 17% 0%
buffer 32 10437 8255 598144 17% 0%
ac_491 122648 6 0 735888 21% 0%
</pre>

As a rule of thumb, many systems tend to run out of CPU more likely than out of DRAM memory.

''packet'' and ''buffer'' are special, as they do not relate to a specific function. Whenever the system needs temporary, short lived memory - e.g. to carry a network packet - it will allocate a ''packet'' that carries one or more ''buffers''. Peak network load thus will allocate a huge amount of ''packets'' and ''buffers'' which might not be used again but still consume memory. When the number of ''packets'' or ''buffers'' increases over time, this is most likely an indication of a memory leak.

The bottom of the memory table includes a number of lines as follows:

<pre>
allocated: 1466608
free for malloc: 58580
total malloc space: 3149356
physcial memory: 8388608
Total memory usage: 3090776
Memory Load: 36%
</pre>

The ''allocated:'' line is the number of allocated objects. That is, the sum of the ''usage'' column. Please note that this include all free objects of a specific type, which can be used for allocation of new objects of this type.

The ''free for malloc:'' line is the amount of memory which can be allocated from. This will be used whenever an object is needed for which there is no previously allocated but now unused object space (as shown in the ''free'' column).

The ''total malloc space:'' is the value of ''free for malloc:'' when the system has booted.

The ''Total memory usage:'' is the memory already claimed from the malloc space (that is ''total malloc space:'' minus ''free for malloc''). It does ''not'' include static memory use such as decompressed firmware, stack, etc.

The ''Memory Load:'' finally relates the ''Total memory usage:'' to the ''physical memory:''. Please note though that the box will run out of memory as soon as ''free for malloc'' goes down to zero! It might be useful thus to relate ''free for malloc:'' to ''total malloc space:'', which is exactly what the ''MEM'' counter in ''Administration/Diagnostics'' displays.

==== Obtaining more Information about used Objects ====
Sometimes, object types - even though their meaning is pretty clear - cannot be related to functions easily. For example, if you see an entry like

<pre>
tcp_socket 376 15 64 29704
</pre>

it tells you that a number of sockets are used, but not what for. To see details of an object, some object types support the <code>mem-info</code> method. You would look at the detail properties of the objects of a certain type using e.g. <code>http//172.16.0.10/!mem info tcp_socket</code> ([http://172.16.0.10/!mem+info+tcp_socket http//172.16.0.10/!mem info tcp_socket]). The result list

<pre>
0(c0e09a0c): NAT_LISTEN: ports=0:0, state=0:INIT, ostate=5680, x-q=0, r-q=0
1(c0e1073c): PCAP_SOCK_LISTEN: ports=2002:0, state=0:INIT, ostate=0, x-q=0, r-q=0
2(c0e17174): HTTP_LISTEN: ports=80:0, state=0:INIT, ostate=0, x-q=0, r-q=0
3(c0e173d8): HTTPS_LISTEN: ports=443:0, state=0:INIT, ostate=23130, x-q=0, r-q=0
4(c0e181b8): T_USER: ports=23:0, state=0:INIT, ostate=0, x-q=0, r-q=0
5(c0e1fcd8): LSRV_SOCK_LISTEN: ports=389:0, state=0:INIT, ostate=0, x-q=0, r-q=0
6(c0e718f4): GK-LISTEN: ports=2049:0, state=0:INIT, ostate=-16053, x-q=0, r-q=0
7(c0e71b54): GK-LISTEN: ports=2050:0, state=0:INIT, ostate=0, x-q=0, r-q=0
8(c0e71e3c): GK-LISTEN: ports=2051:0, state=0:INIT, ostate=0, x-q=0, r-q=0
9(c0e72310): GK-LISTEN: ports=2052:0, state=0:INIT, ostate=0, x-q=0, r-q=0
10(c0e725f8): GK-LISTEN: ports=2053:0, state=0:INIT, ostate=1950, x-q=0, r-q=0
11(c0e728e0): GK-LISTEN: ports=2054:0, state=0:INIT, ostate=-16148, x-q=0, r-q=0
12(c0e72bc8): H323_LISTEN: ports=1720:0, state=0:INIT, ostate=-16027, x-q=0, r-q=0
</pre>

may include some useful hints. This is particularly useful for the ''packet'' data structure, as it is used by all classes: [http://172.16.0.10/!mem+info+packet http//172.16.0.10/!mem info packet] indicates the packet creator module:

<pre>
5717(c1d1d0b8): ETHIF,c0078b38 len=31
5719(c18197fc): H323_OUT,c0078b38 len=31
5725(c1cfb864): H323_ACCEPT,c0078b38 len=31
5728(c1d04670): ETHIF,c0078b38 len=31
5729(c1d56ac8): HTTP4_REQUEST,c00e228c len=113
5730(c1f09518): HTTP_SOCKET,c0078b38 len=240
</pre>

If there is a memory leak, the module causing it can easily be spotted.

==== Monitoring what's going on ====
The ''!mem info'' approach described above can also be used quite independently of memory leaks to get a real-time overview of what is going on in the system.

Let us assume you need to know how many myApps clients are connected to the system
* the first step would be to issue a <code>!mem</code> command to get the complete list of memory objects
* now for the creative part: you need to guess the name of the object you are interested in. In our case, it is rather simple. We are looking for a client, so let's see which objects have an ''client'' as part of their name (and also have a value greater than 0 in the ''used'' column). What we find is
<pre>
pbx_appclient_dialog_call 84 204 463 56028
pbx_appclient_dialog 76 1596 189 135660
pbx_appclient_presence 84 5050 425 459900
pbx_appclient_standby_monitor 72 0 0 0
pbx_appclient_login_context 44 0 2 88
pbx_appclient_session 264 176 10 49104
</pre>
: this looks promising, ''pbx_appclient_session'' could be our friend. So we try <cmd>!mem info pbx_appclient_session'' and here you go:

155(84ce4e50): (Christoph Künkel) addr=172.16.68.10 secure=1 session=f64c7b8c57226001077f009033500068 ua=myApps for Windows deleting=0 closed=0

Note though that
* objects may or may not have the ''info'' method implemented. If not, you will see a useless list of memory addresses only
* support for the method and format of its output may change with builds
* all the !mem command variations are debug tools and not recommended for regular use (for example, you should not create a tool or app based on them)

==== Buffers ====
So far we have talked about ''objects'' in the operating system. However, there are also other users of dynamically allocated memory, the so-called ''buffers''. These are used for network packets for example. You can use <code>http://172.16.0.10/!buf</code> to get a list of used buffers.

<pre>
pool used free
0: 32 4129 2573 375312
1: 64 319 652 85448
2: 128 154 218 56544
3: 256 188 85 76440
4: 512 155 167 172592
5: 1024 24 6 31440
6: 2048 0 1 2072
7: 4096 120 4 510880
8: 8192 2 4 49296
1360024
</pre>

The second column shows the buffer size (buffers are always allocated in multiple-of-2 sizes). To see who has allocated the buffers, you can issue <code>http://172.16.0.10/!buf info size</code> where ''size'' is the one of the valid buffer sizes (32 to 8192).

<pre>
http://172.16.0.10/!buf info 8192
15c6e80: c=HTTP4_REQUEST(114988)
15c4e60: c=HTTP_GET(19838c)
15e8650: c=HTTP_GET(1983a0)
</pre>

This example shows that 3 buffers of size 8192 are used and all are somehow related to HTTP GET requests.

=== Finding a Flash Memory Hog ===
Unfortunately, there is no counter graph for flash memory usage. Still, there is a statistics page as for CPU and DRAM memory. It is retrieved using the <code>!mod cmd FLASHMAN0 info</code> command ([http://172.16.0.10/!mod+cmd+FLASHMAN0+info http://172.16.3.63/!mod cmd FLASHMAN0 info]):

<pre>
bottom 0xfe020000 base 0xfe020000 top 0xfffc0000 segsize 0x20000 segments 253
LDAP - used 128k avail 92k owned 1152k (max 3200k)
VARS - used 67k avail 95k owned 256k (max 256k)

0 0xfe020000 free(0x00) owner MINI(0x09) magic 0x666d order 0x00020031 usage 0x00000001
...
7 0xfe100000 free(0x00) owner FIRM(0x08) magic 0x666d order 0x0002002f usage 0x00000001
...
226 0xffc60000 free(0xff) owner 255 (0xff) magic 0xffff order 0xffffffff usage 0xffffffff
...
230 0xffce0000 used(0x80) owner VARS(0x06) magic 0x666d order 0x00000008 usage 0x00000001
231 0xffd00000 used(0x80) owner LDAP(0x04) magic 0x666d order 0x00000009 usage 0x00000001
</pre>

This table shows all allocated flash memory segments. Users include:
; MINI : the mini (rescue) firmware
; FIRM : the real firmware
; VARS : the storage for non-volatile configuration parameters
; LDAP : the directory storage (holds the PBX object configuration as well as call lists and personal user directories)

Each flash memory user has a fixed maximum quota. In our example, LDAP has set a maximum of 3200kB of which 1152kB are already claimed. In the current active flash segment (that is, the segment which is used to satisfy subsequent memory requests), 92kB are left for allocation. For the VARS flash user, all possible segments are claimed already (256kB of 256kB) and 95kB are left for allocation.

==== Wasting Memory by deleting Objects ====
When PBX objects are deleted, the GUID is kept in flash memory for a while with a note that the object has been deleted. This looks something like <code>mod cmd FLASHDIR0 add-item 101 (cn=object that will be deleted soon)(isDeleted=true)(guid;bin=3886C5ABE909D3119475009033290009)(usn=18243)</code>. Note that this sample entry still takes approximately 110 bytes flash memory. If you experience lack of flash memory and see lots of such entries, you might want to save the devices config, remove the lines with <code>(isDeleted=true)</code> and re-load the config to get rid of these entries. This typically happens when you turn on a new replication for a box that had a large PBX configuration before. These now obsolete PBX entries will be deleted from the configuration when the replication takes place.

=== Finding a Compact Flash Hog ===
Compact flash card space can easily be examined using the ''Info'' button available in [[ Reference7:Administration/Diagnostics/CF | Administration/Diagnostics/CF (up to V8) ]] or [[ Reference9:General/Compact-Flash/General | Reference9:General/Compact-Flash/General (from V9) ]]. The CF card's content can be examined using the ''Browse CF Content'' link on the same page.

=== Using Syslog ===
Many failures are listed in the ''Alarms'' and ''Events'' sections, as discussed above. However, some are not. It is a good habit therefore to take transcript of the systems log messages and browse through them in search of intermittent problems. This can easily be done by storing the syslog on the local CF card (as defined on [[ Reference8:Configuration/General/Logging | Configuration/General/Logging ]]). It is important to tick the check marks on [[ Reference8:Administration/Diagnostics/Logging | Administration/Diagnostics/Logging ]] in a sensible way in order not to flood the log with useless messages. As a starter, the following settings are recommended:

{|
| Category || recommended setting
|-
| TCP || off ||
|-
| PPP || off ||
|-
| PBX Calls || on ||
|-
| Gateway Calls || on ||
|-
| Gateway Routing || off ||
|-
| H.323 Registrations || on ||
|-
| SIP/UDP Registrations || off, unless you use SIP endpoints ||
|-
| SIP/TCP Registrations || off, unless you use SIP endpoints ||
|-
| SIP/TLS Registrations || off, unless you use SIP endpoints ||
|-
| H.323-NAT || off ||
|-
| Administration || off ||
|-
| TELx/PRIx/PPP || off, unless you use this interface ||
|-
|}
Please note that ''Administration'' might be a recommended setting if documentation of changes is an issue to you.

=== Resource sensitive PBX Configuration ===
Very often, resource issues are caused by inappropriate PBX configuration. Although there are of course a huge number of possibilities to do it wrong, here are a few prominent and easy to avoid things to keep in mind:

* do not use long identifiers. All PBX identifiers (user names, group names, ...) are stored in clear text in the PBX LDAP directory. Longer names use more flash space thus. If you deal with a 100 user PBX, you probably don't care. However, if you have 10.000 users structured in groups with a huge amount of members per group, calling a group <code>cti</code> instead of <code>Users with CTI Integration</code> does make a difference!
* do not put objects in to groups they do not need to belong to. You may be tempted to add users to certain groups ''by default'', thinking that it will make your life easier later on if the group assignment is in fact needed. However, group assignments not only consume flash space in the PBX's LDAP directory, but also consume in-core memory during run-time. Even more, doing so will make it more probably to exceed the maximum size of a single group (which is 2000 members currently). Having more than the allowed maximum of group members in a single group will result in strange behaviour which is difficult to track down.
* do not put objects as ''active'' members in to groups when they don't need to be active. ''Active'' group memberships consume additional DRAM memory as well as additional CPU cycles during run-time.
* do not configure [[Reference7:Administration/PBX/Objects#Object_Properties | group indications ]] when they are not needed. Group indications will result in additional memory and CPU consumption as well as network traffic. When group indications are configured, information is distributed to the respective group members regardless of if it is used there or not. So if no group indication is required, don't send it! If it is required, use the smallest group available to send them to. Do not re-use a group for this purpose just because it exists if it includes more members than required for the group indications. Rather create a new group and restrict it to the members required. One particular bad habit is to put all users in a single group, have them all be ''active'' and configure this group as the group used for ''group indications'' for all users. While this has the beauty that PBX functions which require group indications will always work (which to configure correctly may be a bit tedious sometimes), but it has the downside that each call to any of these users suffers from increased CPU and network load with each added user!
* do not create objects that aren't needed. Each PBX object consumes flash and DRAM memory, even if it is never used.
* do not put objects in to the group used by the TAPI service provider which are never monitored anyway. All activity information for all users in the tapi group is conveyed by the PBX to the TAPI service provider. If it is never used, this is a waste of resources and adds load both to the PBX and to the machine running the TSP.

=== Monitoring a multi-Device System ===
If your system consists of more than one relevant device, you may want to configure Alarm, Event and Syslog forwarding (as configured in [[ Reference8:Configuration/General/Logging | Configuration/General/Logging ]]) so you have this information in a single place to review.

=== Monitoring the Linux Application Platform (LAP) ===

To see the LAP's health status, first have a look at the ''Diagnostics/Status'' page.

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

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

Reference14r2:Concept myApps platform services

2026-05-18T05:55:36Z

Vsc: /* myApps for macOS */

[[Category:Concept|myApps]]

myApps platform services provide various operating system specific services which can be used by other ''Apps'' running in the [[{{NAMESPACE}}:Concept myApps|myApps client]]. Those services typically are not available in the browser's JavaScript environment and hence must be implemented in native platform code. Therefore, the platform services are installed as native executable on the respective platform.

When myApps is started in a web browser (and hence has no access to the platform services), some Apps will use [https://en.wikipedia.org/wiki/WebRTC WebRTC] services implemented by the browser instead. For ease of reference, features available in this scenario are also described here.

On windows, the platform services also come with their own web browser in which the myApps web App will be started then. This browser is based on google's [https://en.wikipedia.org/wiki/Chromium_(web_browser) Chromium] open source software.
= Applies To =

* [[{{NAMESPACE}}:Concept myApps|myApps]]
* myApps for Windows
* myApps for macOS
* myApps for iOS
* myApps for Android

* myApps Web App (WebRTC)
version 14r2

=Features=
Not all features are available or required on all platforms.
{|
! style="text-align: left; font-weight: bold" | Feature

! style="text-align: left; font-weight: bold" | Description

! style="text-align: left; font-weight: bold"| Availability
|-

| || || Windows || iOS || Android || macOS || Browser<ref>This refers to the myApps web application running in a browser with no platform services available</ref>

|-
| audio || manage local audio devices to record and playback audio conversations || ✔ || ✔ || ✔ || ✔ || ✔ (audio available but devices managed by web browser)
|-

| video || manage local displays and cameras to capture and render video live stream || ✔ || ✔ || ✔ || ✔ || ✔ (video available but devices managed by web browser)

|-

| ringer || manage local ringing device || ✔ || ✔ || ✔ || ✔ || ✔
|-

| application sharing

|-

|   presenter || share an application || ✔ || ✗ || ✔ || ✔ || ✔
|-

|   consumer || view an application shared by the peer || ✔ || ✔ || ✔ || ✔ || ✔

|-

| hot keys || capture key presses for quick invocation of phone apps (e.g. dial selected number) || ✔ || ✗ || ✗ || ✔ || ✗
|-
| tel: and sip: URI handler || intercept clicks on tel: and sip: links in web sites to invoke phone apps || ✔ || ✔ || ✔ || ✔ || ✗

|-
| user activity || set presence state according to user activity || ✔ || ✗ || ✗ || ✔ || ✔<ref>limited, see [[#User activity|User activity]] below</ref>

|-

| docking || myApps can be docked persistently to the right or left edge of your screens || ✔ || ✗ || ✗ || ✗ || ✗

|-

| multi-windowing|| Apps can be launched in separate windows|| ✔ || ✗ || ✗ || ✔ || ✗

|-

| recording|| Calls can be recorded to recording app|| ✔ || ✔ || ✔ || ✔ || ✗

|-
| notifications || ||
|-
|   display notifications || display notifications with OS standard mechanism || ✔ || ✔ || ✔ || ✔ || ✔
|-
|   push notifications || receive push notifications while myApps is not running || ✗ || ✔ || ✔ || ✔ || ✔<ref>The browser needs to be running in order to receive push notifications.</ref>
|-
|   chat and apps || display notifications for chat and other apps || ✔ || ✔ || ✔ || ✔ || ✔
|-
|   calls || display notifications for incoming calls || ✔ || ✔ || ✔ || ✔ || ✗<ref>Call notifications are only displayed locally while the phone or softphone app is started.</ref>
|-

| phone book access || access local phone book || ✔ || ✔ || ✔ || ✔ || ✗
|-
| office presence provider || maps PBX presence state to Microsoft office presence state || ✔ || ✗ || ✗ || ✗ || ✗
|-

| external application start || start arbitrary external applications for calls || ✔ || ✗ || ✗ || ✔ || ✗

|-

| app proxy|| a caching proxy that provides app persistence || ✔ || ✔ || ✔ || ✔ || ✗

|-

| auto update || automatically updates myApps platform services to the same version the PBX has || ✔ || ✔ || ✗ || ✔ || ✔<ref>The then-current web app is always loaded from the PBX upon startup and hence up-to-date by definition</ref>
|-

| three party conference || initiate 3-pty-conference using Softphone-App || ✔ || ✔ || ✔ || ✔ || ✗

|-
| exclude VPN || disable use of VPN connections for audio/video/appsharing || ✔ || ✔ || ✔ || ✔ || ✗

|}

<references/>

=Requirements=
* innovaphone PBX 14r2 and up

== Hardware ==
Recommended hardware requirements
* Processor: Dual-core 2Ghz or higher
* RAM: 4 Gb

== myApps for Windows ==
* Windows 10 and up
* Windows Server 2016 and later versions

=== 32 & 64 bit Windows ===
* 32 bit Windows: install the myAppsSetup32.msi from the App Store
* 64 bit Windows: install the myAppsSetup.msi from the App Store
** the 64 bit variant still installs into Program Files (x86), as the main myApps.exe is still a 32bit application
** the 64 bit variant just contains an additional 64 bit binary for the outlook search

=== Windows N editions ===

Windows N editions are missing the ''Media Feature Pack'' which is pre installed on other Windows versions.

Please install the pack from [https://www.microsoft.com/en-us/software-download/mediafeaturepack Microsoft (Windows 10 pack)] before you install myApps. The installer will check if the file <code>C:\Windows\SysWOW64\mfplat.dll</code> exist on your system.

Make sure to install the correct pack depending on your Windows version! There are different packs for Windows 10 1703, 1803, 1809 and 32bit or 64bit etc.

NB: Sometimes the myApps installation will not work even though the media pack is already installed. This is because the installer has no read access to check if the package is already installed. If the above-mentioned file exists and the installer asks to install the Windows Media Feature Pack nevertheless, you have to start the myApps install with administrative rights.

=== Terminal Server environments ===

Audio driver was removed if myApps discovers that it is running in a terminal server environment like Citrix.

The audio driver is needed for the Softphone App but the Softphone App should not use an audio driver at the server side because the audio devices are plugged locally and there would be a delay sending and receiving audio data with the server.

If a customer wants to use the Softphone App at the server side he needs to make use of the myApps Plugin for virtual desktops solution:

[[{{NAMESPACE}}:MyApps_Plugin_for_Virtual_Desktops]]

== myApps for macOS ==
* macOS 13 or higher

== myApps for iOS ==
* iOS 13 or higher

== myApps for Android ==
* Android 6.0 or higher. Android 6.x may need an update of the Chrome browser.

= Licenses =
* No license needed for myApps platform services

= Overview =
myApps platform services is a native executable that is installed using the standard mechanisms on the respective operating system. It provides various advanced services which can be used by the myApps web client code as well as the Apps running in the myApps context.

Also, on Windows, the platform services come with their own, dedicated browser to run myApps in. This browser is based on [https://en.wikipedia.org/wiki/Chromium_(web_browser) Chromium]. On iOS, macOS and Android, it is based upon native embedded web view facilities (such as WKWebView) instead.
== Components ==

=== RTP service for audio, video and data ===
The RTP service provides audio, video and data (app sharing) VoIP RTP endpoints (e.g. for softphones). It supports STUN, TURN, ICE, SRTP, DTLS. Note however that unlike WebRTC, these endpoints do not ''require'' ICE and DTLS. In other words, they can communicate also with non-compliant (i.e. older) VoIP devices.

Note that the available capabilities when not running the myApps platform services depend on the used browser's WebRTC implementation. See your browser documentation for details.

Apps can request RTP channels using the [https://sdk.innovaphone.com/doc/launcher/Media.htm Media Protocol]'s ''AllocChannel'' message.

===== RTP ports=====

{|

| audio || 50000 -> 50099

|-

| video || 50100 -> 50199

|-

| data || 50200 -> 50299

|}

The RTP service will enumerate all local interfaces and create local HOST candidates for ICE. There is an option however to disregard VPN interfaces (more precisely such interfaces with type of ''IF_TYPE_PPP'' or ''IF_TYPE_TUNNEL''). This can eliminate quality issues when RTP data is transmitted through TCP based VPN tunnels.

SRFLX and RELAY candidates are obtained using the STUN and TURN server configuration passed by the App (e.g the ''softphone'' App) as part of the ''AllocChannel'' request.
<code>{"mt":"AllocChannel","channel":"81429cba-396d-43de-8a76-ec020ba8796e","iceServers":[{"urls":"turn:myturn.domaincom:4077?transport=udp","username":"turnuser","credential":"pwd","credentialType":"password"},{"urls":"stun:mystun.domain.com:4077"}],"dn":"Foo Bar","type":"RemoteRtp","kind":"video"}</code>

===== Codecs =====

The installed myApps launchers provide codecs that can be used by softphone apps for media streams. When running in a web browser the codecs depend on the browser version and operating system. See the documentation of your browser for details.

The following codecs are supported:

{|
!style="text-align:left;width:100px;"|Codec
!style="width:100px"|Windows-Launcher
!style="width:100px"|Android
!style="width:100px"|iOS
!style="width:100px"|macOS
!style="width:100px"|Firefox (Browser)
!style="width:100px"|Chrome (Browser)
!style="width:100px"|Edge (Browser)
!style="width:100px"|Safari (Browser)
!style="width:100px"|Opera (Browser)
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Audio
|-
|G711A
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G711u
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G722
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G729
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729A
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729B
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729AB
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|[https://caniuse.com/#search=Opus OPUS-NB]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|[https://caniuse.com/#search=Opus OPUS-WB]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Video
|-
|[https://caniuse.com/#search=VP8 VP8]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|-
|[https://caniuse.com/#search=VP9 VP9]
|style="color:green;text-align:center"|✔**
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔**
|-
|[https://caniuse.com/#search=H264 H264]
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Application Sharing
|-
|Share
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|Watch
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔*
|style="color:green;text-align:center"|✔*
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|}

''* small presentation only'' 
''** only for 1:1 calls, not for conferences

===== Video capture =====

The default resolution for video capture is 1280x720 if available. Otherwise, 640x480, 352x288 or 320x240 will be used. The frame rate is 30 fps if available, otherwise 15 fps. The resulting average bandwidth could reach 1 Mbps.

===== Application sharing =====

Screen content will be transmitted by the presenter.

===== Device handling =====

The RTP service enumerates microphones, loudspeaker, cameras and ringing devices and notifies apps when devices come and go. It is up to the apps using the devices to store preferences.

The RTP service also enables some extended features (such as hook switch or volume control) for supported USB headsets or Bluetooth headsets connected to myApps.
The supported headset-SDKs determine which headset vendors are recommended to be used with the myApps softphone app. 

For this to work, the following vendor specific development kits are integrated in our myApps client. Be aware that the SDK are updated within our Service release :

{| class="wikitable"
|-
! SDK Vendor !! Supported OS !! SDK Version !! innovaphone Service Release
|-
| Jabra|| MacOS || 1.16.4.0 || 14r2sr11
|-
||| Windows || 1.16.4.0 || 15r1sr3
|-
| Epos ''(formerly Sennheiser)'' || MacOS || 12.4.0.5478 || 14r1sr3
|-
||| Windows || n.a. - [[Support:13r3 sr10 MyApps Windows Client - Epos/Sennheiser-Headsets require installed Epos-Connect Software|to be installed separately]]|| 13r3sr10
|-
| Poly ''(formerly Plantronics)'' || MacOS || 3.25.53799.37131 || 13r3sr9
|-
||| Windows || 3.25.53800.37131 || 13r3sr10
|-
| Yealink || MacOS || 3.1.1.23 || 14r2sr1
|-
||| Windows || 3.1.1.23 || 14r2sr2
|}

Notes:
* It is possible to inhibit the start of the Sennheiser SDK (SenncomSDK.exe) using the <code>DISABLEHEADSETS</code> directive of the installer (see [[#MSI Parameters and install options| MSI parameters]] below).

* Starting with V13r3sr10, the Epos-SDK needs to be installed separately using the Epos Connect software to ensure full compatibility between current Epos headset models and native myApps-Windows client. For details [[Support:13r3 sr10 MyApps Windows Client - Epos/Sennheiser-Headsets require installed Epos-Connect Software|refer to this article]].


===== Ring tones =====

Ring tones can be played. Apps can choose the tone from a pre-defined list of ring tones.

On Windows, custom ring tones can be uploaded as .mp3 files to the <code>ringtones</code> sub-directory of myApps' roaming directory (which usually is in <code>C:\Users\...\AppData\Roaming\innovaphone\myApps\ringtones</code>).

On Android, custom ring tones can be added to the system via Android settings.

On iOS, custom ring tones can be uploaded as .mp3 files to the <code>Ringtones</code> subdirectory of the myApps file share that is available in iTunes if the iPhone has been connected via USB.

On macOS, custom ring tones can be uploaded as .mp3 files to <code>~/Library/Containers/com.innovaphone.client-macos/Data/Documents/Ringtones</code>.

===== Debugging =====
For extended debugging, turn on the ''Audio'', ''Media'' and ''AppSharing'' traces in myApps.

=== Hot keys ===
On Windows and macOS systems, myApps platform services can listen for hot keys and invoke certain functions. Invocation is done by sending API messages to myApps which passes it to an appropriate API provider (in the cases described here, this will be a ''phone'' or ''softphone'' or ''rcc'' App typically. See [[{{NAMESPACE}}:Concept_myApps#Client_APIs_and_default_apps | Client APIs and default apps]] for more details about this mechanism.

The hot keys can be specified using the ''advanced settings'' user interface (see [[#UI elements| UI elements]] below. Any of the function keys F1 to F11 (optionally combined with up to two modifier keys ''alt'', ''ctrl'', ''shift'' or ''win'') can be chosen for each function. If you do not want to start the call with "Hotkey+Enter" because you would have to wait for the focus, the hotkey can also be pressed twice and the number is dialled directly.

; dial selected number : Initiates a call using the currently selected text as target.

: A ''PrepareCall'' message with the ''text'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":"mt":"PrepareCall","text":"13","adjust":true}}</code>

; accept call : Accepts a currently alerting call.

: A ''ConnectCall'' message will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"ConnectCall"}}</code>

; reject/disconnect call : Rejects a currently alerting call or disconnects an active call.

: A ''DisconnectCall'' message will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"DisconnectCall"}}</code>

=== URL Handler ===

On Windows systems, two URI-handler are installed with the myApps platform services. Windows will call up this URI handler when a user clicks on an appropriate link, for example in a web site.

The handler will the send an API message to myApps which passes it to an appropriate API provider (in the cases described here, this will be a ''phone'' or ''softphone'' or ''rcc'' App typically. See [[{{NAMESPACE}}:Concept_myApps#Client_APIs_and_default_apps | Client APIs and default apps]] for more details about this mechanism.

; tel URI : call a number, e.g. <code>tel:4711</code>

: A ''PrepareCall'' message with the ''num'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartCall","num":"4711","adjust":true}}</code>
; sip URI : call a SIP name, e.g. <code>sip:zkl@innovaphone.com</code>

: A ''PrepareCall'' message with the ''sip'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartCall","sip":"zkl@innovaphone.com","adjust":true}}</code>
; im URI : start chat with SIP name, e.g. <code>im:zkl@innovaphone.com</code>

: A ''StartChat'' message with the ''sip'' argument set to the selected text will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.chat/com.innovaphone.chat.htm ''com.innovaphone.chat'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.chat","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartChat","sip":"zkl@innovaphone.com"}}</code>

On macOS systems myApps might be made the default application to handle tel URI e.g. <code>tel:4711</code> via Apple FaceTime. Open the "FaceTime" menu "Settings..." and select myApps as "Default for phone calls".

On iOS ''tel'' URIs are always dialed via GSM. Therefore myApps iOS also reacts to URI schemes ''com.innovaphone.tel'', ''com.innovaphone.sip'' and ''com.innovaphone.im'', e.g. <code><nowiki>com.innovaphone.tel:4711</nowiki></code>, <code><nowiki>com.innovaphone.sip:zkl@innovaphone.com</nowiki></code>, <code><nowiki>com.innovaphone.im:zkl@innovaphone.com</nowiki></code>.

=== User activity ===
On Windows and macOS systems, the myApps platform services can monitor user keyboard/mouse activity and change the user's presence state after a certain amount of inactivity. The timeout can be specified using the ''advanced settings'' user interface (see [[#UI elements| UI elements]] below.

myApps will then send a [https://sdk.innovaphone.com/doc/appwebsocket/myApps.htm#SetUserActivity''SetUserActivity''] message to the PBX using the ''myApps'' protocol.

: <code>{"mt":"SetUserActivity","inactive":true}</code>

This will change the ''status'' property of the ''im:'' contact for the user's own presence and hence result in a presence update from the PBX to myApps

: <code>{"mt":"UpdateOwnPresence","presence":[{...},{"contact":"im:","activity":"","status":"closed"}]}</code>
The ''closed'' status is reflected in the grey status color when displaying a contact [[Image:myapps-inactive.png|myapps-inactive.png/|myapps-inactive.png/]].

On iOS and Android, the state is set to ''inactive'' as soon as the App is brought to background.
When myApps platform services are not available (i.e. when running the web application in a browser solely) a limited user activity monitoring is available: the state is set to active when the web page is not used for more than 5 minutes.

=== Recording ===

The new launcher offers the possibility to record the audio of incoming and outgoing calls. In order to activate that functionality the URL of the recording instance must be configured in either the PBX (PBX->myApps->Config: Recording URL) or the softphone App (Settings->Audio Recording (URL))

[[Image:PBX-Recording-Settings.png|pbx-recording-settings.png/|pbx-recording-settings.png/]] [[Image:Recording-Softphone-Settings.png|recording-softphone-settings.png/|recording-softphone-settings.png/]].

As long as that URL is configured the audio data of all calls are stored as pcap-files under that URL.
If the URL points to a CF device in the PBX, write access must be granted for that URL (PBX->Services->HTTP->Server:Public compact flash access) and if the URL points to the recording app, the files can be accessed via the recording app [[{{NAMESPACE}}:Concept_App_Service_Recordings|recording]].

Under PBX->myApps the administrator can set a certain default behaviour of the audio recording like whether or not the recording should start automatically at the beginning of the call (Recording by Default ON/OFF), only calls with external numbers should be recorded (Record external calls only) or whether or not the user should be able to start/stop the recording himself (Allow user incall recording control). Except for the last parameter these parameters can also be modified by the user in its softphone settings if the administrator doesn't set the FORCE flag.

If the user was allowed by the admin to control the recording a recording switch is active during the call when the "Media" Panel is opened. There the audio recording may be stopped and continued at will. A red recording notice is shown in the top right corner when the recording actually takes place.

[[Image:Recording-incall-switch.png|recording-incall-switch.png/|recording-incall-switch.png/]]

=== Notifications ===

The myApps platform services can use the OS specific notification mechanism (e.g. ''desktop notifications'' on Windows) to display messages (e.g. ''incoming new chat message'') to the user.

Note that the actual rendering of the notification is under control of the OS. Therefore, myApps must be allowed to show notifications and its appearance can be restricted by OS native settings.

==== Microsoft Windows Notifications ====

Microsoft Windows Server editions (2016, 2019, 2022) are just capable of showing a single ''IncomingCall'' notification at the same time (we couldn't find a workaround for this limitation). 
An ''IncomingCall'' notification is visible the whole time instead of being moved to the action center after a certain time. 
 
A notification about a missed call uses the ''IncomingCall'' type so that this notification is visible until the user returns. 
Due to the above limitation, on a new arriving call such a missed call notification is transformed to a default notification which will be moved to the action center automatically. 
 
On non server editions, you can have multiple IncomingCall notifications at the same time (so two parallel incoming calls will be indeed notified at the same time), but the missed call notification handling is the same on both platforms!

Thus there will be always just '''one''' missed call notification visible and previous missed calls can be found inside your action center!

To see myApps notifications, ensure:
* System -> Notifications
** enable notifications
** disable "Do not disturb" or allow myApps as priority application while "Do not disturb" is active
** enable notifications for myApps in the list of applications
* System -> Focus
** if a focus session is active and the "Do not disturb" is activated during a focus session, make sure that myApps is a priority application (see above)

==== macOS Notifications ====
Notifications are the same as on Windows.
The difference is, that for macOS, notifications need to be allowed in the system settings.
Go to Notifications - myApps, select Banner and enable all check marks.

=== Local phonebook access ===
'''Contact Search:''' The myApps platform services implement an ''API provider'' for the [http://sdk.innovaphone.com/web1/com.innovaphone.search/lib1_api_search.htm ''com.innovaphone.search'' API]]. They perform search capabilities on the OS' local phone books which can be used by Apps like the ''phoneapp''.

Apps would send a ''Search'' request to the API:

: <code>{"mt":"ApiRequest","consumer":"dev:SwPh_zkl_5e42e884","provider":"*","src":"4","msg":{"mt":"Search","type":"contact","search":"john doe"},"apiId":"com.innovaphone.search"}</code>
Search results are delivered as ''SearchInfo'' messages:

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{"mt":"SearchInfo","relevance":2000,"adjust":true,"type":"contact","contact":{"givenname":"John","sn":"Doe","company":"ACME","position":"Head of everything","telephonenumber":["11111","22222"],"homephone":["+4944444","33333"],"mobile":["+49 (123) 55555"]}},"api":"com.innovaphone.search"}</code>

'''Reverse Lookup:''' The myApps platform services implement an ''API provider'' for the [http://sdk.innovaphone.com/web1/com.innovaphone.phonelookup/lib1_api_phonelookup.htm ''com.innovaphone.phonelookup'' API]. They perform search capabilities on the OS' local phone books which can be used by Apps like the ''phoneapp''.

Apps would send a ''Lookup'' request to the API:

: <code>{"mt":"ApiRequest","consumer":"dev:SwPh_zkl_5e42e884","provider":"*","src":"4","msg":{ mt: "Lookup", prefixIntl: "000", prefixNtl: "00", prefixExt:"0", area: "7031", country: "49", lookup: "0004970311234567" },"apiId":"com.innovaphone.lookup"}</code>

Search results are delivered as ''LookupInfo'' messages:

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{mt: "LookupInfo", dn: "Jake Blues", contact: { telephonenumber: ["0004970311234567"], givenname: "Jake", sn: "Blues", company: "Blues Brothers" </code>

==== Windows ====
On Windows, the search and lookup are performed in all of the user's Outlook contact folders. As opposed to the search implemented in the ''Contacts'' and ''Users'' App, all items are returned which match any of the search words (i.e. searching for ''a b'' will return items matching either ''a'' or ''b'').

; searched properties : firstname, lastname
; returned properties : Following Outlook contact phone number properties are returned (if available):

:* OFFICE_TELEPHONE_NUMBER as ''telephonenumber''
:* OFFICE2_TELEPHONE_NUMBER as ''telephonenumber''
:* HOME_TELEPHONE_NUMBER as ''homephone''
:* HOME2_TELEPHONE_NUMBER as ''homephone''
:* MOBILE_TELEPHONE_NUMBER as ''mobile''
:* BUSINESS_FAX_NUMBER as ''facsimiletelephonenumber''
Note that contact information is cached in the search provider. Updated contacts may therefore become effective after a while only.
Outlook search will create its own trace file <code>myAppsOutlookSearch-</code>''date-time''<code>.txt</code> in the standard trace directory.

This search provider is always installed and can be disabled. There is no need (nor possibility) to enable it in the ''Apps'' tab of the PBX's user object. Also, no ''App'' object needs to be created for it.

==== Android/iOS ====
The search and lookup are performed in the contacts.

==== macOS ====
The search and lookup are performed in the contacts. If you wish to disable local contact lookup, go to system settings - Security & Privacy and disable the access to contacts for myapps.

=== Microsoft Office integration ===

The myApps platform services has a ''office presence provider'' that can provide the user's presence state to Office applications. See [[{{NAMESPACE}}:Concept_myApps_Office_Integration|myApps Office Integration]] for details.

This feature is installed by default. However, it can be disabled using the ''OFFICEPRESENCE'' MSI Parameter. Also, a check-mark is available in the setup dialog.

=== Call an external application for calls ===

Phone Apps (such as the phoneapp or softphone) can initiate the start of an external application when a new call appears (either incoming or outgoing). The actual spawning of the application is done by the myApps platform service. Also, the application properties (such as e.g. the executable's path) is configured in the myApps platform services (see [[#UI elements|Advanced settings]] in the ''UI elements'' section below).

A number of arguments can be passed to the application by substituting $-variables in the ''Parameter'' field:

; $n : phone number as dialed (called party number for outgoing calls) or received (calling party number for incoming calls)

; $N : called or calling party number in ''national'' format (e.g. 07031730090)

; $I : called or calling party number in ''international'' format (e.g. +497031730090)

: note that both $N and $I only work if $n includes both subscriber number and area code (e.g. 07031730090). Otherwise they are equal to $n

; $d : display name of peer (if known)

; $u : URI name of the peer (if available eg with a federation call)

; $c : conference id

: this is a globally unique ID for this call and may be used to relate the call to the ''guid'' found in the CallInfo structure in the [http://wiki.innovaphone.com/index.php?title=Reference10:SOAP_API#CallInfo SOAP-API] and [http://sdk.innovaphone.com/doc/appwebsocket/RCC.htm RCC-API ]. Also, corresponding [[Reference10:Call Detail Record CDR PBX|CDRs]] can be related using the ''event'' tag's ''conf'' attribute.
The start of an external application can be requested using the ''com.innovaphone.externalapps'' API.

Some setup examples are [[Howto:Integrate External Apps in innovaphone UC clients|shown here]].

=== Push ===

Mobile operating systems usually inhibit network operation of apps which run in the background or are closed by the user. This is done in order to reduce battery consumption. Unfortunately, this also stops such apps to maintain a registration by regularly sending ''keep alive'' messages to a server (in our case to the PBX). As a result, myApps will be disconnected from the PBX. When the PBX determines that there is an event for the application which needs a response, it needs to wake up the app using a dedicated channel provided by the operating system. This mechanism is know as ''push''. When running on iOS or Android, myApps supports ''push''.

For ''push'' to work, a [[{{NAMESPACE}}:PBX/Objects/Push|''push object'']] needs to be configured in the PBX . Also, it needs to be enabled on the mobile phone for the myApps app.
This mechanism is quite similar in v12 and v13, so you can refer to [[{{NAMESPACE}}:Concept_Push_Notifications_for_iOS_and_Android|Reference14r2:Concept_Push_Notifications_for_iOS_and_Android]] for more details.

Also, helpful hints can be found in [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]].

=== App Proxy ===

myApps runs further ''Apps'' (such as e.g. the ''phoneapp'') as a web page in an IFRAME of the browser myApps is running in. The App's page code is loaded either from the PBX or from an ''application platform'' (AP). This however would mean that the App's IFRAME would remain empty (a dead white screen) when the PBX or AP is not available. To make sure the App can start-up anyway, the myApps platform services feature the so-called ''App Proxy''. This is a caching proxy that caches all the App code so it is available even in case of network failure. When myApps runs in the context of the platform services, Apps are therefore not loaded from the App source directly, but from the local App proxy.

The cached files are stored in the PCs local file system in the <code>C:\Users\...\AppData\Local\innovaphone\myApps\appproxy</path></code>. There is no configuration required. However, if myApps seems to run with outdated or corrupt cached copies of the App, you can safely delete the entire directory.

=== Auto update ===

On Windows and on macOS, the myApps platform services can auto-update themselves to a common version. This is controlled by the [[{{NAMESPACE}}:PBX/Config/myApps#Launcher_Software_Update | ''Launcher Software Update'']] settings under ''PBX/Config/myApps'' in the PBX.

When myApps is started or the user logs in or myApps needs to re-connect to the PBX, the platform services will use the [http://sdk.innovaphone.com/web1/com.innovaphone.client/lib1_api_client.htm com.innovaphone.client API] to learn the desired version (''launcherUpdateBuild'', which is part of the API's ''model''). If this differs from the current version, the platform services will try to download the respective new version.

<code>
{
"mt": "ApiUpdate",
"apis": {
"com.innovaphone.client": {
"@client": {
"title": "innovaphone myApps",
"model": {
"launcher": true,
"launcherUpdateBuild": "134906",
"appStoreUrl": "http://store.innovaphone.com/release/download/"
}
}
}
}
}</code>

The installation of the downloaded version is done by the ''innovaphonemyAppsUpdateService''. This service is installed and enabled during the initial installation of the myApps platform services. To disable auto-update, either leave the ''Launcher Software Update'' settings empty or set the service's start mode to ''disabled'' in the Windows ''services control panel''.

Note that on Windows the update service does not work on terminal servers. Administrators must do myApps base services updates using standard windows mechanisms.

Note that on macOS if myApps has been installed from the Apple Store it is assumed that auto update from the PBX is not desired and disabled therefore.

On Android/iOS/macOS updates can be downloaded from the respective app store.

The ''Devices'' app can not update software installed on Windows PCs directly. However, when the PBX is updated using an ''update job'' in the ''Devices'' App, the ''Launcher Software Update'' settings will be updated accordingly and hence the myApps base services will ultimately also be updated to the same version.

==== Auto update flow on Windows ====

* On start of myApps, myApps checks if an update is available and ready for installation
** if yes, the update is installed directly, without user interaction (a popup is shown during the installation)
** if not, myApps starts
* if an update is available while myApps is already running, an update notification will be shown which let's the user choose to install the update now or later (the notification will then popup again after one hour)

==UI elements ==
There are a few user interfaces provided by the platform services:
===tray-icon (Windows only) ===
::[[Image:myapps-tray.png|myapps-tray.png/|myapps-tray.png/]]
:Allows to
:* terminate myApps
:* toggle the ''autostart'' state
:* toggle the ''show in task bar'' state
:* open the trace folder
:
=== PBX connect form===
:: [[Image:myapps-connect.png|myapps-connect.png/|myapps-connect.png/]]
: Allows the user to specify the connect data for the PBX (i.e. IP address or DNS name)
:
=== Advanced settings===
::[[Image:myapps-settings0.png|myapps-settings0.png/|myapps-settings0.png/]]
::[[Image:myapps-settings.png|myapps-settings.png/|myapps-settings.png/]] [[Image:myapps-settings2.png|myapps-settings2.png/|myapps-settings2.png/]] [[Image:myapps-settings3.png|myapps-settings3.png/|myapps-settings3.png/]]

: Allows to modify various platform dependant settings (such as e.g. the hotkey selection on Windows)

== Interfaces ==
=== Provided APIs ===

; [http://sdk.innovaphone.com/web1/com.innovaphone.search/lib1_api_search.htm com.innovaphone.search] : access to local phone book entries by the [[#Local phonebook access|Local phonebook access]] component.
; [http://sdk.innovaphone.com/web1/com.innovaphone.launcher/com.innovaphone.launcher.htm com.innovaphone.launcher] : display of OS specific user notifications and receipt of related user actions
; com.innovaphone.notificationhandler : reports back click on a notification.
; com.innovaphone.externalapps : to start external applications, see [[#Call an external application for calls|Call an external application for calls]] above

=== Used APIs ===

; [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm com.innovaphone.phone] : used to initiate new or manipulate existing calls by the [[#Hot keys|Hot keys]] and [[#URL handler|URL handler]] components.

; [http://sdk.innovaphone.com/web1/com.innovaphone.chat/com.innovaphone.chat.htm com.innovaphone.chat] : used to start a new chat by the [[#URL handler|URL handler]] component.

; [http://sdk.innovaphone.com/web1/com.innovaphone.client/lib1_api_client.htm com.innovaphone.client] : the model is used to learn the update settings, see [[#Auto update|Auto update]] above

=== Protocols ===

; [https://sdk.innovaphone.com/doc/launcher/Media.htm Media Protocol] : used by apps to allocate RTP channels, see [[#RTP service for audio.2C video and data|RTP service for audio, video and data]] above

== Related App Services ==

none

== Known limitations ==
; Incoming call as banner on myApps for iOS : Since iOS 14 the iOS CallKit presents incoming calls as a banner leaving the original green answer button of myApps visible. Use only the blue button of the banner to accept the call or change iPhone Settings, App "Phone", "Incoming Calls" to "Full Screen" to hide the myApps user interface again during call answering.

; Call answer in speakerphone mode even with active Bluetooth headset on myApps for iOS : This causes unwanted speakerphone operation if the smartphone is used with a Bluetooth car audio system. The behaviour can be changed by selecting ''Bluetooth Headset'' in this setting:
:''iOS Settings->Accessibility->Touch->Call Audio Routing: Automatic / Bluetooth Headset / Speaker''
:''iOS Einstellungen->Bedienungshilfen->Tippen->Anrufaudioausgabe: Automatisch / Bluetooth-Headset / Lautsprecher''

; Windows Server 2016 (Windows 10 Build 1607) : windows just shows the first notification. Further notifications aren't displayed until the previous ones are removed from the notification center. Current windows builds do not show this behaviour anymore.

; Problems on Mac computers with Yealink USB headsets
: we have received reports that myApps quits unexpectedly on some Mac computers when a Yealink headset is plugged in. Unfortunately, we could not find out the cause yet. If you use Yealink USB headsets and have a similar issue, please open a support ticket and send myApps traces.

; Poly / Plantronics headset buttons only functional if myApps is started with Rosetta
: myApps macOS supports Apple M1/M2 hardware natively. However, the Poly / Plantronics headset SDK is only available for Intel platform and thus myApps needs to be started via Apple's Intel emulator Rosetta if a Poly / Plantronics headset is used. This is done with right-click on the myApps executable, ''Information'', ''Open with Rosetta''.

; Windows surface devices may not work correctly
: Chromium does not get touch keyboard events. USB Keyboards may not be recognized either.

= Installation =

== Windows ==

myApps platform services are installed on Windows using the .msi file found in the ''myApps Windows'' package from [https://store.innovaphone.com/release/download.htm store.innovaphone.com].

myApps can update itself automatically, see [[#Auto update|Auto update]] above.

=== MSI Parameters and install options ===

The MSI installer of myApps for Windows supports the following parameters and can be edited with [https://docs.microsoft.com/en-us/windows/win32/msi/orca-exe Microsoft Orca]. You can add your parameters in the table ''property''.

; SERVER (REG_SZ): the PBX's server URL
; OFFICEPRESENCE (REG_DWORD): '''false''' to disable presence integration in Microsoft Office
: this is also available as a check-mark when running the install manually

; DISABLEHEADSETS (REG_DWORD): '''true''' to disable headsets support, see [[#Device handling|Device handling]] above

; EXTERNALAPPS (REG_SZ): pre-define external applications, see [[#Call an external application for calls|Call an external application for calls]] above
: e.g. <code>"{""externalApps"":[{""id"":0,""name"":""Wireshark"",""path"":""C:\\Program Files\\Wireshark\\Wireshark.exe"",""param"":""test $I""}]}"</code>

; FORCERESTART (REG_DWORD): '''true''' (or any string ...) kills myApps during the installation and restarts it for the currently logged in user, if it was running

; DISABLELOCALHOST (REG_DWORD): '''true''' to disable use of '''localhost''' string to access the local webserver. Use '''127.0.0.1''' instead

; EXCLUDEINTERFACES (REG_SZ): some VPN interfaces are not detected by Windows as IF_TYPE_PPP or IF_TYPE_TUNNEL and therefore the '''media outside VPN''' setting is not taking effect. With this option interfaces can be pre-defined that will not be used for media. Interfaces must be comma separated
: e.g. <code>EXCLUDEINTERFACES="172,192.168,10.10"</code>

Current settings are stored in the registry at <code>Computer\HKEY_CURRENT_USER\Software\innovaphone\myApps</code> or at <code>Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\innovaphone\myApps</code>

Boolean values like OfficePresence are stored in registry entries with type REG_DWORD and values 1 or 0. 0 disables the setting and 1 enables it.

== iOS ==

myApps platform services are installed on iOS by loading ''innovaphone myApps'' from the ''App Store''.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying this dictionary in the MDM
<code><plist>
<dict>
<key>server</key>
<string>pbx.example.com</string>
</dict>
</plist></code>

== macOS ==

myApps platform services might be installed directly from the Apple store. An installer package <code>myapps.pkg</code> and a disk image <code>myapps.dmg</code> is also available from the innovaphone app store. Install <code>myapps.pkg</code> by double-click on the file and follow the instructions of the installer. myApps becomes available in the Applications folder and can be opened by double-click. Or download and open <code>myapps.dmg</code> and double klick myApps. If desired integrate it into the app dock by right click, ''Options, Keep in the dock''.

If installed from the innovaphone app store, myApps can update itself automatically, see [[#Auto update|Auto update]] above.

If installed from the Apple store, macOS notifies about updates on the Apple store. myApps [[#Auto update|Auto update]] is disabled then.

If a clean-install of the client is necessary, the folder "/Users/username/Library/Containers/myapps" needs to be deleted. To be on the safe side also delete it from the trash bin.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying this dictionary in the MDM
<code><plist>
<dict>
<key>server</key>
<string>pbx.example.com</string>
</dict>
</plist></code>

=== Preferences ===

macOS supports preference settings that can be set via a shell command or via Mac remote management

<code>> defaults write com.innovaphone.client-ios-14r1 server "PBX-server-URL"</code>

The following parameters and can be set through this method:

; server: the PBX's server URL

=== Setting myApps as Default App for SIP-URLs ===
{| class="wikitable"
|defaults write com.apple.LaunchServices/com.apple.launchservices.secure LSHandlers -array-add '{
LSHandlerURLScheme = sip;
LSHandlerRoleAll = "<CFBundleIdentifier>";
}'
|}
To find the “CFBundleIdentifier”, proceed as follows:

* In the Finder under “Applications”, search for the desired myApps client that you want to set as the default app.

* Right-click on “Show package contents” -> you will find the “CFBundleIdentifier” in the Info.plist file.

A restart of the MAC is required.

=== Using Sennheiser headsets ===
If you use Sennheiser headsets, you should also install the then-current <code>DSEA_SDK_v</code>''version''<code>.pkg</code> package, after you installed the myApps client. Without that, audio will still work, but not the controls on the headset. You will need to keep that up-to-date yourself, as it is not updated by myApps's auto-update function.

== Android ==

myApps platform services are installed on Android by loading ''innovaphone myApps'' from the ''Play Store''.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying a property "server" with string value "pbx.example.com" in the MDM.

= Configuration =

== Server configuration ==
When opening myApps for the first time, the user is prompted for the Server. Usually only the hostname (DNS host name or IP address) needs to be configured.

But there are more options for special PBX configurations.

; Non-standard HTTPS port
: If the PBX uses a non-standard HTTPS port, it must be appended to the host name separated by a colon (<code>:</code>).
: Example: <code>pbx.example.com:4444</code> (expands to <code>https://pbx.example.com:4444/PBX0/APPCLIENT/appclient.htm</code>)
; DynPBX module name
: If the PBX is a DynPBX, the module id must be appended to PBX0 separated - (<code>/</code>).
: Example: <code>pbx.example.com/PBX0-1</code> (expands to <code>https://pbx.example.com/PBX0-1/APPCLIENT/appclient.htm</code>)
; Softphone physical location
: If user defined physical location shall be used for softphone, you can append it using a parameter <code>#phys=</code>.
: Example: <code>pbx.example.com#phys=slave</code> (expands to <code>https://pbx.example.com/PBX0/APPCLIENT/appclient.htm#phys=slave</code>)

Example 1: PBX pbx.example.com with standard configuration
pbx.example.com

Example 2: PBX slave.example with DynPBX module ID 1, HTTPS port 4444 and physical location master
slave.example.com:4444/PBX0-1#phys=master

=== HTTP proxy support ===

myApps platform services do support operation via HTTP proxy now. If one or more proxies have been configured in the network settings of the operating system for the active network connection, HTTP CONNECT tunnels are established.

On Windows user name and password can be specified for the tunnel servers as generic credentials in the credentials manager (Anmeldeinformationsverwaltung). The name of the credentials must be the tunnel server hostname.

On Android user name and password can be specified through Android ''Settings, Accounts'' by adding a myApps ''HTTP Proxy Credentials'' account. The name of the account must be the tunnel server hostname.

== Platform specific settings ==
When myApps runs under the myApps platform services, it will show various platform specific settings as part of its ''burger menu'', so the user can set them. See ''Advanced settings'' in [[#UI elements|UI elements]] above.

Some options can also be set globally for all myApps clients in the PBX's [[{{NAMESPACE}}:PBX/Config/myApps#Client_Settings|PBX/Config/myApps ''Client Settings'']]
{|
! style="text-align: left; font-weight: bold" | Option

! style="text-align: left; font-weight: bold" | Description

! style="text-align: left; font-weight: bold" | Where to set

!
! style="text-align: left; font-weight: bold"| Availability
|-

| || || User menu || PBX ''Client Settings'' || Windows || iOS || Android || macOS

|-
| Autostart || Launch myApps on login || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| Appear offline after || controls after which idle time a user is considered ''inactive''. See [[#User activity|User activity]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔
|-

| Hotkeys || Hotkeys for call dial, accept, reject. See [[#Hot keys|Hot keys]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| Docking || Docking mode (left, right, none). See [[#???|??]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✗

|-

| Desktop notifications|| Turn on/off platform notifications. See [[#Notifications| Notifications]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| VPN || Disable VPN address for ICE candidate selection. See [[#RTP ports| RTP ports]] above || ✔ ||✔ ||✔ || ✗ || ✔ || ✔

|-

| Show in taskbar|| Show myApps in the taskbar in addition to it's tray icon. || ✔ ||✗ ||✔ || ✗ || ✗ || ✗

|-

| Log flags || turn on/off certain trace levels. See [[#Troubleshooting|Troubleshooting]] below. || ✔ ||✔ ||✔ || ✔ || ✔ || ✔

|-

| External applications || define the applications available for Apps to be started. See [[#Call an external application for calls|Call an external application for calls]] above. || ✔ ||✗ ||✔ || ✗ || ✗ || ✔

|-

| Ring in headset || send ring tone for incoming to headset instead of loudspeaker. || ✔ ||✗ ||✔ || ✗ || ✗ || ✗
|}
== Start parameters for Windows ==

On Windows, it is not possible to pass start parameters from the [https://www.chromium.org/developers Chromium documentation] to the myApps process.

== OS Settings for Windows ==
Windows settings can influence the display of ''Desktop notifications''. See [https://support.microsoft.com/en-us/help/4028678/windows-10-change-notification-settings Change notification settings in Windows 10/11] for details.

=== Windows 11 ===

* Windows 11 has a feature "do not disturb". This hides notifications if enabled.
* Windows 11 has a feature "focus". This enables "do not disturb" and thus hides notifications too.
* Windows 11 has priority settings for notifications. Ensure that VoIP notifications for calls are allowed any maybe also include myApps as an App which is allowed to show notifications.

== OS settings for Android ==
; Events : The appearance of notifications can be controlled here.

; Call accounts : For proper incoming call signaling, the call account ''myApps'' needs to be enabled. Note that on Samsung smartphones the call account switch likely toggles back and a few tries may need to be done until it persists. Please double-check the state.

; Preferred Calling Account : Choose which calling account (myApps/SIM/..) should be used for outgoing calls initiated from within the native phone app / phone book.

; Background data, unlimited data usage : Grant background data use to enable ''myApps'' to connect to the PBX immediately on an incoming call.

; Overlaying : This setting is not needed if call account ''myApps'' has been enabled. Should there be a reason for not enabling call account ''myApps'', the permission for overlaying needs to be granted on Android 10 or higher for proper call signaling.

Note: If no SIM card is installed some Android smartphones exhibit a problem dialing from the smartphone contacts. The contacts app shows a choice ''Select SIM card for this call'' but all possible dialers are greyed out. In this case make myApps the default phone app in Android settings ''Apps, Default apps, Telephony''.

== OS settings for iOS ==
; Notifications : The appearance of notifications can be controlled in iOS ''Settings, myApps''.

== OS settings for macOS ==

; Notifications : The appearance of notifications can be controlled in macOS ''Preferences, Notifications, myApps''.

=Troubleshooting=

myApps platform services can write various traces for debugging. Trace can be turned on and off selectively in the [[#Advanced settings|Advanced settings]].

The following trace flags can be set:

(''Recommended trace options are: '''App, Browser, ICE, TURN, Signaling and Audio'''. Please do not activate other flags unless innovaphone support says otherwise'')

{|
!style="text-align: left; font-weight: bold" | Abbreviation

!style="text-align: left; font-weight: bold" |code

!style="text-align: left; font-weight: bold" | description

|-
| App||0x000000001|| logs from the App Service itself
|-
| DNS||0x000000008|| logs DNS requests and results
|-
| HTTP client||0x000000080|| http client logs
|-
| TLS||0x000000400|| TLS logs
|-
| TCP||0x000000800|| TCP logs
|-
| LDS||0x000001000|| local domain sockets
|-
| WebSocket client||0x000004000|| logs outgoing websocket connections
|-
| App WebSocket||0x000008000|| logs app websocket connections (e.g. from PBX objects to an App Service or from the UI to the App Service)
|-
| UDP||0x000200000|| UDP logs
|-
| DTLS||0x000400000|| logs DTLS handshake and messages
|-
| Media||0x000800000|| logs media events
|-
| Media channel||0x001000000|| logs RTP/SCTP media connections
|-
| ICE||0x002000000|| logs ICE messages between peers
|-
| TURN||0x004000000|| logs TURN messages between peers
|-
| AppSharing||0x008000000|| logs AppSharing connection
|-
| Audio||0x010000000|| logs Audio connection and headset events
|-
| Video||0x020000000|| logs video connection and webcam events
|-
| Browser||0x040000000|| logs Chromium events
|-
| AppProxy||0x080000000|| logs requests which are proxied between the local webserver and the remote server
|-
| Webserver ||0x200000000|| enables webserver specific logs
|-
| Browser Console ||0x400000000|| logs browser console events
|-
| Signaling||0x800000000|| enables logs in the signaling module for debugging calls
|}
''code'' can be or'ed and used as value for the ''Log flags'' field in [[{{NAMESPACE}}:PBX/Config/myApps#Client_Settings|PBX/Config/myApps/Client Settings]].

; Windows :On Windows, traces are written to the <code>C:\Users\[UserName]\AppData\Local\innovaphone\myApps</code> directory. If you start myApps with --log-size as parameter, you can define the maximum size of a log file (e.g. --log-size=100000000 would be 100MB for each file)

:* myApps-''date-time''.txt : main log file for the platform services

:* myAppsOutlookSearch-''date-time''.txt : log file for the Outlook phone book access

:* myAppsHookController-''date-time''.txt : log file for the hot-key interceptor (see [[#Hot keys|Hot keys]])

; :myApps update installation traces are written to the <code>%windir%\temp\</code> directory.
:* myAppsInstall.txt: MSI installation file

; :myApps update service traces are written to the <code>%ALLUSERSPROFILE%\innovaphone\myAppsUpdateService</code> directory.
:* myAppsUpdateService-''date-time''.txt: myApps update service traces

;Android : traces can be sent by e-mail.

: also, an Android device might also be connected to a PC via an USB cable to get the traces. The files can be found in <code>Android/data/com.innovaphone.clientandroid/files</code>

; iOS : traces can be sent by e-mail.

; macOS : traces can be sent by e-mail.

: also, the files can be found in <code>~/Library/Containers/com.innovaphone.client-ios/Data/Documents/</code>. Press ''Alt+N'' followed by space to get tilde ''~''.

= Known Problems =
[[:Category:Problem myApps platform services|Known Problems]]

= Related Articles =
* [[{{NAMESPACE}}:Concept_myApps]]
* [[{{NAMESPACE}}:Concept_myApps_Redundancy|Reference14r2:Concept_myApps_Redundancy]]
* [[{{NAMESPACE}}:Concept_myApps_Office_Integration|Reference14r2:Concept_myApps_Office_Integration]]
* [[{{NAMESPACE}}:Concept_myAPPs_Search_in_local-Outlook_Contacts|Reference14r2:Concept_myAPPs_Search_in_local-Outlook_Contacts]]
* [[{{NAMESPACE}}:Call_Detail_Record_CDR_PBX|Reference14r2:Call_Detail_Record_CDR_PBX]]
* [[{{NAMESPACE}}:Concept Push Notifications for myPBX iOS and Android|Reference14r2:Concept Push Notifications for myPBX iOS and Android]]
* [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]]
* [[{{NAMESPACE}}:PBX/Config/myApps]]

[[Category:Concept myApps platform services]]

Reference15r1:Concept myApps platform services

2026-05-18T05:55:22Z

Vsc: /* myApps for macOS */

[[Category:Concept|myApps]]

myApps platform services provide various operating system specific services which can be used by other ''Apps'' running in the [[{{NAMESPACE}}:Concept myApps|myApps client]]. Those services typically are not available in the browser's JavaScript environment and hence must be implemented in native platform code. Therefore, the platform services are installed as native executable on the respective platform.

When myApps is started in a web browser (and hence has no access to the platform services), some Apps will use [https://en.wikipedia.org/wiki/WebRTC WebRTC] services implemented by the browser instead. For ease of reference, features available in this scenario are also described here.

On windows, the platform services also come with their own web browser in which the myApps web App will be started then. This browser is based on google's [https://en.wikipedia.org/wiki/Chromium_(web_browser) Chromium] open source software.
= Applies To =

* [[{{NAMESPACE}}:Concept myApps|myApps]]
* myApps for Windows
* myApps for macOS
* myApps for iOS
* myApps for Android

* myApps Web App (WebRTC)
version 14r2

=Features=
Not all features are available or required on all platforms.
{|
! style="text-align: left; font-weight: bold" | Feature

! style="text-align: left; font-weight: bold" | Description

! style="text-align: left; font-weight: bold"| Availability
|-

| || || Windows || iOS || Android || macOS || Browser<ref>This refers to the myApps web application running in a browser with no platform services available</ref>

|-
| audio || manage local audio devices to record and playback audio conversations || ✔ || ✔ || ✔ || ✔ || ✔ (audio available but devices managed by web browser)
|-

| video || manage local displays and cameras to capture and render video live stream || ✔ || ✔ || ✔ || ✔ || ✔ (video available but devices managed by web browser)

|-

| ringer || manage local ringing device || ✔ || ✔ || ✔ || ✔ || ✔
|-

| application sharing

|-

|   presenter || share an application || ✔ || ✗ || ✔ || ✔ || ✔
|-

|   consumer || view an application shared by the peer || ✔ || ✔ || ✔ || ✔ || ✔

|-

| hot keys || capture key presses for quick invocation of phone apps (e.g. dial selected number) || ✔ || ✗ || ✗ || ✔ || ✗
|-
| tel: and sip: URI handler || intercept clicks on tel: and sip: links in web sites to invoke phone apps || ✔ || ✔ || ✔ || ✔ || ✗

|-
| user activity || set presence state according to user activity || ✔ || ✗ || ✗ || ✔ || ✔<ref>limited, see [[#User activity|User activity]] below</ref>

|-

| docking || myApps can be docked persistently to the right or left edge of your screens || ✔ || ✗ || ✗ || ✗ || ✗

|-

| multi-windowing|| Apps can be launched in separate windows|| ✔ || ✗ || ✗ || ✔ || ✗

|-

| recording|| Calls can be recorded to recording app|| ✔ || ✔ || ✔ || ✔ || ✗

|-
| notifications || ||
|-
|   display notifications || display notifications with OS standard mechanism || ✔ || ✔ || ✔ || ✔ || ✔
|-
|   push notifications || receive push notifications while myApps is not running || ✗ || ✔ || ✔ || ✔ || ✔<ref>The browser needs to be running in order to receive push notifications.</ref>
|-
|   chat and apps || display notifications for chat and other apps || ✔ || ✔ || ✔ || ✔ || ✔
|-
|   calls || display notifications for incoming calls || ✔ || ✔ || ✔ || ✔ || ✗<ref>Call notifications are only displayed locally while the phone or softphone app is started.</ref>
|-

| phone book access || access local phone book || ✔ || ✔ || ✔ || ✔ || ✗
|-
| office presence provider || maps PBX presence state to Microsoft office presence state || ✔ || ✗ || ✗ || ✗ || ✗
|-

| external application start || start arbitrary external applications for calls || ✔ || ✗ || ✗ || ✔ || ✗

|-

| app proxy|| a caching proxy that provides app persistence || ✔ || ✔ || ✔ || ✔ || ✗

|-

| auto update || automatically updates myApps platform services to the same version the PBX has || ✔ || ✔ || ✗ || ✔ || ✔<ref>The then-current web app is always loaded from the PBX upon startup and hence up-to-date by definition</ref>
|-

| three party conference || initiate 3-pty-conference using Softphone-App || ✔ || ✔ || ✔ || ✔ || ✗

|-
| exclude VPN || disable use of VPN connections for audio and appsharing || ✔ || ✔ || ✔ || ✔ || ✗

|}

<references/>

=Requirements=
* innovaphone PBX 14r2 and up

== Hardware ==
Recommended hardware requirements
* Processor: Dual-core 2Ghz or higher
* RAM: 4 Gb

== myApps for Windows ==
* Windows 10 and up
* Windows Server 2016 and later versions

=== 32 & 64 bit Windows ===
* 32 bit Windows: install the myAppsSetup32.msi from the App Store
* 64 bit Windows: install the myAppsSetup.msi from the App Store
** the 64 bit variant still installs into Program Files (x86), as the main myApps.exe is still a 32bit application
** the 64 bit variant just contains an additional 64 bit binary for the outlook search

=== Windows N editions ===

Windows N editions are missing the ''Media Feature Pack'' which is pre installed on other Windows versions.

Please install the pack from [https://www.microsoft.com/en-us/software-download/mediafeaturepack Microsoft (Windows 10 pack)] before you install myApps. The installer will check if the file <code>C:\Windows\SysWOW64\mfplat.dll</code> exist on your system.

Make sure to install the correct pack depending on your Windows version! There are different packs for Windows 10 1703, 1803, 1809 and 32bit or 64bit etc.

NB: Sometimes the myApps installation will not work even though the media pack is already installed. This is because the installer has no read access to check if the package is already installed. If the above-mentioned file exists and the installer asks to install the Windows Media Feature Pack nevertheless, you have to start the myApps install with administrative rights.

=== Terminal Server environments ===

Audio driver was removed if myApps discovers that it is running in a terminal server environment like Citrix.

The audio driver is needed for the Softphone App but the Softphone App should not use an audio driver at the server side because the audio devices are plugged locally and there would be a delay sending and receiving audio data with the server.

If a customer wants to use the Softphone App at the server side he needs to make use of the myApps Plugin for virtual desktops solution:

[[{{NAMESPACE}}:MyApps_Plugin_for_Virtual_Desktops|Reference15r1:MyApps_Plugin_for_Virtual_Desktops]]

== myApps for macOS ==
* macOS 13 or higher

== myApps for iOS ==
* iOS 13 or higher

== myApps for Android ==
* Android 6.0 or higher. Android 6.x may need an update of the Chrome browser.

= Licenses =
* No license needed for myApps platform services

= Overview =
myApps platform services is a native executable that is installed using the standard mechanisms on the respective operating system. It provides various advanced services which can be used by the myApps web client code as well as the Apps running in the myApps context.

Also, on Windows, the platform services come with their own, dedicated browser to run myApps in. This browser is based on [https://en.wikipedia.org/wiki/Chromium_(web_browser) Chromium]. On iOS, macOS and Android, it is based upon native embedded web view facilities (such as WKWebView) instead.
== Components ==

=== RTP service for audio and appsharing ===
The RTP service provides audio and appsharing as a video stream. VoIP RTP endpoints (e.g. for softphones). It supports STUN, TURN, ICE, SRTP, DTLS. Note however that unlike WebRTC, these endpoints do not ''require'' ICE and DTLS. In other words, they can communicate also with non-compliant (i.e. older) VoIP devices.

Note that the available capabilities when not running the myApps platform services depend on the used browser's WebRTC implementation. See your browser documentation for details.

Apps can request RTP channels using the [https://sdk.innovaphone.com/doc/launcher/Media.htm Media Protocol]'s ''AllocChannel'' message.

===== RTP ports=====

{|

| audio || 50000 -> 50099

|-

| video (app sharing) || 50100 -> 50199

|}

The RTP service will enumerate all local interfaces and create local HOST candidates for ICE. There is an option however to disregard VPN interfaces (more precisely such interfaces with type of ''IF_TYPE_PPP'' or ''IF_TYPE_TUNNEL''). This can eliminate quality issues when RTP data is transmitted through TCP based VPN tunnels.

SRFLX and RELAY candidates are obtained using the STUN and TURN server configuration passed by the App (e.g the ''softphone'' App) as part of the ''AllocChannel'' request.
<code>{"mt":"AllocChannel","channel":"81429cba-396d-43de-8a76-ec020ba8796e","iceServers":[{"urls":"turn:myturn.domaincom:4077?transport=udp","username":"turnuser","credential":"pwd","credentialType":"password"},{"urls":"stun:mystun.domain.com:4077"}],"dn":"Foo Bar","type":"RemoteRtp","kind":"video"}</code>

===== Codecs =====

The installed myApps launchers provide codecs that can be used by softphone apps for media streams. When running in a web browser the codecs depend on the browser version and operating system. See the documentation of your browser for details.

The following codecs are supported:

{|
!style="text-align:left;width:100px;"|Codec
!style="width:100px"|Windows-Launcher
!style="width:100px"|Android
!style="width:100px"|iOS
!style="width:100px"|macOS
!style="width:100px"|Firefox (Browser)
!style="width:100px"|Chrome (Browser)
!style="width:100px"|Edge (Browser)
!style="width:100px"|Safari (Browser)
!style="width:100px"|Opera (Browser)
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Audio
|-
|G711A
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G711u
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G722
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G729
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729A
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729B
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729AB
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|[https://caniuse.com/#search=Opus OPUS-NB]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|[https://caniuse.com/#search=Opus OPUS-WB]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Video
|-
|[https://caniuse.com/#search=VP8 VP8]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|-
|[https://caniuse.com/#search=VP9 VP9]
|style="color:green;text-align:center"|✔**
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔**
|-
|[https://caniuse.com/#search=H264 H264]
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Application Sharing
|-
|Share
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|Watch
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔*
|style="color:green;text-align:center"|✔*
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|}

''* small presentation only'' 
''** only for 1:1 calls, not for conferences

===== Video capture =====

The default resolution for video capture is 1920x1080 if available. Otherwise, 1280x720, 640x480, 352x288 or 320x240 will be used. The frame rate is 30 fps if available, otherwise 15 fps. The resulting average bandwidth could reach 1 Mbps.

===== Application sharing =====

Screen content will be transmitted as video stream by the presenter

===== Device handling =====

The RTP service enumerates microphones, loudspeaker, cameras and ringing devices and notifies apps when devices come and go. It is up to the apps using the devices to store preferences.

The RTP service also enables some extended features (such as hook switch or volume control) for supported USB headsets or Bluetooth headsets connected to myApps.
The supported headset-SDKs determine which headset vendors are recommended to be used with the myApps softphone app. 

For this to work, the following vendor specific development kits are integrated in our myApps client. Be aware that the SDK are updated within our Service release :

{| class="wikitable"
|-
! SDK Vendor !! Supported OS !! SDK Version !! innovaphone Service Release
|-
| Jabra|| MacOS || 1.16.4.0 || 14r2sr11
|-
||| Windows || 1.16.4.0 || 15r1sr3
|-
| Epos ''(formerly Sennheiser)'' || MacOS || 12.4.0.5478 || 14r1sr3
|-
||| Windows || n.a. - [[Support:13r3 sr10 MyApps Windows Client - Epos/Sennheiser-Headsets require installed Epos-Connect Software|to be installed separately]]|| 13r3sr10
|-
| Poly ''(formerly Plantronics)'' || MacOS || 3.25.53799.37131 || 13r3sr9
|-
||| Windows || 3.25.53800.37131 || 13r3sr10
|-
| Yealink || MacOS || 3.1.1.23 || 14r2sr1
|-
||| Windows || 3.1.1.23 || 14r2sr2
|}

Notes:
* It is possible to inhibit the start of the Sennheiser SDK (SenncomSDK.exe) using the <code>DISABLEHEADSETS</code> directive of the installer (see [[#MSI Parameters and install options| MSI parameters]] below).

* Starting with V13r3sr10, the Epos-SDK needs to be installed separately using the Epos Connect software to ensure full compatibility between current Epos headset models and native myApps-Windows client. For details [[Support:13r3 sr10 MyApps Windows Client - Epos/Sennheiser-Headsets require installed Epos-Connect Software|refer to this article]].


===== Ring tones =====

Ring tones can be played. Apps can choose the tone from a pre-defined list of ring tones.

On Windows, custom ring tones can be uploaded as .mp3 files to the <code>ringtones</code> sub-directory of myApps' roaming directory (which usually is in <code>%appdata%\innovaphone\myApps\ringtones</code>).

On Android, custom ring tones can be added to the system via Android settings.

On iOS, custom ring tones can be uploaded as .mp3 files to the <code>Ringtones</code> subdirectory of the myApps file share that is available in iTunes if the iPhone has been connected via USB.

On macOS, custom ring tones can be uploaded as .mp3 files to <code>~/Library/Containers/com.innovaphone.client-macos/Data/Documents/Ringtones</code>.

===== Debugging =====
For extended debugging, turn on the ''Audio'', ''Media'' and ''AppSharing'' traces in myApps.

=== Hot keys ===
On Windows and macOS systems, myApps platform services can listen for hot keys and invoke certain functions. Invocation is done by sending API messages to myApps which passes it to an appropriate API provider (in the cases described here, this will be a ''phone'' or ''softphone'' or ''rcc'' App typically. See [[{{NAMESPACE}}:Concept_myApps#Client_APIs_and_default_apps | Client APIs and default apps]] for more details about this mechanism.

The hot keys can be specified using the ''advanced settings'' user interface (see [[#UI elements| UI elements]] below. Any of the function keys F1 to F11 (optionally combined with up to two modifier keys ''alt'', ''ctrl'', ''shift'' or ''win'') can be chosen for each function. If you do not want to start the call with "Hotkey+Enter" because you would have to wait for the focus, the hotkey can also be pressed twice and the number is dialled directly.

; dial selected number : Initiates a call using the currently selected text as target.

: A ''PrepareCall'' message with the ''text'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":"mt":"PrepareCall","text":"13","adjust":true}}</code>

; accept call : Accepts a currently alerting call.

: A ''ConnectCall'' message will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"ConnectCall"}}</code>

; reject/disconnect call : Rejects a currently alerting call or disconnects an active call.

: A ''DisconnectCall'' message will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"DisconnectCall"}}</code>

=== URL Handler ===

On Windows systems, two URI-handler are installed with the myApps platform services. Windows will call up this URI handler when a user clicks on an appropriate link, for example in a web site.

The handler will the send an API message to myApps which passes it to an appropriate API provider (in the cases described here, this will be a ''phone'' or ''softphone'' or ''rcc'' App typically. See [[{{NAMESPACE}}:Concept_myApps#Client_APIs_and_default_apps | Client APIs and default apps]] for more details about this mechanism.

; tel URI : call a number, e.g. <code>tel:4711</code>

: A ''PrepareCall'' message with the ''num'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartCall","num":"4711","adjust":true}}</code>
; sip URI : call a SIP name, e.g. <code>sip:zkl@innovaphone.com</code>

: A ''PrepareCall'' message with the ''sip'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartCall","sip":"zkl@innovaphone.com","adjust":true}}</code>
; im URI : start chat with SIP name, e.g. <code>im:zkl@innovaphone.com</code>

: A ''StartChat'' message with the ''sip'' argument set to the selected text will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.chat/com.innovaphone.chat.htm ''com.innovaphone.chat'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.chat","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartChat","sip":"zkl@innovaphone.com"}}</code>

On macOS systems myApps might be made the default application to handle tel URI e.g. <code>tel:4711</code> via Apple FaceTime. Open the "FaceTime" menu "Settings..." and select myApps as "Default for phone calls".

On iOS ''tel'' URIs are always dialed via GSM. Therefore myApps iOS also reacts to URI schemes ''com.innovaphone.tel'', ''com.innovaphone.sip'' and ''com.innovaphone.im'', e.g. <code><nowiki>com.innovaphone.tel:4711</nowiki></code>, <code><nowiki>com.innovaphone.sip:zkl@innovaphone.com</nowiki></code>, <code><nowiki>com.innovaphone.im:zkl@innovaphone.com</nowiki></code>.

=== User activity ===
On Windows and macOS systems, the myApps platform services can monitor user keyboard/mouse activity and change the user's presence state after a certain amount of inactivity. The timeout can be specified using the ''advanced settings'' user interface (see [[#UI elements| UI elements]] below.

myApps will then send a [https://sdk.innovaphone.com/doc/appwebsocket/myApps.htm#SetUserActivity''SetUserActivity''] message to the PBX using the ''myApps'' protocol.

: <code>{"mt":"SetUserActivity","inactive":true}</code>

This will change the ''status'' property of the ''im:'' contact for the user's own presence and hence result in a presence update from the PBX to myApps

: <code>{"mt":"UpdateOwnPresence","presence":[{...},{"contact":"im:","activity":"","status":"closed"}]}</code>
The ''closed'' status is reflected in the grey status color when displaying a contact [[Image:myapps-inactive.png|myapps-inactive.png/|myapps-inactive.png/]].

On iOS and Android, the state is set to ''inactive'' as soon as the App is brought to background.
When myApps platform services are not available (i.e. when running the web application in a browser solely) a limited user activity monitoring is available: the state is set to active when the web page is not used for more than 5 minutes.

=== Recording ===

The new launcher offers the possibility to record the audio of incoming and outgoing calls. In order to activate that functionality the URL of the recording instance must be configured in either the PBX (PBX->myApps->Config: Recording URL) or the softphone App (Settings->Audio Recording (URL))

[[Image:PBX-Recording-Settings.png|pbx-recording-settings.png/|pbx-recording-settings.png/]] [[Image:Recording-Softphone-Settings.png|recording-softphone-settings.png/|recording-softphone-settings.png/]].

As long as that URL is configured the audio data of all calls are stored as pcap-files under that URL.
If the URL points to a CF device in the PBX, write access must be granted for that URL (PBX->Services->HTTP->Server:Public compact flash access) and if the URL points to the recording app, the files can be accessed via the recording app [[{{NAMESPACE}}:Concept_App_Service_Recordings|recording]].

Under PBX->myApps the administrator can set a certain default behaviour of the audio recording like whether or not the recording should start automatically at the beginning of the call (Recording by Default ON/OFF), only calls with external numbers should be recorded (Record external calls only) or whether or not the user should be able to start/stop the recording himself (Allow user incall recording control). Except for the last parameter these parameters can also be modified by the user in its softphone settings if the administrator doesn't set the FORCE flag.

If the user was allowed by the admin to control the recording a recording switch is active during the call when the "Media" Panel is opened. There the audio recording may be stopped and continued at will. A red recording notice is shown in the top right corner when the recording actually takes place.

[[Image:Recording-incall-switch.png|recording-incall-switch.png/|recording-incall-switch.png/]]

=== Notifications ===

The myApps platform services can use the OS specific notification mechanism (e.g. ''desktop notifications'' on Windows) to display messages (e.g. ''incoming new chat message'') to the user.

Note that the actual rendering of the notification is under control of the OS. Therefore, myApps must be allowed to show notifications and its appearance can be restricted by OS native settings.

==== Microsoft Windows Notifications ====

Microsoft Windows Server editions (2016, 2019, 2022) are just capable of showing a single ''IncomingCall'' notification at the same time (we couldn't find a workaround for this limitation). 
An ''IncomingCall'' notification is visible the whole time instead of being moved to the action center after a certain time. 
 
A notification about a missed call uses the ''IncomingCall'' type so that this notification is visible until the user returns. 
Due to the above limitation, on a new arriving call such a missed call notification is transformed to a default notification which will be moved to the action center automatically. 
 
On non server editions, you can have multiple IncomingCall notifications at the same time (so two parallel incoming calls will be indeed notified at the same time), but the missed call notification handling is the same on both platforms!

Thus there will be always just '''one''' missed call notification visible and previous missed calls can be found inside your action center!

To see myApps notifications, ensure:
* System -> Notifications
** enable notifications
** disable "Do not disturb" or allow myApps as priority application while "Do not disturb" is active
** enable notifications for myApps in the list of applications
* System -> Focus
** if a focus session is active and the "Do not disturb" is activated during a focus session, make sure that myApps is a priority application (see above)

==== macOS Notifications ====
Notifications are the same as on Windows.
The difference is, that for macOS, notifications need to be allowed in the system settings.
Go to Notifications - myApps, select Banner and enable all check marks.

=== Local phonebook access ===
'''Contact Search:''' The myApps platform services implement an ''API provider'' for the [http://sdk.innovaphone.com/web1/com.innovaphone.search/lib1_api_search.htm ''com.innovaphone.search'' API]]. They perform search capabilities on the OS' local phone books which can be used by Apps like the ''phoneapp''.

Apps would send a ''Search'' request to the API:

: <code>{"mt":"ApiRequest","consumer":"dev:SwPh_zkl_5e42e884","provider":"*","src":"4","msg":{"mt":"Search","type":"contact","search":"john doe"},"apiId":"com.innovaphone.search"}</code>
Search results are delivered as ''SearchInfo'' messages:

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{"mt":"SearchInfo","relevance":2000,"adjust":true,"type":"contact","contact":{"givenname":"John","sn":"Doe","company":"ACME","position":"Head of everything","telephonenumber":["11111","22222"],"homephone":["+4944444","33333"],"mobile":["+49 (123) 55555"]}},"api":"com.innovaphone.search"}</code>

'''Reverse Lookup:''' The myApps platform services implement an ''API provider'' for the [http://sdk.innovaphone.com/web1/com.innovaphone.phonelookup/lib1_api_phonelookup.htm ''com.innovaphone.phonelookup'' API]. They perform search capabilities on the OS' local phone books which can be used by Apps like the ''phoneapp''.

Apps would send a ''Lookup'' request to the API:

: <code>{"mt":"ApiRequest","consumer":"dev:SwPh_zkl_5e42e884","provider":"*","src":"4","msg":{ mt: "Lookup", prefixIntl: "000", prefixNtl: "00", prefixExt:"0", area: "7031", country: "49", lookup: "0004970311234567" },"apiId":"com.innovaphone.lookup"}</code>

Search results are delivered as ''LookupInfo'' messages:

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{mt: "LookupInfo", dn: "Jake Blues", contact: { telephonenumber: ["0004970311234567"], givenname: "Jake", sn: "Blues", company: "Blues Brothers" </code>

==== Windows ====
On Windows, the search and lookup are performed in all of the user's Outlook contact folders. As opposed to the search implemented in the ''Contacts'' and ''Users'' App, all items are returned which match any of the search words (i.e. searching for ''a b'' will return items matching either ''a'' or ''b'').

; searched properties : firstname, lastname
; returned properties : Following Outlook contact phone number properties are returned (if available):

:* OFFICE_TELEPHONE_NUMBER as ''telephonenumber''
:* OFFICE2_TELEPHONE_NUMBER as ''telephonenumber''
:* HOME_TELEPHONE_NUMBER as ''homephone''
:* HOME2_TELEPHONE_NUMBER as ''homephone''
:* MOBILE_TELEPHONE_NUMBER as ''mobile''
:* BUSINESS_FAX_NUMBER as ''facsimiletelephonenumber''
Note that contact information is cached in the search provider. Updated contacts may therefore become effective after a while only.
Outlook search will create its own trace file <code>myAppsOutlookSearch-</code>''date-time''<code>.txt</code> in the standard trace directory.

This search provider is always installed and can be disabled. There is no need (nor possibility) to enable it in the ''Apps'' tab of the PBX's user object. Also, no ''App'' object needs to be created for it.

==== Android/iOS ====
The search and lookup are performed in the contacts.

==== macOS ====
The search and lookup are performed in the contacts. If you wish to disable local contact lookup, go to system settings - Security & Privacy and disable the access to contacts for myapps.

=== Microsoft Office integration ===

The myApps platform services has a ''office presence provider'' that can provide the user's presence state to Office applications. See [[{{NAMESPACE}}:Concept_myApps_Office_Integration|myApps Office Integration]] for details.

This feature is installed by default. However, it can be disabled using the ''OFFICEPRESENCE'' MSI Parameter. Also, a check-mark is available in the setup dialog.

=== Call an external application for calls ===

Phone Apps (such as the phoneapp or softphone) can initiate the start of an external application when a new call appears (either incoming or outgoing). The actual spawning of the application is done by the myApps platform service. Also, the application properties (such as e.g. the executable's path) is configured in the myApps platform services (see [[#UI elements|Advanced settings]] in the ''UI elements'' section below).

A number of arguments can be passed to the application by substituting $-variables in the ''Parameter'' field:

; $n : phone number as dialed (called party number for outgoing calls) or received (calling party number for incoming calls)

; $N : called or calling party number in ''national'' format (e.g. 07031730090)

; $I : called or calling party number in ''international'' format (e.g. +497031730090)

: note that both $N and $I only work if $n includes both subscriber number and area code (e.g. 07031730090). Otherwise they are equal to $n

; $d : display name of peer (if known)

; $u : URI name of the peer (if available eg with a federation call)

; $c : conference id

: this is a globally unique ID for this call and may be used to relate the call to the ''guid'' found in the CallInfo structure in the [http://wiki.innovaphone.com/index.php?title=Reference10:SOAP_API#CallInfo SOAP-API] and [http://sdk.innovaphone.com/doc/appwebsocket/RCC.htm RCC-API ]. Also, corresponding [[Reference10:Call Detail Record CDR PBX|CDRs]] can be related using the ''event'' tag's ''conf'' attribute.
The start of an external application can be requested using the ''com.innovaphone.externalapps'' API.

Some setup examples are [[Howto:Integrate External Apps in innovaphone UC clients|shown here]].

=== Push ===

Mobile operating systems usually inhibit network operation of apps which run in the background or are closed by the user. This is done in order to reduce battery consumption. Unfortunately, this also stops such apps to maintain a registration by regularly sending ''keep alive'' messages to a server (in our case to the PBX). As a result, myApps will be disconnected from the PBX. When the PBX determines that there is an event for the application which needs a response, it needs to wake up the app using a dedicated channel provided by the operating system. This mechanism is know as ''push''. When running on iOS or Android, myApps supports ''push''.

For ''push'' to work, a [[{{NAMESPACE}}:PBX/Objects/Push|''push object'']] needs to be configured in the PBX . Also, it needs to be enabled on the mobile phone for the myApps app.
This mechanism is quite similar in v12 and v13, so you can refer to [[{{NAMESPACE}}:Concept_Push_Notifications_for_iOS_and_Android|Reference14r2:Concept_Push_Notifications_for_iOS_and_Android]] for more details.

Also, helpful hints can be found in [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]].

=== App Proxy ===

myApps runs further ''Apps'' (such as e.g. the ''phoneapp'') as a web page in an IFRAME of the browser myApps is running in. The App's page code is loaded either from the PBX or from an ''application platform'' (AP). This however would mean that the App's IFRAME would remain empty (a dead white screen) when the PBX or AP is not available. To make sure the App can start-up anyway, the myApps platform services feature the so-called ''App Proxy''. This is a caching proxy that caches all the App code so it is available even in case of network failure. When myApps runs in the context of the platform services, Apps are therefore not loaded from the App source directly, but from the local App proxy.

The cached files are stored in the PCs local file system in the <code>%LOCALAPPDATA%\innovaphone\myApps\appproxy</path></code>. There is no configuration required. However, if myApps seems to run with outdated or corrupt cached copies of the App, you can safely delete the entire directory.

=== Auto update ===

On Windows and on macOS, the myApps platform services can auto-update themselves to a common version. This is controlled by the [[{{NAMESPACE}}:PBX/Config/myApps#Launcher_Software_Update | ''Launcher Software Update'']] settings under ''PBX/Config/myApps'' in the PBX.

When myApps is started or the user logs in or myApps needs to re-connect to the PBX, the platform services will use the [http://sdk.innovaphone.com/web1/com.innovaphone.client/lib1_api_client.htm com.innovaphone.client API] to learn the desired version (''launcherUpdateBuild'', which is part of the API's ''model''). If this differs from the current version, the platform services will try to download the respective new version.

{
"mt": "ApiUpdate",
"apis": {
"com.innovaphone.client": {
"@client": {
"title": "innovaphone myApps",
"model": {
"launcher": true,
"launcherUpdateBuild": "134906",
"appStoreUrl": "http://store.innovaphone.com/release/download/"
}
}
}
}
}

The installation of the downloaded version is done by the ''innovaphonemyAppsUpdateService''. This service is installed and enabled during the initial installation of the myApps platform services. To disable auto-update, either leave the ''Launcher Software Update'' settings empty or set the service's start mode to ''disabled'' in the Windows ''services control panel''.

Note that on Windows the update service does not work on terminal servers. Administrators must do myApps base services updates using standard windows mechanisms.

Note that on macOS if myApps has been installed from the Apple Store it is assumed that auto update from the PBX is not desired and disabled therefore.

On Android/iOS/macOS updates can be downloaded from the respective app store.

The ''Devices'' app can not update software installed on Windows PCs directly. However, when the PBX is updated using an ''update job'' in the ''Devices'' App, the ''Launcher Software Update'' settings will be updated accordingly and hence the myApps base services will ultimately also be updated to the same version.

==== Auto update flow on Windows ====

* On start of myApps, myApps checks if an update is available and ready for installation
** if yes, the update is installed directly, without user interaction (a popup is shown during the installation)
** if not, myApps starts
* if an update is available while myApps is already running, an update notification will be shown which let's the user choose to install the update now or later (the notification will then popup again after one hour)

==UI elements ==
There are a few user interfaces provided by the platform services:
===tray-icon (Windows only) ===
::[[Image:myapps-tray.png|myapps-tray.png/|myapps-tray.png/]]
:Allows to
:* terminate myApps
:* toggle the ''autostart'' state
:* toggle the ''show in task bar'' state
:* open the trace folder
:
=== PBX connect form===
:: [[Image:myapps-connect.png|myapps-connect.png/|myapps-connect.png/]]
: Allows the user to specify the connect data for the PBX (i.e. IP address or DNS name)
:
=== Advanced settings===
::[[Image:myapps-settings0.png|myapps-settings0.png/|myapps-settings0.png/]]
::[[Image:myapps-settings.png|myapps-settings.png/|myapps-settings.png/]] [[Image:myapps-settings2.png|myapps-settings2.png/|myapps-settings2.png/]] [[Image:myapps-settings3.png|myapps-settings3.png/|myapps-settings3.png/]]

: Allows to modify various platform dependant settings (such as e.g. the hotkey selection on Windows)

== Interfaces ==
=== Provided APIs ===

; [http://sdk.innovaphone.com/web1/com.innovaphone.search/lib1_api_search.htm com.innovaphone.search] : access to local phone book entries by the [[#Local phonebook access|Local phonebook access]] component.
; [http://sdk.innovaphone.com/web1/com.innovaphone.launcher/com.innovaphone.launcher.htm com.innovaphone.launcher] : display of OS specific user notifications and receipt of related user actions
; com.innovaphone.notificationhandler : reports back click on a notification.
; com.innovaphone.externalapps : to start external applications, see [[#Call an external application for calls|Call an external application for calls]] above

=== Used APIs ===

; [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm com.innovaphone.phone] : used to initiate new or manipulate existing calls by the [[#Hot keys|Hot keys]] and [[#URL handler|URL handler]] components.

; [http://sdk.innovaphone.com/web1/com.innovaphone.chat/com.innovaphone.chat.htm com.innovaphone.chat] : used to start a new chat by the [[#URL handler|URL handler]] component.

; [http://sdk.innovaphone.com/web1/com.innovaphone.client/lib1_api_client.htm com.innovaphone.client] : the model is used to learn the update settings, see [[#Auto update|Auto update]] above

=== Protocols ===

; [https://sdk.innovaphone.com/doc/launcher/Media.htm Media Protocol] : used by apps to allocate RTP channels, see [[#RTP service for audio.2C video and data|RTP service for audio, video and data]] above

== Related App Services ==

none

== Known limitations ==
; Incoming call as banner on myApps for iOS : Since iOS 14 the iOS CallKit presents incoming calls as a banner leaving the original green answer button of myApps visible. Use only the blue button of the banner to accept the call or change iPhone Settings, App "Phone", "Incoming Calls" to "Full Screen" to hide the myApps user interface again during call answering.

; Call answer in speakerphone mode even with active Bluetooth headset on myApps for iOS : This causes unwanted speakerphone operation if the smartphone is used with a Bluetooth car audio system. The behaviour can be changed by selecting ''Bluetooth Headset'' in this setting:
:''iOS Settings->Accessibility->Touch->Call Audio Routing: Automatic / Bluetooth Headset / Speaker''
:''iOS Einstellungen->Bedienungshilfen->Tippen->Anrufaudioausgabe: Automatisch / Bluetooth-Headset / Lautsprecher''

; Windows Server 2016 (Windows 10 Build 1607) : windows just shows the first notification. Further notifications aren't displayed until the previous ones are removed from the notification center. Current windows builds do not show this behaviour anymore.

; Problems on Mac computers with Yealink USB headsets
: we have received reports that myApps quits unexpectedly on some Mac computers when a Yealink headset is plugged in. Unfortunately, we could not find out the cause yet. If you use Yealink USB headsets and have a similar issue, please open a support ticket and send myApps traces.

; Poly / Plantronics headset buttons only functional if myApps is started with Rosetta
: myApps macOS supports Apple M1/M2 hardware natively. However, the Poly / Plantronics headset SDK is only available for Intel platform and thus myApps needs to be started via Apple's Intel emulator Rosetta if a Poly / Plantronics headset is used. This is done with right-click on the myApps executable, ''Information'', ''Open with Rosetta''.

; Windows surface devices may not work correctly
: Chromium does not get touch keyboard events. USB Keyboards may not be recognized either.

= Installation =

== Windows ==

myApps platform services are installed on Windows using the .msi file found in the ''myApps Windows'' package from [https://store.innovaphone.com/release/download.htm store.innovaphone.com].

myApps can update itself automatically, see [[#Auto update|Auto update]] above.

=== MSI Parameters and install options ===

The MSI installer of myApps for Windows supports the following parameters and can be edited with [https://docs.microsoft.com/en-us/windows/win32/msi/orca-exe Microsoft Orca]. You can add your parameters in the table ''property''.

; SERVER (REG_SZ): the PBX's server address (without protocol like https://)
; OFFICEPRESENCE (REG_DWORD): '''false''' to disable presence integration in Microsoft Office
: this is also available as a check-mark when running the install manually

; DISABLEHEADSETS (REG_DWORD): '''true''' to disable headsets support, see [[#Device handling|Device handling]] above

; EXTERNALAPPS (REG_SZ): pre-define external applications, see [[#Call an external application for calls|Call an external application for calls]] above
: e.g. <code>"{""externalApps"":[{""id"":0,""name"":""Wireshark"",""path"":""C:\\Program Files\\Wireshark\\Wireshark.exe"",""param"":""test $I""}]}"</code>

; FORCERESTART (REG_DWORD): '''true''' (or any string ...) kills myApps during the installation and restarts it for the currently logged in user, if it was running

; DISABLELOCALHOST (REG_DWORD): '''true''' to disable use of '''localhost''' string to access the local webserver. Use '''127.0.0.1''' instead

; EXCLUDEINTERFACES (REG_SZ): some VPN interfaces are not detected by Windows as IF_TYPE_PPP or IF_TYPE_TUNNEL and therefore the '''media outside VPN''' setting is not taking effect. With this option interfaces can be pre-defined that will not be used for media. Interfaces must be comma separated
: e.g. <code>EXCLUDEINTERFACES="172,192.168,10.10"</code>

; FASTERDOWNLOADS (REG_DWORD): '''true''' to have faster downloads without artificially slowing down the download of an update (which is done to avoid audio lags if clients have slow networks).

Current settings are stored in the registry at <code>Computer\HKEY_CURRENT_USER\Software\innovaphone\myApps</code> or at <code>Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\innovaphone\myApps</code>

Boolean values like OfficePresence are stored in registry entries with type REG_DWORD and values 1 or 0. 0 disables the setting and 1 enables it.

== iOS ==

myApps platform services are installed on iOS by loading ''innovaphone myApps'' from the ''App Store''.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying this dictionary in the MDM
<plist>
<dict>
<key>server</key>
<string>pbx.example.com</string>
</dict>
</plist>

== macOS ==

myApps platform services might be installed directly from the Apple store. An installer package <code>myapps.pkg</code> and a disk image <code>myapps.dmg</code> is also available from the innovaphone app store. Install <code>myapps.pkg</code> by double-click on the file and follow the instructions of the installer. myApps becomes available in the Applications folder and can be opened by double-click. Or download and open <code>myapps.dmg</code> and double klick myApps. If desired integrate it into the app dock by right click, ''Options, Keep in the dock''.

If installed from the innovaphone app store, myApps can update itself automatically, see [[#Auto update|Auto update]] above.

If installed from the Apple store, macOS notifies about updates on the Apple store. myApps [[#Auto update|Auto update]] is disabled then.

If a clean-install of the client is necessary, the folder "/Users/username/Library/Containers/myapps" needs to be deleted. To be on the safe side also delete it from the trash bin.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying this dictionary in the MDM
<plist>
<dict>
<key>server</key>
<string>pbx.example.com</string>
</dict>
</plist>

=== Preferences ===

macOS supports preference settings that can be set via a shell command or via Mac remote management

defaults write com.innovaphone.client-ios-14r1 server "PBX-server-URL"

The following parameters and can be set through this method:

; server: the PBX's server URL

=== Setting myApps as Default App for SIP-URLs ===

{| class="wikitable"
|defaults write com.apple.LaunchServices/com.apple.launchservices.secure LSHandlers -array-add '{
LSHandlerURLScheme = sip;
LSHandlerRoleAll = "<CFBundleIdentifier>";
}'
|}

To find the “CFBundleIdentifier”, proceed as follows:
* In the Finder under “Applications”, search for the desired myApps client that you want to set as the default app.
* Right-click on “Show package contents” -> you will find the “CFBundleIdentifier” in the Info.plist file.

A restart of the MAC is required.

=== Using Sennheiser headsets ===
If you use Sennheiser headsets, you should also install the then-current <code>DSEA_SDK_v</code>''version''<code>.pkg</code> package, after you installed the myApps client. Without that, audio will still work, but not the controls on the headset. You will need to keep that up-to-date yourself, as it is not updated by myApps's auto-update function.

== Android ==

myApps platform services are installed on Android by loading ''innovaphone myApps'' from the ''Play Store''.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying a property "server" with string value "pbx.example.com" in the MDM.

= Configuration =

== Server configuration ==
When opening myApps for the first time, the user is prompted for the Server. Usually only the hostname (DNS host name or IP address) needs to be configured.

But there are more options for special PBX configurations.

; Non-standard HTTPS port
: If the PBX uses a non-standard HTTPS port, it must be appended to the host name separated by a colon (<code>:</code>).
: Example: <code>pbx.example.com:4444</code> (expands to <code>https://pbx.example.com:4444/PBX0/APPCLIENT/appclient.htm</code>)
; DynPBX module name
: If the PBX is a DynPBX, the module id must be appended to PBX0 separated - (<code>/</code>).
: Example: <code>pbx.example.com/PBX0-1</code> (expands to <code>https://pbx.example.com/PBX0-1/APPCLIENT/appclient.htm</code>)
; Softphone physical location
: If user defined physical location shall be used for softphone, you can append it using a parameter <code>#phys=</code>.
: Example: <code>pbx.example.com#phys=slave</code> (expands to <code>https://pbx.example.com/PBX0/APPCLIENT/appclient.htm#phys=slave</code>)

Example 1: PBX pbx.example.com with standard configuration
pbx.example.com

Example 2: PBX slave.example with DynPBX module ID 1, HTTPS port 4444 and physical location master
slave.example.com:4444/PBX0-1#phys=master

=== HTTP proxy support ===

myApps platform services do support operation via HTTP proxy now. If one or more proxies have been configured in the network settings of the operating system for the active network connection, HTTP CONNECT tunnels are established.

On Windows user name and password can be specified for the tunnel servers as generic credentials in the credentials manager (Anmeldeinformationsverwaltung). The name of the credentials must be the tunnel server hostname.

On Android user name and password can be specified through Android ''Settings, Accounts'' by adding a myApps ''HTTP Proxy Credentials'' account. The name of the account must be the tunnel server hostname.

== Platform specific settings ==
When myApps runs under the myApps platform services, it will show various platform specific settings as part of its ''burger menu'', so the user can set them. See ''Advanced settings'' in [[#UI elements|UI elements]] above.

Some options can also be set globally for all myApps clients in the PBX's [[{{NAMESPACE}}:PBX/Config/myApps#Client_Settings|PBX/Config/myApps ''Client Settings'']]
{|
! style="text-align: left; font-weight: bold" | Option

! style="text-align: left; font-weight: bold" | Description

! style="text-align: left; font-weight: bold" | Where to set

!
! style="text-align: left; font-weight: bold"| Availability
|-

| || || User menu || PBX ''Client Settings'' || Windows || iOS || Android || macOS

|-
| Autostart || Launch myApps on login || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| Appear offline after || controls after which idle time a user is considered ''inactive''. See [[#User activity|User activity]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔
|-

| Hotkeys || Hotkeys for call dial, accept, reject. See [[#Hot keys|Hot keys]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| Docking || Docking mode (left, right, none). See [[#???|??]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✗

|-

| Desktop notifications|| Turn on/off platform notifications. See [[#Notifications| Notifications]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| VPN || Disable VPN address for ICE candidate selection. See [[#RTP ports| RTP ports]] above || ✔ ||✔ ||✔ || ✗ || ✔ || ✔

|-

| Show in taskbar|| Show myApps in the taskbar in addition to it's tray icon. || ✔ ||✗ ||✔ || ✗ || ✗ || ✗

|-

| Log flags || turn on/off certain trace levels. See [[#Troubleshooting|Troubleshooting]] below. || ✔ ||✔ ||✔ || ✔ || ✔ || ✔

|-

| External applications || define the applications available for Apps to be started. See [[#Call an external application for calls|Call an external application for calls]] above. || ✔ ||✗ ||✔ || ✗ || ✗ || ✔

|-

| Ring in headset || send ring tone for incoming to headset instead of loudspeaker. || ✔ ||✗ ||✔ || ✗ || ✗ || ✗
|}
== Start parameters for Windows ==

On Windows, it is not possible to pass start parameters from the [https://www.chromium.org/developers Chromium documentation] to the myApps process.

== OS Settings for Windows ==
Windows settings can influence the display of ''Desktop notifications''. See [https://support.microsoft.com/en-us/help/4028678/windows-10-change-notification-settings Change notification settings in Windows 10/11] for details.

=== Windows 11 ===

* Windows 11 has a feature "do not disturb". This hides notifications if enabled.
* Windows 11 has a feature "focus". This enables "do not disturb" and thus hides notifications too.
* Windows 11 has priority settings for notifications. Ensure that VoIP notifications for calls are allowed any maybe also include myApps as an App which is allowed to show notifications.

== OS settings for Android ==
; Events : The appearance of notifications can be controlled here.

; Call accounts : For proper incoming call signaling, the call account ''myApps'' needs to be enabled. Note that on Samsung smartphones the call account switch likely toggles back and a few tries may need to be done until it persists. Please double-check the state.

; Preferred Calling Account : Choose which calling account (myApps/SIM/..) should be used for outgoing calls initiated from within the native phone app / phone book.

; Background data, unlimited data usage : Grant background data use to enable ''myApps'' to connect to the PBX immediately on an incoming call.

; Overlaying : This setting is not needed if call account ''myApps'' has been enabled. Should there be a reason for not enabling call account ''myApps'', the permission for overlaying needs to be granted on Android 10 or higher for proper call signaling.

Note: If no SIM card is installed some Android smartphones exhibit a problem dialing from the smartphone contacts. The contacts app shows a choice ''Select SIM card for this call'' but all possible dialers are greyed out. In this case make myApps the default phone app in Android settings ''Apps, Default apps, Telephony''.

== OS settings for iOS ==
; Notifications : The appearance of notifications can be controlled in iOS ''Settings, myApps''.

== OS settings for macOS ==

; Notifications : The appearance of notifications can be controlled in macOS ''Preferences, Notifications, myApps''.

=Troubleshooting=

myApps platform services can write various traces for debugging. Trace can be turned on and off selectively in the [[#Advanced settings|Advanced settings]].

The following trace flags can be set:

(''Recommended trace options are: '''App, Browser, ICE, TURN, Signaling and Audio'''. Please do not activate other flags unless innovaphone support says otherwise'')

{|
!style="text-align: left; font-weight: bold" | Abbreviation

!style="text-align: left; font-weight: bold" |code

!style="text-align: left; font-weight: bold" | description

|-
| App||0x000000001|| logs from the App Service itself
|-
| DNS||0x000000008|| logs DNS requests and results
|-
| HTTP client||0x000000080|| http client logs
|-
| TLS||0x000000400|| TLS logs
|-
| TCP||0x000000800|| TCP logs
|-
| LDS||0x000001000|| local domain sockets
|-
| WebSocket client||0x000004000|| logs outgoing websocket connections
|-
| App WebSocket||0x000008000|| logs app websocket connections (e.g. from PBX objects to an App Service or from the UI to the App Service)
|-
| UDP||0x000200000|| UDP logs
|-
| DTLS||0x000400000|| logs DTLS handshake and messages
|-
| Media||0x000800000|| logs media events
|-
| Media channel||0x001000000|| logs RTP/SCTP media connections
|-
| ICE||0x002000000|| logs ICE messages between peers
|-
| TURN||0x004000000|| logs TURN messages between peers
|-
| AppSharing||0x008000000|| logs AppSharing connection
|-
| Audio||0x010000000|| logs Audio connection and headset events
|-
| Video||0x020000000|| logs video connection and webcam events
|-
| Browser||0x040000000|| logs Chromium events
|-
| AppProxy||0x080000000|| logs requests which are proxied between the local webserver and the remote server
|-
| Webserver ||0x200000000|| enables webserver specific logs
|-
| Browser Console ||0x400000000|| logs browser console events
|-
| Signaling||0x800000000|| enables logs in the signaling module for debugging calls
|}
''code'' can be or'ed and used as value for the ''Log flags'' field in [[{{NAMESPACE}}:PBX/Config/myApps#Client_Settings|PBX/Config/myApps/Client Settings]].

; Windows :On Windows, traces are written to the <code>%LOCALAPPDATA%\innovaphone\myApps</code> directory. If you start myApps with --log-size as parameter, you can define the maximum size of a log file (e.g. --log-size=100000000 would be 100MB for each file)

:* myApps-''date-time''.txt : main log file for the platform services

:* myAppsOutlookSearch-''date-time''.txt : log file for the Outlook phone book access

:* myAppsHookController-''date-time''.txt : log file for the hot-key interceptor (see [[#Hot keys|Hot keys]])

; :myApps update installation traces are written to the <code>%windir%\temp\</code> directory.
:* myAppsInstall.txt: MSI installation file

; :myApps update service traces are written to the <code>%ProgramData%\innovaphone\myAppsUpdateService</code> directory.
:* myAppsUpdateService-''date-time''.txt: myApps update service traces

;Android : traces can be sent by e-mail.

: also, an Android device might also be connected to a PC via an USB cable to get the traces. The files can be found in <code>Android/data/com.innovaphone.clientandroid/files</code>

; iOS : traces can be sent by e-mail.

; macOS : traces can be sent by e-mail.

: also, the files can be found in <code>~/Library/Containers/com.innovaphone.client-ios/Data/Documents/</code>. Press ''Alt+N'' followed by space to get tilde ''~''.

= Known Problems =
[[:Category:Problem myApps platform services|Known Problems]]

= Related Articles =
* [[{{NAMESPACE}}:Concept_myApps]]
* [[{{NAMESPACE}}:Concept_myApps_Redundancy|Reference14r2:Concept_myApps_Redundancy]]
* [[{{NAMESPACE}}:Concept_myApps_Office_Integration|Reference14r2:Concept_myApps_Office_Integration]]
* [[{{NAMESPACE}}:Concept_myAPPs_Search_in_local-Outlook_Contacts|Reference14r2:Concept_myAPPs_Search_in_local-Outlook_Contacts]]
* [[{{NAMESPACE}}:Call_Detail_Record_CDR_PBX|Reference14r2:Call_Detail_Record_CDR_PBX]]
* [[{{NAMESPACE}}:Concept Push Notifications for myPBX iOS and Android|Reference14r2:Concept Push Notifications for myPBX iOS and Android]]
* [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]]
* [[{{NAMESPACE}}:PBX/Config/myApps]]

[[Category:Concept myApps platform services]]

Reference16r1:Concept myApps platform services

2026-05-13T14:26:20Z

Vsc: /* Troubleshooting */

[[Category:Concept|myApps]]

myApps platform services provide various operating system specific services which can be used by other ''Apps'' running in the [[{{NAMESPACE}}:Concept myApps|myApps client]]. Those services typically are not available in the browser's JavaScript environment and hence must be implemented in native platform code. Therefore, the platform services are installed as native executable on the respective platform.

When myApps is started in a web browser (and hence has no access to the platform services), some Apps will use [https://en.wikipedia.org/wiki/WebRTC WebRTC] services implemented by the browser instead. For ease of reference, features available in this scenario are also described here.

On windows, the platform services also come with their own web browser in which the myApps web App will be started then. This browser is based on google's [https://en.wikipedia.org/wiki/Chromium_(web_browser) Chromium] open source software.
= Applies To =

* [[{{NAMESPACE}}:Concept myApps|myApps]]
* myApps for Windows
* myApps for macOS
* myApps for iOS
* myApps for Android
* myApps Web App (WebRTC)
* myApps for IP270
version 16r1

=Features=
Not all features are available or required on all platforms.
{|
! style="text-align: left; font-weight: bold" | Feature
! style="text-align: left; font-weight: bold" | Description
! style="text-align: left; font-weight: bold"| Availability
|-
| || || Windows || iOS || Android || macOS || Browser<ref>This refers to the myApps web application running in a browser with no platform services available</ref>
|IP270
|-
| [[#Device handling|Audio Devices]]|| manage local audio devices to record and playback audio conversations || ✔ || ✔ || ✔ || ✔ || ✔<ref>audio available but devices managed by web browser</ref>|| ✔
|-
| Video || manage local displays and cameras to capture and render video live stream || ✔ || ✔ || ✔ || ✔ || ✔<ref>video available but devices managed by web browser</ref>|| ✔
|-
| Ringer || manage local ringing device || ✔ || ✔ || ✔ || ✔ || ✔ || ✔
|-
| [[#Application sharing|Application sharing]]
|-
|   presenter || share an application || ✔ || ✗ || ✔ || ✔ || ✔ || ✔
|-
|   consumer || view an application shared by the peer || ✔ || ✔ || ✔ || ✔ || ✔ || ✔
|-
| [[#Hot keys|Hot keys]]|| capture key presses for quick invocation of phone apps (e.g. dial selected number) || ✔ || ✗ || ✗ || ✔ || ✗ || ✗
|-
| [[#URL Handler|tel: and sip: URI handler]]|| intercept clicks on tel: and sip: links in web sites to invoke phone apps || ✔ || ✔ || ✔ || ✔ || ✗ || ✗
|-
| [[#User activity|User activity]]|| set presence state according to user activity || ✔ || ✗ || ✗ || ✔ || ✔<ref>limited, see [[#User activity|User activity]] below</ref> || ✔
|-
| Docking || myApps can be docked persistently to the right or left edge of your screens || ✔ || ✗ || ✗ || ✗ || ✗ || ✗
|-
| Multi-windowing || Apps can be launched in separate windows|| ✔ || ✗ || ✗ || ✔ || ✗ || ✗
|-
| [[#Recording|Recording]]|| Calls can be recorded to recording app|| ✔ || ✔ || ✔ || ✔ || ✗ || ✔
|-
| [[#Notifications|Notifications]]|| ||
|-
|   display notifications || display notifications with OS standard mechanism || ✔ || ✔ || ✔ || ✔ || ✔ || ✗
|-
|   push notifications || receive push notifications while myApps is not running || ✗ || ✔ || ✔ || ✔ || ✔<ref>The browser needs to be running in order to receive push notifications.</ref> || ✗
|-
|   chat and apps || display notifications for chat and other apps || ✔ || ✔ || ✔ || ✔ || ✔ || ✗
|-
|   calls || display notifications for incoming calls || ✔ || ✔ || ✔ || ✔ || ✗<ref>Call notifications are only displayed locally while the phone or softphone app is started.</ref> || ✗
|-
| [[#Local phonebook access|Local phonebook]]|| access local phone book || ✔ || ✔ || ✔ || ✔ || ✗ || ✗
|-
| [[#Microsoft Office Integration|Office presence provider]]|| maps PBX presence state to Microsoft office presence state || ✔ || ✗ || ✗ || ✗ || ✗ || ✗
|-
| [[#Call an external application for calls|External application start]]|| start arbitrary external applications for calls || ✔ || ✗ || ✗ || ✔ || ✗ || ✗
|-
| [[#App Proxy|App Proxy]]|| a caching proxy that provides app persistence || ✔ || ✔ || ✔ || ✔ || ✗ || ✗
|-
| [[#Auto update|Auto update]]|| automatically updates myApps platform services to the same version the PBX has || ✔ || ✔ || ✗ || ✔ || ✔<ref>The then-current web app is always loaded from the PBX upon startup and hence up-to-date by definition</ref> || ✔
|-
| Three party conference || initiate 3-pty-conference using Softphone-App || ✔ || ✔ || ✔ || ✔ || ✗ || ✔
|-
| Exclude VPN || disable use of VPN connections for audio and appsharing || ✔ || ✔ || ✔ || ✔ || ✗ || ✗
|-
| Screen lock || myApps screen lock against unauthorised use || ✗ || ✗ || ✗ || ✗ || ✗ || ✔
|}

<references/>

=Requirements=
* innovaphone PBX 16r1 and up

== Hardware ==
Recommended hardware requirements
* Processor: Dual-core 2Ghz or higher
* RAM: 4 Gb

== myApps for Windows ==
* Windows 11 and up
* Windows Server 2016 and later versions

=== 32 & 64 bit Windows ===
* 32 bit Windows: install the myAppsSetup32.msi from the App Store
* 64 bit Windows: install the myAppsSetup.msi from the App Store
** the 64 bit variant still installs into Program Files (x86), as the main myApps.exe is still a 32bit application
** the 64 bit variant just contains an additional 64 bit binary for the outlook search

=== Windows N editions ===

Windows N editions are missing the ''Media Feature Pack'' which is pre installed on other Windows versions.

Please install the pack from [https://www.microsoft.com/en-us/software-download/mediafeaturepack Microsoft (Windows 10 pack)] before you install myApps. The installer will check if the file <code>C:\Windows\SysWOW64\mfplat.dll</code> exist on your system.

Make sure to install the correct pack depending on your Windows version! There are different packs for Windows 10 1703, 1803, 1809 and 32bit or 64bit etc.

NB: Sometimes the myApps installation will not work even though the media pack is already installed. This is because the installer has no read access to check if the package is already installed. If the above-mentioned file exists and the installer asks to install the Windows Media Feature Pack nevertheless, you have to start the myApps install with administrative rights.

=== Terminal Server environments ===

Audio driver was removed if myApps discovers that it is running in a terminal server environment like Citrix.

The audio driver is needed for the Softphone App but the Softphone App should not use an audio driver at the server side because the audio devices are plugged locally and there would be a delay sending and receiving audio data with the server.

If a customer wants to use the Softphone App at the server side he needs to make use of the myApps Plugin for virtual desktops solution:

[[{{NAMESPACE}}:MyApps_Plugin_for_Virtual_Desktops|Reference15r1:MyApps_Plugin_for_Virtual_Desktops]]

== myApps for macOS ==
* macOS 13 or higher

== myApps for iOS ==
* iOS 16 or higher

== myApps for Android ==
* Android 13 or higher.

== myApps for IP270 ==
Exclusively used in IP270.

= Licenses =
* No license needed for myApps platform services

= Overview =
myApps platform services is a native executable that is installed using the standard mechanisms on the respective operating system. It provides various advanced services which can be used by the myApps web client code as well as the Apps running in the myApps context.

Also, on Windows, the platform services come with their own, dedicated browser to run myApps in. This browser is based on [https://en.wikipedia.org/wiki/Chromium_(web_browser) Chromium]. On iOS, macOS and Android, it is based upon native embedded web view facilities (such as WKWebView) instead.
== Components ==

=== RTP service for audio and appsharing ===
The RTP service provides audio and appsharing as a video stream. VoIP RTP endpoints (e.g. for softphones). It supports STUN, TURN, ICE, SRTP, DTLS. Note however that unlike WebRTC, these endpoints do not ''require'' ICE and DTLS. In other words, they can communicate also with non-compliant (i.e. older) VoIP devices.

Note that the available capabilities when not running the myApps platform services depend on the used browser's WebRTC implementation. See your browser documentation for details.

Apps can request RTP channels using the [https://sdk.innovaphone.com/doc/launcher/Media.htm Media Protocol]'s ''AllocChannel'' message.

==== RTP ports ====
{|
| audio || 50000 -> 50099
|-
| video (app sharing) || 50100 -> 50199
|}

The RTP service will enumerate all local interfaces and create local HOST candidates for ICE. There is an option however to disregard VPN interfaces (more precisely such interfaces with type of ''IF_TYPE_PPP'' or ''IF_TYPE_TUNNEL''). This can eliminate quality issues when RTP data is transmitted through TCP based VPN tunnels.

SRFLX and RELAY candidates are obtained using the STUN and TURN server configuration passed by the App (e.g the ''softphone'' App) as part of the ''AllocChannel'' request.
<code>{"mt":"AllocChannel","channel":"81429cba-396d-43de-8a76-ec020ba8796e","iceServers":[{"urls":"turn:myturn.domaincom:4077?transport=udp","username":"turnuser","credential":"pwd","credentialType":"password"},{"urls":"stun:mystun.domain.com:4077"}],"dn":"Foo Bar","type":"RemoteRtp","kind":"video"}</code>

==== Codecs ====
The installed myApps launchers provide codecs that can be used by softphone apps for media streams. When running in a web browser the codecs depend on the browser version and operating system. See the documentation of your browser for details.

The following codecs are supported:
{|
!style="text-align:left;width:100px;"|Codec
!style="width:100px"|Windows-Launcher
!style="width:100px"|Android
!style="width:100px"|iOS
!style="width:100px"|macOS
!style="width:100px"|Firefox (Browser)
!style="width:100px"|Chrome (Browser)
!style="width:100px"|Edge (Browser)
!style="width:100px"|Safari (Browser)
!style="width:100px"|Opera (Browser)
!style="width:100px"|IP270
|-
|style="text-align:left; background-color:lightgray" colspan="11"|Audio
|
|-
|G711A
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G711u
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G722
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|[https://caniuse.com/#search=Opus OPUS-NB]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|[https://caniuse.com/#search=Opus OPUS-WB]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
| colspan="11" style="text-align:left; background-color:lightgray" |Video
|
|-
|[https://caniuse.com/#search=VP8 VP8]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|-
|[https://caniuse.com/#search=VP9 VP9]
|style="color:green;text-align:center"|✔**
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|-
|[https://caniuse.com/#search=H264 H264]
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|style="text-align:left; background-color:lightgray" colspan="11"|Application Sharing
|
|-
|Share
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|Watch
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔*
|style="color:green;text-align:center"|✔*
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔*
|}

''* small presentation only'' 
''** only for 1:1 calls, not for conferences

==== Video capture ====
The default resolution for video capture is 1920x1080 if available. Otherwise, 1280x720, 640x480, 352x288 or 320x240 will be used. The frame rate is 30 fps if available, otherwise 15 fps. The resulting average bandwidth could reach 1 Mbps.

==== Application sharing ====
Screen content will be transmitted as video stream by the presenter

==== Device handling ====
The RTP service enumerates microphones, loudspeaker, cameras and ringing devices and notifies apps when devices come and go. It is up to the apps using the devices to store preferences.

The RTP service also enables some extended features (such as hook switch or volume control) for supported USB headsets or Bluetooth headsets connected to myApps.
The supported headset-SDKs determine which headset vendors are recommended to be used with the myApps softphone app. 

For this to work, the following vendor specific development kits are integrated in our myApps client. Be aware that the SDK are updated within our Service release :

{| class="wikitable"
|-
! SDK Vendor !! Supported OS !! SDK Version !! innovaphone Service Release
|-
| Jabra|| MacOS || 1.16.4.0 || 14r2sr11
|-
||| Windows || 1.16.4.0 || 15r1sr3
|-
| Epos ''(formerly Sennheiser)'' || MacOS || 12.4.0.5478 || 14r1sr3
|-
||| Windows || n.a. - [[Support:13r3 sr10 MyApps Windows Client - Epos/Sennheiser-Headsets require installed Epos-Connect Software|to be installed separately]]|| 13r3sr10
|-
| Poly ''(formerly Plantronics)'' || MacOS || 3.25.53799.37131 || 13r3sr9
|-
||| Windows || 3.25.53800.37131 || 13r3sr10
|-
| Yealink || MacOS || 3.1.1.23 || 14r2sr1
|-
||| Windows || 3.1.1.23 || 14r2sr2
|}

Notes:
* It is possible to inhibit the start of the Sennheiser SDK (SenncomSDK.exe) using the <code>DISABLEHEADSETS</code> directive of the installer (see [[#MSI Parameters and install options| MSI parameters]] below).

* Starting with V13r3sr10, the Epos-SDK needs to be installed separately using the Epos Connect software to ensure full compatibility between current Epos headset models and native myApps-Windows client. For details [[Support:13r3 sr10 MyApps Windows Client - Epos/Sennheiser-Headsets require installed Epos-Connect Software|refer to this article]].


myApps-IP270 supports use of [[Reference9:Concept USB Headset|USB devices known for innovpahone desk phones]].

==== Ring tones ====
Ring tones can be played. Apps can choose the tone from a pre-defined list of ring tones.

On Windows, custom ring tones can be uploaded as .mp3 files to the <code>ringtones</code> sub-directory of myApps' roaming directory (which usually is in <code>%appdata%\innovaphone\myApps\ringtones</code>).

On Android, custom ring tones can be added to the system via Android settings.

On iOS, custom ring tones can be uploaded as .mp3 files to the <code>Ringtones</code> subdirectory of the myApps file share that is available in iTunes if the iPhone has been connected via USB.

On macOS, custom ring tones can be uploaded as .mp3 files to <code>~/Library/Containers/com.innovaphone.client-macos/Data/Documents/Ringtones</code>.

==== Debugging ====
For extended debugging, turn on the ''Audio'', ''Media'' and ''AppSharing'' traces in myApps.
=== Hot keys ===
On Windows and macOS systems, myApps platform services can listen for hot keys and invoke certain functions. Invocation is done by sending API messages to myApps which passes it to an appropriate API provider (in the cases described here, this will be a ''phone'' or ''softphone'' or ''rcc'' App typically. See [[{{NAMESPACE}}:Concept_myApps#Client_APIs_and_default_apps | Client APIs and default apps]] for more details about this mechanism.

The hot keys can be specified using the ''advanced settings'' user interface (see [[#UI elements| UI elements]] below. Any of the function keys F1 to F11 (optionally combined with up to two modifier keys ''alt'', ''ctrl'', ''shift'' or ''win'') can be chosen for each function. If you do not want to start the call with "Hotkey+Enter" because you would have to wait for the focus, the hotkey can also be pressed twice and the number is dialled directly.

; dial selected number : Initiates a call using the currently selected text as target.

: A ''PrepareCall'' message with the ''text'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":"mt":"PrepareCall","text":"13","adjust":true}}</code>

; accept call : Accepts a currently alerting call.

: A ''ConnectCall'' message will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"ConnectCall"}}</code>

; reject/disconnect call : Rejects a currently alerting call or disconnects an active call.

: A ''DisconnectCall'' message will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"DisconnectCall"}}</code>

=== URL Handler ===

On Windows systems, two URI-handler are installed with the myApps platform services. Windows will call up this URI handler when a user clicks on an appropriate link, for example in a web site.

The handler will the send an API message to myApps which passes it to an appropriate API provider (in the cases described here, this will be a ''phone'' or ''softphone'' or ''rcc'' App typically. See [[{{NAMESPACE}}:Concept_myApps#Client_APIs_and_default_apps | Client APIs and default apps]] for more details about this mechanism.

; tel URI : call a number, e.g. <code>tel:4711</code>

: A ''PrepareCall'' message with the ''num'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartCall","num":"4711","adjust":true}}</code>
; sip URI : call a SIP name, e.g. <code>sip:zkl@innovaphone.com</code>

: A ''PrepareCall'' message with the ''sip'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartCall","sip":"zkl@innovaphone.com","adjust":true}}</code>
; im URI : start chat with SIP name, e.g. <code>im:zkl@innovaphone.com</code>

: A ''StartChat'' message with the ''sip'' argument set to the selected text will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.chat/com.innovaphone.chat.htm ''com.innovaphone.chat'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.chat","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartChat","sip":"zkl@innovaphone.com"}}</code>

On macOS systems myApps might be made the default application to handle tel URI e.g. <code>tel:4711</code> via Apple FaceTime. Open the "FaceTime" menu "Settings..." and select myApps as "Default for phone calls".

On iOS ''tel'' URIs are always dialed via GSM. Therefore myApps iOS also reacts to URI schemes ''com.innovaphone.tel'', ''com.innovaphone.sip'' and ''com.innovaphone.im'', e.g. <code><nowiki>com.innovaphone.tel:4711</nowiki></code>, <code><nowiki>com.innovaphone.sip:zkl@innovaphone.com</nowiki></code>, <code><nowiki>com.innovaphone.im:zkl@innovaphone.com</nowiki></code>.

=== User activity ===
On Windows and macOS systems, the myApps platform services can monitor user keyboard/mouse activity and change the user's presence state after a certain amount of inactivity. The timeout can be specified using the ''advanced settings'' user interface (see [[#UI elements| UI elements]] below.

myApps will then send a [https://sdk.innovaphone.com/doc/appwebsocket/myApps.htm#SetUserActivity''SetUserActivity''] message to the PBX using the ''myApps'' protocol.

: <code>{"mt":"SetUserActivity","inactive":true}</code>

This will change the ''status'' property of the ''im:'' contact for the user's own presence and hence result in a presence update from the PBX to myApps

: <code>{"mt":"UpdateOwnPresence","presence":[{...},{"contact":"im:","activity":"","status":"closed"}]}</code>
The ''closed'' status is reflected in the grey status color when displaying a contact [[Image:myapps-inactive.png|myapps-inactive.png/|myapps-inactive.png/]].

On iOS and Android, the state is set to ''inactive'' as soon as the App is brought to background.
When myApps platform services are not available (i.e. when running the web application in a browser solely) a limited user activity monitoring is available: the state is set to active when the web page is not used for more than 5 minutes.

=== Recording ===

The new launcher offers the possibility to record the audio of incoming and outgoing calls. In order to activate that functionality the URL of the recording instance must be configured in either the PBX (PBX->myApps->Config: Recording URL) or the softphone App (Settings->Audio Recording (URL))

[[Image:PBX-Recording-Settings.png|pbx-recording-settings.png/|pbx-recording-settings.png/]] [[Image:Recording-Softphone-Settings.png|recording-softphone-settings.png/|recording-softphone-settings.png/]].

As long as that URL is configured the audio data of all calls are stored as pcap-files under that URL.
If the URL points to a CF device in the PBX, write access must be granted for that URL (PBX->Services->HTTP->Server:Public compact flash access) and if the URL points to the recording app, the files can be accessed via the recording app [[{{NAMESPACE}}:Concept_App_Service_Recordings|recording]].

Under PBX->myApps the administrator can set a certain default behaviour of the audio recording like whether or not the recording should start automatically at the beginning of the call (Recording by Default ON/OFF), only calls with external numbers should be recorded (Record external calls only) or whether or not the user should be able to start/stop the recording himself (Allow user incall recording control). Except for the last parameter these parameters can also be modified by the user in its softphone settings if the administrator doesn't set the FORCE flag.

If the user was allowed by the admin to control the recording a recording switch is active during the call when the "Media" Panel is opened. There the audio recording may be stopped and continued at will. A red recording notice is shown in the top right corner when the recording actually takes place.

[[Image:Recording-incall-switch.png|recording-incall-switch.png/|recording-incall-switch.png/]]

=== Notifications ===

The myApps platform services can use the OS specific notification mechanism (e.g. ''desktop notifications'' on Windows) to display messages (e.g. ''incoming new chat message'') to the user.

Note that the actual rendering of the notification is under control of the OS. Therefore, myApps must be allowed to show notifications and its appearance can be restricted by OS native settings.

==== Microsoft Windows Notifications ====

Microsoft Windows Server editions (2016, 2019, 2022) are just capable of showing a single ''IncomingCall'' notification at the same time (we couldn't find a workaround for this limitation). 
An ''IncomingCall'' notification is visible the whole time instead of being moved to the action center after a certain time. 
 
A notification about a missed call uses the ''IncomingCall'' type so that this notification is visible until the user returns. 
Due to the above limitation, on a new arriving call such a missed call notification is transformed to a default notification which will be moved to the action center automatically. 
 
On non server editions, you can have multiple IncomingCall notifications at the same time (so two parallel incoming calls will be indeed notified at the same time), but the missed call notification handling is the same on both platforms!

Thus there will be always just '''one''' missed call notification visible and previous missed calls can be found inside your action center!

To see myApps notifications, ensure:
* System -> Notifications
** enable notifications
** disable "Do not disturb" or allow myApps as priority application while "Do not disturb" is active
** enable notifications for myApps in the list of applications
* System -> Focus
** if a focus session is active and the "Do not disturb" is activated during a focus session, make sure that myApps is a priority application (see above)

==== macOS Notifications ====
Notifications are the same as on Windows.
The difference is, that for macOS, notifications need to be allowed in the system settings.
Go to Notifications - myApps, select Banner and enable all check marks.

=== Local phonebook access ===
'''Contact Search:''' The myApps platform services implement an ''API provider'' for the [http://sdk.innovaphone.com/web1/com.innovaphone.search/lib1_api_search.htm ''com.innovaphone.search'' API]]. They perform search capabilities on the OS' local phone books which can be used by Apps like the ''phoneapp''.

Apps would send a ''Search'' request to the API:

: <code>{"mt":"ApiRequest","consumer":"dev:SwPh_zkl_5e42e884","provider":"*","src":"4","msg":{"mt":"Search","type":"contact","search":"john doe"},"apiId":"com.innovaphone.search"}</code>
Search results are delivered as ''SearchInfo'' messages:

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{"mt":"SearchInfo","relevance":2000,"adjust":true,"type":"contact","contact":{"givenname":"John","sn":"Doe","company":"ACME","position":"Head of everything","telephonenumber":["11111","22222"],"homephone":["+4944444","33333"],"mobile":["+49 (123) 55555"]}},"api":"com.innovaphone.search"}</code>

'''Reverse Lookup:''' The myApps platform services implement an ''API provider'' for the [http://sdk.innovaphone.com/web1/com.innovaphone.phonelookup/lib1_api_phonelookup.htm ''com.innovaphone.phonelookup'' API]. They perform search capabilities on the OS' local phone books which can be used by Apps like the ''phoneapp''.

Apps would send a ''Lookup'' request to the API:

: <code>{"mt":"ApiRequest","consumer":"dev:SwPh_zkl_5e42e884","provider":"*","src":"4","msg":{ mt: "Lookup", prefixIntl: "000", prefixNtl: "00", prefixExt:"0", area: "7031", country: "49", lookup: "0004970311234567" },"apiId":"com.innovaphone.lookup"}</code>

Search results are delivered as ''LookupInfo'' messages:

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{mt: "LookupInfo", dn: "Jake Blues", contact: { telephonenumber: ["0004970311234567"], givenname: "Jake", sn: "Blues", company: "Blues Brothers" </code>

==== Windows ====
On Windows, the search and lookup are performed in all of the user's Outlook contact folders. As opposed to the search implemented in the ''Contacts'' and ''Users'' App, all items are returned which match any of the search words (i.e. searching for ''a b'' will return items matching either ''a'' or ''b'').

; searched properties : firstname, lastname
; returned properties : Following Outlook contact phone number properties are returned (if available):

:* OFFICE_TELEPHONE_NUMBER as ''telephonenumber''
:* OFFICE2_TELEPHONE_NUMBER as ''telephonenumber''
:* HOME_TELEPHONE_NUMBER as ''homephone''
:* HOME2_TELEPHONE_NUMBER as ''homephone''
:* MOBILE_TELEPHONE_NUMBER as ''mobile''
:* BUSINESS_FAX_NUMBER as ''facsimiletelephonenumber''
Note that contact information is cached in the search provider. Updated contacts may therefore become effective after a while only.
Outlook search will create its own trace file <code>myAppsOutlookSearch-</code>''date-time''<code>.txt</code> in the standard trace directory.

This search provider is always installed and can be disabled. There is no need (nor possibility) to enable it in the ''Apps'' tab of the PBX's user object. Also, no ''App'' object needs to be created for it.

==== Android/iOS ====
The search and lookup are performed in the contacts.

==== macOS ====
The search and lookup are performed in the contacts. If you wish to disable local contact lookup, go to system settings - Security & Privacy and disable the access to contacts for myapps.
=== Microsoft Office integration ===

The myApps platform services has a ''office presence provider'' that can provide the user's presence state to Office applications. See [[{{NAMESPACE}}:Concept_myApps_Office_Integration|myApps Office Integration]] for details.

This feature is installed by default. However, it can be disabled using the ''OFFICEPRESENCE'' MSI Parameter. Also, a check-mark is available in the setup dialog.

=== Call an external application for calls ===

Phone Apps (such as the phoneapp or softphone) can initiate the start of an external application when a new call appears (either incoming or outgoing). The actual spawning of the application is done by the myApps platform service. Also, the application properties (such as e.g. the executable's path) is configured in the myApps platform services (see [[#UI elements|Advanced settings]] in the ''UI elements'' section below).

A number of arguments can be passed to the application by substituting $-variables in the ''Parameter'' field:

; $n : phone number as dialed (called party number for outgoing calls) or received (calling party number for incoming calls)

; $N : called or calling party number in ''national'' format (e.g. 07031730090)

; $I : called or calling party number in ''international'' format (e.g. +497031730090)

: note that both $N and $I only work if $n includes both subscriber number and area code (e.g. 07031730090). Otherwise they are equal to $n

; $d : display name of peer (if known)

; $u : URI name of the peer (if available eg with a federation call)

; $c : conference id

: this is a globally unique ID for this call and may be used to relate the call to the ''guid'' found in the CallInfo structure in the [http://wiki.innovaphone.com/index.php?title=Reference10:SOAP_API#CallInfo SOAP-API] and [http://sdk.innovaphone.com/doc/appwebsocket/RCC.htm RCC-API ]. Also, corresponding [[Reference10:Call Detail Record CDR PBX|CDRs]] can be related using the ''event'' tag's ''conf'' attribute.
The start of an external application can be requested using the ''com.innovaphone.externalapps'' API.

Some setup examples are [[Howto:Integrate External Apps in innovaphone UC clients|shown here]].

=== Push ===

Mobile operating systems usually inhibit network operation of apps which run in the background or are closed by the user. This is done in order to reduce battery consumption. Unfortunately, this also stops such apps to maintain a registration by regularly sending ''keep alive'' messages to a server (in our case to the PBX). As a result, myApps will be disconnected from the PBX. When the PBX determines that there is an event for the application which needs a response, it needs to wake up the app using a dedicated channel provided by the operating system. This mechanism is know as ''push''. When running on iOS or Android, myApps supports ''push''.

For ''push'' to work, a [[{{NAMESPACE}}:PBX/Objects/Push|''push object'']] needs to be configured in the PBX . Also, it needs to be enabled on the mobile phone for the myApps app.
This mechanism is quite similar in v12 and v13, so you can refer to [[{{NAMESPACE}}:Concept_Push_Notifications_for_iOS_and_Android|the concept for push notifications for iOS and Android]] for more details.

Also, helpful hints can be found in [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]].

=== App Proxy ===

myApps runs further ''Apps'' (such as e.g. the ''phoneapp'') as a web page in an IFRAME of the browser myApps is running in. The App's page code is loaded either from the PBX or from an ''application platform'' (AP). This however would mean that the App's IFRAME would remain empty (a dead white screen) when the PBX or AP is not available. To make sure the App can start-up anyway, the myApps platform services feature the so-called ''App Proxy''. This is a caching proxy that caches all the App code so it is available even in case of network failure. When myApps runs in the context of the platform services, Apps are therefore not loaded from the App source directly, but from the local App proxy.

The cached files are stored in the PCs local file system in the <code>%LOCALAPPDATA%\innovaphone\myApps\appproxy</path></code>. There is no configuration required. However, if myApps seems to run with outdated or corrupt cached copies of the App, you can safely delete the entire directory.

=== Auto update ===

On Windows and on macOS, the myApps platform services can auto-update themselves to a common version. This is controlled by the [[{{NAMESPACE}}:PBX/Config/myApps#Launcher_Software_Update | ''Launcher Software Update'']] settings under ''PBX/Config/myApps'' in the PBX.

When myApps is started or the user logs in or myApps needs to re-connect to the PBX, the platform services will use the [http://sdk.innovaphone.com/web1/com.innovaphone.client/lib1_api_client.htm com.innovaphone.client API] to learn the desired version (''launcherUpdateBuild'', which is part of the API's ''model''). If this differs from the current version, the platform services will try to download the respective new version.

{
"mt": "ApiUpdate",
"apis": {
"com.innovaphone.client": {
"@client": {
"title": "innovaphone myApps",
"model": {
"launcher": true,
"launcherUpdateBuild": "134906",
"appStoreUrl": "http://store.innovaphone.com/release/download/"
}
}
}
}
}

The installation of the downloaded version is done by the ''innovaphonemyAppsUpdateService''. This service is installed and enabled during the initial installation of the myApps platform services. To disable auto-update, either leave the ''Launcher Software Update'' settings empty or set the service's start mode to ''disabled'' in the Windows ''services control panel''.

Note that on Windows the update service does not work on terminal servers. Administrators must do myApps base services updates using standard windows mechanisms.

Note that on macOS if myApps has been installed from the Apple Store it is assumed that auto update from the PBX is not desired and disabled therefore.

On Android/iOS/macOS updates can be downloaded from the respective app store.

The ''Devices'' app can not update software installed on Windows PCs directly. However, when the PBX is updated using an ''update job'' in the ''Devices'' App, the ''Launcher Software Update'' settings will be updated accordingly and hence the myApps base services will ultimately also be updated to the same version.

==== Auto update flow on Windows ====

* On start of myApps, myApps checks if an update is available and ready for installation
** if yes, the update is installed directly, without user interaction (a popup is shown during the installation)
** if not, myApps starts
* if an update is available while myApps is already running, an update notification will be shown which let's the user choose to install the update now or later (the notification will then popup again after one hour)

==UI elements ==
There are a few user interfaces provided by the platform services:
===tray-icon (Windows only) ===
::[[Image:myapps-tray.png|myapps-tray.png/|myapps-tray.png/]]
:Allows to
:* terminate myApps
:* toggle the ''autostart'' state
:* toggle the ''show in task bar'' state
:* open the trace folder
:
=== PBX connect form===
:: [[Image:myapps-connect.png|myapps-connect.png/|myapps-connect.png/]]
: Allows the user to specify the connect data for the PBX (i.e. IP address or DNS name)
:
=== Advanced settings===
::[[Image:myapps-settings0.png|myapps-settings0.png/|myapps-settings0.png/]]
::[[Image:myapps-settings.png|myapps-settings.png/|myapps-settings.png/]] [[Image:myapps-settings2.png|myapps-settings2.png/|myapps-settings2.png/]] [[Image:myapps-settings3.png|myapps-settings3.png/|myapps-settings3.png/]]

: Allows to modify various platform dependant settings (such as e.g. the hotkey selection on Windows)

== Interfaces ==
=== Provided APIs ===

; [http://sdk.innovaphone.com/web1/com.innovaphone.search/lib1_api_search.htm com.innovaphone.search] : access to local phone book entries by the [[#Local phonebook access|Local phonebook access]] component.
; [http://sdk.innovaphone.com/web1/com.innovaphone.launcher/com.innovaphone.launcher.htm com.innovaphone.launcher] : display of OS specific user notifications and receipt of related user actions
; com.innovaphone.notificationhandler : reports back click on a notification.
; com.innovaphone.externalapps : to start external applications, see [[#Call an external application for calls|Call an external application for calls]] above

=== Used APIs ===

; [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm com.innovaphone.phone] : used to initiate new or manipulate existing calls by the [[#Hot keys|Hot keys]] and [[#URL handler|URL handler]] components.

; [http://sdk.innovaphone.com/web1/com.innovaphone.chat/com.innovaphone.chat.htm com.innovaphone.chat] : used to start a new chat by the [[#URL handler|URL handler]] component.

; [http://sdk.innovaphone.com/web1/com.innovaphone.client/lib1_api_client.htm com.innovaphone.client] : the model is used to learn the update settings, see [[#Auto update|Auto update]] above

=== Protocols ===

; [https://sdk.innovaphone.com/doc/launcher/Media.htm Media Protocol] : used by apps to allocate RTP channels, see [[#RTP service for audio.2C video and data|RTP service for audio, video and data]] above

== Related App Services ==

none

== Known limitations ==
; Incoming call as banner on myApps for iOS : Since iOS 14 the iOS CallKit presents incoming calls as a banner leaving the original green answer button of myApps visible. Use only the blue button of the banner to accept the call or change iPhone Settings, App "Phone", "Incoming Calls" to "Full Screen" to hide the myApps user interface again during call answering.

; Call answer in speakerphone mode even with active Bluetooth headset on myApps for iOS : This causes unwanted speakerphone operation if the smartphone is used with a Bluetooth car audio system. The behaviour can be changed by selecting ''Bluetooth Headset'' in this setting:
:''iOS Settings->Accessibility->Touch->Call Audio Routing: Automatic / Bluetooth Headset / Speaker''
:''iOS Einstellungen->Bedienungshilfen->Tippen->Anrufaudioausgabe: Automatisch / Bluetooth-Headset / Lautsprecher''

; Windows Server 2016 (Windows 10 Build 1607) : windows just shows the first notification. Further notifications aren't displayed until the previous ones are removed from the notification center. Current windows builds do not show this behaviour anymore.

; Problems on Mac computers with Yealink USB headsets
: we have received reports that myApps quits unexpectedly on some Mac computers when a Yealink headset is plugged in. Unfortunately, we could not find out the cause yet. If you use Yealink USB headsets and have a similar issue, please open a support ticket and send myApps traces.

; Poly / Plantronics headset buttons only functional if myApps is started with Rosetta
: myApps macOS supports Apple M1/M2 hardware natively. However, the Poly / Plantronics headset SDK is only available for Intel platform and thus myApps needs to be started via Apple's Intel emulator Rosetta if a Poly / Plantronics headset is used. This is done with right-click on the myApps executable, ''Information'', ''Open with Rosetta''.

; Windows surface devices may not work correctly
: Chromium does not get touch keyboard events. USB Keyboards may not be recognized either.

= Installation =

== Windows ==

myApps platform services are installed on Windows using the .msi file found in the ''myApps Windows'' package from [https://store.innovaphone.com/release/download.htm store.innovaphone.com].

myApps can update itself automatically, see [[#Auto update|Auto update]] above.

=== MSI Parameters and install options ===

The MSI installer of myApps for Windows supports the following parameters and can be edited with [https://docs.microsoft.com/en-us/windows/win32/msi/orca-exe Microsoft Orca]. You can add your parameters in the table ''property''.

; SERVER (REG_SZ): the PBX's server address (without protocol like https://)
; OFFICEPRESENCE (REG_DWORD): '''false''' to disable presence integration in Microsoft Office
: this is also available as a check-mark when running the install manually

; DISABLEHEADSETS (REG_DWORD): '''true''' to disable headsets support, see [[#Device handling|Device handling]] above

; EXTERNALAPPS (REG_SZ): pre-define external applications, see [[#Call an external application for calls|Call an external application for calls]] above
: e.g. <code>"{""externalApps"":[{""id"":0,""name"":""Wireshark"",""path"":""C:\\Program Files\\Wireshark\\Wireshark.exe"",""param"":""test $I""}]}"</code>

; FORCERESTART (REG_DWORD): '''true''' (or any string ...) kills myApps during the installation and restarts it for the currently logged in user, if it was running

; DISABLELOCALHOST (REG_DWORD): '''true''' to disable use of '''localhost''' string to access the local webserver. Use '''127.0.0.1''' instead

; EXCLUDEINTERFACES (REG_SZ): some VPN interfaces are not detected by Windows as IF_TYPE_PPP or IF_TYPE_TUNNEL and therefore the '''media outside VPN''' setting is not taking effect. With this option interfaces can be pre-defined that will not be used for media. Interfaces must be comma separated
: e.g. <code>EXCLUDEINTERFACES="172,192.168,10.10"</code>

; FASTERDOWNLOADS (REG_DWORD): '''true''' to have faster downloads without artificially slowing down the download of an update (which is done to avoid audio lags if clients have slow networks).

Current settings are stored in the registry at <code>Computer\HKEY_CURRENT_USER\Software\innovaphone\myApps</code> or at <code>Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\innovaphone\myApps</code>

Boolean values like OfficePresence are stored in registry entries with type REG_DWORD and values 1 or 0. 0 disables the setting and 1 enables it.

== iOS ==

myApps platform services are installed on iOS by loading ''innovaphone myApps'' from the ''App Store''.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying this dictionary in the MDM
<plist>
<dict>
<key>server</key>
<string>pbx.example.com</string>
</dict>
</plist>

== macOS ==

myApps platform services might be installed directly from the Apple store. An installer package <code>myapps.pkg</code> and a disk image <code>myapps.dmg</code> is also available from the innovaphone app store. Install <code>myapps.pkg</code> by double-click on the file and follow the instructions of the installer. myApps becomes available in the Applications folder and can be opened by double-click. Or download and open <code>myapps.dmg</code> and double klick myApps. If desired integrate it into the app dock by right click, ''Options, Keep in the dock''.

If installed from the innovaphone app store, myApps can update itself automatically, see [[#Auto update|Auto update]] above.

If installed from the Apple store, macOS notifies about updates on the Apple store. myApps [[#Auto update|Auto update]] is disabled then.

If a clean-install of the client is necessary, the folder "/Users/username/Library/Containers/myapps" needs to be deleted. To be on the safe side also delete it from the trash bin.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying this dictionary in the MDM
<plist>
<dict>
<key>server</key>
<string>pbx.example.com</string>
</dict>
</plist>

=== Preferences ===

macOS supports preference settings that can be set via a shell command or via Mac remote management

defaults write com.innovaphone.client-ios-14r1 server "PBX-server-URL"

The following parameters and can be set through this method:

; server: the PBX's server URL

=== Setting myApps as Default App for SIP-URLs ===

{| class="wikitable"
|defaults write com.apple.LaunchServices/com.apple.launchservices.secure LSHandlers -array-add '{
LSHandlerURLScheme = sip;
LSHandlerRoleAll = "<CFBundleIdentifier>";
}'
|}

To find the “CFBundleIdentifier”, proceed as follows:
* In the Finder under “Applications”, search for the desired myApps client that you want to set as the default app.
* Right-click on “Show package contents” -> you will find the “CFBundleIdentifier” in the Info.plist file.

A restart of the MAC is required.

=== Using Sennheiser headsets ===
If you use Sennheiser headsets, you should also install the then-current <code>DSEA_SDK_v</code>''version''<code>.pkg</code> package, after you installed the myApps client. Without that, audio will still work, but not the controls on the headset. You will need to keep that up-to-date yourself, as it is not updated by myApps's auto-update function.

== Android ==

myApps platform services are installed on Android by loading ''innovaphone myApps'' from the ''Play Store''.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying a property "server" with string value "pbx.example.com" in the MDM.

== IP270 ==
For configuration instructions, refer to the [[Reference16r1:Concept IP270|IP270 concept article]].

= Configuration =

== Server configuration ==
When opening myApps for the first time, the user is prompted for the Server. Usually only the hostname (DNS host name or IP address) needs to be configured.

But there are more options for special PBX configurations.

; Non-standard HTTPS port
: If the PBX uses a non-standard HTTPS port, it must be appended to the host name separated by a colon (<code>:</code>).
: Example: <code>pbx.example.com:4444</code> (expands to <code>https://pbx.example.com:4444/PBX0/APPCLIENT/appclient.htm</code>)
; DynPBX module name
: If the PBX is a DynPBX, the module id must be appended to PBX0 separated - (<code>/</code>).
: Example: <code>pbx.example.com/PBX0-1</code> (expands to <code>https://pbx.example.com/PBX0-1/APPCLIENT/appclient.htm</code>)
; Softphone physical location
: If user defined physical location shall be used for softphone, you can append it using a parameter <code>#phys=</code>.
: Example: <code>pbx.example.com#phys=slave</code> (expands to <code>https://pbx.example.com/PBX0/APPCLIENT/appclient.htm#phys=slave</code>)

Example 1: PBX pbx.example.com with standard configuration
pbx.example.com

Example 2: PBX slave.example with DynPBX module ID 1, HTTPS port 4444 and physical location master
slave.example.com:4444/PBX0-1#phys=master

=== HTTP proxy support ===

myApps platform services do support operation via HTTP proxy now. If one or more proxies have been configured in the network settings of the operating system for the active network connection, HTTP CONNECT tunnels are established.

On Windows user name and password can be specified for the tunnel servers as generic credentials in the credentials manager (Anmeldeinformationsverwaltung). The name of the credentials must be the tunnel server hostname.

On Android user name and password can be specified through Android ''Settings, Accounts'' by adding a myApps ''HTTP Proxy Credentials'' account. The name of the account must be the tunnel server hostname.

== Platform specific settings ==
When myApps runs under the myApps platform services, it will show various platform specific settings as part of its ''burger menu'', so the user can set them. See ''Advanced settings'' in [[#UI elements|UI elements]] above.

Some options can also be set globally for all myApps clients in the PBX's [[{{NAMESPACE}}:PBX/Config/myApps#Client_Settings|PBX/Config/myApps ''Client Settings'']]
{|
! style="text-align: left; font-weight: bold" | Option

! style="text-align: left; font-weight: bold" | Description

! style="text-align: left; font-weight: bold" | Where to set

!
! style="text-align: left; font-weight: bold"| Availability
|-

| || || User menu || PBX ''Client Settings'' || Windows || iOS || Android || macOS
|IP270<ref>myApps-IP270 offers device specific settings explained in [[Reference16r1:Concept IP270|IP270 concept article]]</ref>
|-
| Autostart || Launch myApps on login || ✔ ||✔ ||✔ || ✗ || ✗ || ✔
|✗
|-

| Appear offline after || controls after which idle time a user is considered ''inactive''. See [[#User activity|User activity]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔
|✗
|-

| Hotkeys || Hotkeys for call dial, accept, reject. See [[#Hot keys|Hot keys]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔
|✗
|-

| Docking || Docking mode (left, right, none). See [[#???|??]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✗
|✗
|-

| Desktop notifications|| Turn on/off platform notifications. See [[#Notifications| Notifications]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔
|✗
|-

| VPN || Disable VPN address for ICE candidate selection. See [[#RTP ports| RTP ports]] above || ✔ ||✔ ||✔ || ✗ || ✔ || ✔
|✗
|-

| Show in taskbar|| Show myApps in the taskbar in addition to it's tray icon. || ✔ ||✗ ||✔ || ✗ || ✗ || ✗
|✗
|-

| Log flags || turn on/off certain trace levels. See [[#Troubleshooting|Troubleshooting]] below. || ✔ ||✔ ||✔ || ✔ || ✔ || ✔
|✔

|-

| External applications || define the applications available for Apps to be started. See [[#Call an external application for calls|Call an external application for calls]] above. || ✔ ||✗ ||✔ || ✗ || ✗ || ✔
|✗
|-

| Ring in headset || send ring tone for incoming to headset instead of loudspeaker. || ✔ ||✗ ||✔ || ✗ || ✗ || ✗
|✗
|}
<references/>

== Start parameters for Windows ==

On Windows, it is not possible to pass start parameters from the [https://www.chromium.org/developers Chromium documentation] to the myApps process.

== OS Settings for Windows ==
Windows settings can influence the display of ''Desktop notifications''. See [https://support.microsoft.com/en-us/help/4028678/windows-10-change-notification-settings Change notification settings in Windows 10/11] for details.

=== Windows 11 ===

* Windows 11 has a feature "do not disturb". This hides notifications if enabled.
* Windows 11 has a feature "focus". This enables "do not disturb" and thus hides notifications too.
* Windows 11 has priority settings for notifications. Ensure that VoIP notifications for calls are allowed any maybe also include myApps as an App which is allowed to show notifications.

== OS settings for Android ==
; Events : The appearance of notifications can be controlled here.

; Call accounts : For proper incoming call signaling, the call account ''myApps'' needs to be enabled. Note that on Samsung smartphones the call account switch likely toggles back and a few tries may need to be done until it persists. Please double-check the state.

; Preferred Calling Account : Choose which calling account (myApps/SIM/..) should be used for outgoing calls initiated from within the native phone app / phone book.

; Background data, unlimited data usage : Grant background data use to enable ''myApps'' to connect to the PBX immediately on an incoming call.

; Overlaying : This setting is not needed if call account ''myApps'' has been enabled. Should there be a reason for not enabling call account ''myApps'', the permission for overlaying needs to be granted on Android 10 or higher for proper call signaling.

Note: If no SIM card is installed some Android smartphones exhibit a problem dialing from the smartphone contacts. The contacts app shows a choice ''Select SIM card for this call'' but all possible dialers are greyed out. In this case make myApps the default phone app in Android settings ''Apps, Default apps, Telephony''.

== OS settings for iOS ==
; Notifications : The appearance of notifications can be controlled in iOS ''Settings, myApps''.

== OS settings for macOS ==

; Notifications : The appearance of notifications can be controlled in macOS ''Preferences, Notifications, myApps''.

=Troubleshooting=

myApps platform services can write various traces for debugging. Trace can be turned on and off selectively in the [[#Advanced settings|Advanced settings]].

The following trace flags can be set:

(''Recommended trace options are: '''App, Browser, ICE, TURN, Signaling and Audio'''. Please do not activate other flags unless innovaphone support says otherwise'')

{|
!style="text-align: left; font-weight: bold" | Abbreviation

!style="text-align: left; font-weight: bold" |code

!style="text-align: left; font-weight: bold" | description

|-
| App||0x000000001|| logs from the App Service itself
|-
| DNS||0x000000008|| logs DNS requests and results
|-
| HTTP client||0x000000080|| http client logs
|-
| TLS||0x000000400|| TLS logs
|-
| TCP||0x000000800|| TCP logs
|-
| LDS||0x000001000|| local domain sockets
|-
| WebSocket client||0x000004000|| logs outgoing websocket connections
|-
| App WebSocket||0x000008000|| logs app websocket connections (e.g. from PBX objects to an App Service or from the UI to the App Service)
|-
| UDP||0x000200000|| UDP logs
|-
| DTLS||0x000400000|| logs DTLS handshake and messages
|-
| Media||0x000800000|| logs media events
|-
| Media channel||0x001000000|| logs RTP/SCTP media connections
|-
| ICE||0x002000000|| logs ICE messages between peers
|-
| TURN||0x004000000|| logs TURN messages between peers
|-
| AppSharing||0x008000000|| logs AppSharing connection
|-
| Audio||0x010000000|| logs Audio connection and headset events
|-
| Video||0x020000000|| logs video connection and webcam events
|-
| Browser||0x040000000|| logs Chromium events
|-
| AppProxy||0x080000000|| logs requests which are proxied between the local webserver and the remote server
|-
| Webserver ||0x200000000|| enables webserver specific logs
|-
| Browser Console ||0x400000000|| logs browser console events
|-
| Signaling||0x800000000|| enables logs in the signaling module for debugging calls
|}
''code'' can be or'ed and used as value for the ''Log flags'' field in [[{{NAMESPACE}}:PBX/Config/myApps#Client_Settings|PBX/Config/myApps/Client Settings]].

== Windows ==
On Windows, traces are written to the <code>%LOCALAPPDATA%\innovaphone\myApps</code> directory. If you start myApps with --log-size as parameter, you can define the maximum size of a log file (e.g. --log-size=100000000 would be 100MB for each file)

:* myApps-''date-time''.txt : main log file for the platform services

:* myAppsOutlookSearch-''date-time''.txt : log file for the Outlook phone book access

:* myAppsHookController-''date-time''.txt : log file for the hot-key interceptor (see [[#Hot keys|Hot keys]])

; :myApps update installation traces are written to the <code>%windir%\temp\</code> directory.
:* myAppsInstall.txt: MSI installation file

; :myApps update service traces are written to the <code>%ProgramData%\innovaphone\myAppsUpdateService</code> directory.
:* myAppsUpdateService-''date-time''.txt: myApps update service traces

==Android==
traces can be sent by e-mail.

Also, an Android device might also be connected to a PC via an USB cable to get the traces. The files can be found in <code>Android/data/com.innovaphone.clientandroid/files</code>

== iOS ==
traces can be sent by e-mail.

== macOS ==
traces can be sent by e-mail.

Also, files can be found in <code>~/Library/Containers/com.innovaphone.client-ios/Data/Documents/</code>. Press ''Alt+N'' followed by space to get tilde ''~''.

== IP270 ==
Refer to the [[Reference16r1:Concept IP270#Troubleshooting|IP270 concept article section troubleshooting]].

= Known Problems =
[[:Category:Problem myApps platform services|Known Problems]]

= Related Articles =
* [[{{NAMESPACE}}:Concept_myApps]]
* [[{{NAMESPACE}}:Concept_myApps_Redundancy|Concept myApps Redundancy]]
* [[{{NAMESPACE}}:Concept_myApps_Office_Integration|Concept myApps Office Integration]]
* [[{{NAMESPACE}}:Concept_myAPPs_Search_in_local-Outlook_Contacts|Concept myAPPs Search in local Outlook Contacts]]
* [[{{NAMESPACE}}:Call_Detail_Record_CDR_PBX|Call Detail Records]]
* [[{{NAMESPACE}}:Concept Push Notifications for myPBX iOS and Android|Concept Push Notifications for myPBX iOS and Android]]
* [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]]
* [[{{NAMESPACE}}:PBX/Config/myApps|Reference16r1:PBX/Config/myApps]]
* [[{{NAMESPACE}}:Concept_IP270|IP270 concept article]]
[[Category:Concept myApps platform services]]

Reference14r1:Concept Contact Widgets

2026-05-12T07:44:51Z

Vsc: /* Troubleshooting */

[[Category:Concept|Conference]]

= Applies To =
* innovaphone PBX from version 14r1
* innovaphone Application Platform

= Requirements =
* innovaphone PBX
* innovaphone Application Platform
* Firmware Version 14r1
* One '''Port License''' is used by the app service to establish a VoIP registration at the PBX
* '''Video License''' (optional) is required to establish video connections [*]
* '''Widget License''' (optional) is required to remove any 'innovaphone' branding from the Widget UI

[*] '''UC License''' can also be used since it includes a '''Video License'''

= What is a Contact Widget? =
A Contact Widget (or Website Widget) is an element that can be added to a website. It offers to website visitors a way to get in contact with agents (e.g. help-desk). Website visitors can start chat sessions (asking questions, getting answers) or can start voice or even video calls.

An nice example for a "Sidebar Widget" can be viewed [https://www.innovaphone.com/de/ip-telefonie/innovaphone-pbx.html here]. 
When you have opened this website the Sidebar Widget comes slowly into view on the right side.

Example of a Business-Cards-Widget:

[[File:Cardset-widget.png]]

Example of a Sidebar-Widget:

[[File:Sidebar-Widget.png]]

= Overview =
[[File:Concept-widgets-overview.png|thumb|Overview]]
The central part of the new Widgets-Concept is the '''Contact-Widgets-App'''.
The Contact Widgets App is installed on the innovaphone Application Platform and it allows a PBX user to define Contact Widgets.

Contact Widgets can be integrated in a Website to offer easy ways to website users to contact '''Agents'''. Agents are PBX users meant to communicate with external clients. 
There are 2 fundamental types of Contact Widgets:
* '''Sidebar Widgets'''
* '''Business Cards Widgets'''

A Sidebar Widget appears one side of the website trying to take as less space as possible. The website visitor can expand the Sidebar Widget if interested. 
A Business Cards Widget appears as integrated part of the website content, offering one (or more) contacts in form of ordinary business cards.

= Configuration =
For non experienced technicians have a look at [[Howto14r1:Install_Contact_Widget_App#Installation]] and follow the installation steps mentioned in the how-to article.

Others:
* Download the 'Contact Widgets App' via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Widgets App on the Manager. We recommend to use no capital letters and no special characters (also not such as space).
* Create a new PBX Object with the PBX Manager Plugin. (*)
* Assign App to authorized (admin) users, which will be allowed to create/change/delete Contact Widgets.

Experts:
(*) You can also create the PBX Object manually: 
* Create a new object of type "App".
* Give it a "Long Name" ("Contact Widgets") and a Name ("widgets") same as the instance-name.
* Give it a password, same as the instance password.
* On the "App" tab configure URL to App Service on App Platform ("http://<ipaddress-or-dnsname>/<instance-name>/innovaphone-widgets").
* Activate option "Websocket"
* Grant access to APIs: "PbxSignal" (mandatory), "Admin" (optional) and "PbxApi" (mandatory)

= Using the Contact Widgets App =
Click on one of the buttons (depending on what type of widget you want to create):
* [+ Add new sidebar widget]
* [+ Add new business cards widget]
A new (empty) widget is displayed. You can give the widget a name by clicking the pen-symbol. The widget name helps to identify widgets as soon the number of widgets starts to grow. 
You can expand and collaps widgets by clicking the header of each widget.
[[Image:Widget-code-new-widget.png|thumb|New Widget]]

== Creating a new Widget ==

New Widget features and options

*You can add the main contact details for this widget
*Select the default language
*Set your prefered font settings *
*Change the colour settings *
*Change the margin settings *
*z-index
*Options Require license (when this checkbox is ticked, this widget will consume 1 license of type: Service(innovaphone-widgets) and the widget will be shown without advertisement)
(* By default, the Widget will use the default website font, colour and margin settings. Change can be needed depending on the website settings)
[[Image:Widget-new-widget-features.png|thumb|Widget Features]]

== Adding Agent to Widget ==
You can add and remove Agents to a Widget. Agents can be contacted by external website visitors. 
New agents are added by clicking the [+] button inside the agents container.
[[File:Adding-new-agents.png|thumb|Adding agents]]
A dialog opens where you can define the agent. It all starts with the agent's 'SIP-ID'. That's the dialable PBX user address. You can use the search function to find a PBX user by name.

There are several (optional) attributes you can set for an agent, like 'Display name', 'Phone number', 'Email address' and 'Picture'. A picture can be placed by drag & drop or can be selected from local disk by clicking the placeholder rectangle.

Finally you can define the ways of communication the agent is available for:
* Voice-only calls
* Video calls (including voice)
* Chat
* Email

For a Business-Cards-Widget the order of agents could be relevant. You can change the order of agents in the Widgets-App by easy drag & drop using the mouse.

Each widget gets a unique ID (uuid) assigned on its initial creation. This uuid is used to identify the widget when it is integrated into a website.

In case of a sidebar widget, the agent's card will be displayed by default depending on its status(availability) unless you checked "Always show widget" under the sidebar settings.

In case of a business cards widget, the agent card will always be shown, but its availability is depending on its status.

The following settings are possible:
* Presence*: Display/availability of the card based on the presence status of the agent. Presence available (green), Presence unavailable, busy (red). Usage: Normal agent based on availability.
* Always online: Permanent display/availability of the card regardless of its presence or busy status. Usage: Multiple consecutive calls to the same destination, an agent with multiple line configuration, a group or waiting queue.
* Boolean*: Display of the card depending on the true status of a Boolean object. Usage: Agent, group or waiting queues based on boolean settings.
* Inactive: Agent card is permanently in the status unavailable (red). Usage: Showing the agent in a business cards widget, but limit the access to the agent for a longer period. (holiday, sick-leave or other reasons)
'''Important!''': Presence and boolean status are dependent on the visibility configured on all the monitored objects, eg. agent user objects and monitored boolean objects. The boolean object must have the visibility option "calls" checked before adding the boolean to the widget!

= Integrating Widgets into Website =
Now it is the website admin's turn to integrate the widget into the website. 
To do this, click the [Code] button in the Widgets App at that widget you want to include. A popup appears showing a handful of code lines (HTML and Javascript). 
[[File:Widget-code-popup.png|thumb|Code Popup]]
You can ''copy'' the code lines into clipboard by clicking the [Copy] button. 
You can ''paste'' the code lines from clipboard into your website code. 
There's also a [Download] button. When clicking this button a small HTML file is saved on your local computer. This HTML file can be opened in a browser to preview the widget and test the widget's functionality.

== Content-Security-Policy ==
If the website uses Content-Security-Policy (CSP) it could be necessary to add entries to config sections 'default-src' and 'img-src'.
* The Widget opens a secure websocket connection (wss:)
* The Widget loads images via Data-URL (data:).
* The Widget uses Mail-Links (mailto:).
* The Widget uses Tel-Links (tel:).
<meta
http-equiv="Content-Security-Policy" content="
default-src 'self' '''wss://*.innovaphone.com'''; child-src 'self' '''mailto:''' '''tel:'''; img-src '''data:'''"
/>

= After Integration =
Once your widget is live on the website you can still change and update the widget in the Widgets-App. You can update the list of agents or change any other attribute. As soon as you click the widget's [Save] button any open widget instance in a web browser will update immmediately. No need for the website administrator to update the code.

= Widget-API — Protocol between Website Widget and App Service =
Basically, this section does not matter. To create and use widgets, knowledge about the protocol is not required. 
All who are interested in technical details are welcome to read on.

== Loading the Widget ==

When a widget is loaded in the browser window of the website visitor, a websocket connection is opened to the app service on the innovaphone Application Platform. Once the websocket connection is established it goes like this:
<pre>
[1] {"mt":"Start","uuid":"fadc5da4cae94bfc9434d9957ea08ccb"}
[2] {"mt":"Session","name":"Visitenkarten","lang":"de","strings":{...}}
[3] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
[4] {"mt":"GetPicture","id":"atlantis"}
[5] {"mt":"Info","id":"columbia","dn":"Columbia","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":1}
[6] {"mt":"GetPicture","id":"columbia"}
[7] {"mt":"IceConfig","stun":"stun.innovaphone.com","turn":"turn.innovaphone.com"}
[8] {"mt":"Picture","id":"atlantis","url":"data:image/jpeg;base64..."}
[9] {"mt":"Picture","id":"columbia","url":"data:image/jpeg;base64..."}
[10] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":0}
[11] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
</pre>

[1] The "Start" request is sent with the unique id of the widget. 
[2] The app service sends the "Session" response providing the widget's display-name and other parameters. 
[3]-[6] The app service sends "Info" messages for all configured agents. Each "Info" message triggers a "GetPicture" request to get a picture of the agent. 
[7] The app service sends "IceConfig" providing the STUN and TURN config required for media calls. 
[8]-[9] The app service sends "Picture" messages for all agents. 
[10]-[11] The presence of an agent may change over time. Presence updates are provided with "Info" messages.

== Initiating a call ==

<pre>
[1] {"mt":"CreateCall","dest":"atlantis","dn":"Mein Name"}
[2] {"mt":"Channels","cmd":"PROPOSAL","sdp":"..."}
[3] {"mt":"CallInfo","state":"alerting"}
[4] {"mt":"CallInfo","state":"connected","cmd":"SELECT","sdp":"..."}
[5] {"mt":"ClearCall"}
[6] {"mt":"CallInfo","state":"terminated"}
</pre>

[1] "CreatCall" message sets the target of the call ('dest') and the own display name ('dn'). 
[2] "Channels" message provides the media offer for this call. Complete SDP offer is provided. 
[3] "CallInfo" is received giving information about the call's current state. 
[4] Next "CallInfo" is received telling the call was answered and deliviering the remote side's media answer. 
[5] Web site user terminates the call. 
[6] The final "CallInfo" message is received. 

= Known issues and limitations =
* The widgets are not multi-instance capable. Multiple widgets on one and the same website are not possible. Every subpage on the website can have its own widget.
* We have seen some cases where an existing web widget from other software did have a negative impact on our widget on the website. Rearranging the widget in the HTML code might help.
* The number of Agents in a single Sidebar or Business Cards is limited by the length of the sidebar/business card configuration. Just over 100 agents will normally not be a problem. From V15r1sr4 onwards a config check has been built in to prevent too lengthy configurations, so this version is recommended for sidebars and business cards with plenty of agents.

= Troubleshooting =
If an issue can be reproduced

'''*Web visitor in a browser.''' 
The myApps web uses the logging facilities provided by the browser it runs in (i.e. JavaScript function <code>console.log</code>). In most browser this is available as ''Console'' after pressing F12.

'''*The called agent working with myApps client.''' 
The myApps platform services provide more elaborate tracing mechanisms. See ''Troubleshooting'' in [[Reference14r1:Concept_myApps_platform_services#Troubleshooting|Concept myApps platform services]].

'''*Troubleshooting AP Services on the AP.''' 
Troubleshooting a specific App instance on the AP [[Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs|Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs]]

* Go to the AP Manager and select the the Contact Widgets App.
* Stop the App.
* Select the "Log File" drop down and delete currently saved logs.
* Select the App instance, click on Diagnostics, tick the box App, Save the setting.
[[File:AP-Diagnostics.png|thumb|none|AP-Diagnostics]]
* Make sure that the logging of the App instance has been activated.
[[File:AP-DiagnosticsLogging.png|thumb|none|AP-Diagnostics-Logging]]
* Restart the App.

= Related Articles =
[[Howto14r1:Install_Contact_Widget_App|Howto14r1:Install_Contact_Widget_App]]

Reference16r1:PBX/Objects

2026-05-07T09:57:34Z

Vsc: /* License */

This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criteria. New objects can be created and existing objects can be changed or deleted.

== Display of existing Objects ==
By pressing the show link, existing objects are displayed. With the filter field (the input field left to the show link) the displayed objects are limited to those matching the filter. The filter is first applied to the 'Long Name' of the objects meaning a non case sensitive head match of the filter and the 'Long Name' is performed. If there are matching objects these are displayed.

If there are no matching objects the filter is used to match the Number of the objects including any node prefixes. This way objects of a given node with all sub-nodes can be displayed by entering the prefix of a node here.

Below the filter input field is a list of all PBXs in the system (at least the part of the system which is replicated to this device). By clicking on a PBX in the list only the objects which are assigned to this PBX are displayed and the groups configured on this PBX are displayed as well. By clicking on a group only the members of this group are displayed.

=== List of Objects ===

On the right side the list of objects is displayed. The most important configuration properties are displayed in this list to provide an overview. To view the full configuration of a given object it must be opened for editing by clicking the Long Name. The list can be sorted by clicking the table headers.

The Number of the objects in this list is not the number configured in the object but it is expanded with the prefixes of the nodes in which the object is configured.

Group memberships and Call Forwarding for an object are changed by clicking on the 'Groups' or 'CF*' link of the object. A '*' appended to a group displayed in this list means that the active flag of this group membership is set.
A '!' appended to a group displayed in this list means that group indications are configured for this group.

Fork number appended by a '*' indicates a mobility enabled user. In case the number is displayed in grey, the user consumes no mobility license on local PBX (e.g. because the user registers on other PBX).

The last column are the IP addresses of registered endpoints for a given object. If the physical location of the endpoint is not the same as the PBX, the physical location is indicated by @<physical-location> added to the IP address. A '*' appended to this field means that this is an password authenticated registration.
Registrations which are because of a standby situation, which means they are not at the PBX for which they are configured, are marked with a special colour (by default this is red).

=== New Objects ===

New objects are created by selecting the type of object in the drop down list and clicking the new link. If the list of displayed objects is limited to a PBX/Group (see above), the PBX property of the new object is preset accordingly and the group membership is added to the object.

== Object Types ==

There are different types of objects for different purposes available

;[[{{NAMESPACE}}:PBX/Objects/User|User]]: A normal User
;[[{{NAMESPACE}}:PBX/Objects/ap|AP]]: Used to enable pbx connection to Application Platform
;[[{{NAMESPACE}}:PBX/Objects/App|App]]: Create a reference to an innovaphone App that can be used in myApps
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast Conference|BC Conference]]: A Conference which automatically calls other users
;[[{{NAMESPACE}}:PBX/Objects/Boolean|Boolean]]: Used to enable Call Forwards an other things based on time/date or by calling to this object
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast|Call Broadcast]]: Forward a call to a group
;[[{{NAMESPACE}}:PBX/Objects/Conference|Conference]]: Used to create a conference
;[[{{NAMESPACE}}:PBX/Objects/Config Template|Config Template]]: Config which can be applied to other objects
;[[{{NAMESPACE}}:PBX/Objects/DECT System|DECT System]]: Defines a DECT system
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Directory Search]]: LDAP lookup based on number dialed
;[[{{NAMESPACE}}:PBX/Objects/DTMF Features|DTMF Features]]: Feature control for simple endpoints
;[[{{NAMESPACE}}:PBX/Objects/Executive|Executive]]: Executive in a executive/secretary configuration
;[[{{NAMESPACE}}:PBX/Objects/External UC|External UC]]: To forward presence subscriptions to external presence server
;[[{{NAMESPACE}}:PBX/Objects/Fax|Fax]]: Defines a fax service
;[[{{NAMESPACE}}:PBX/Objects/Gateway|Gateway]]: For registration of gateways
;[[{{NAMESPACE}}:PBX/Objects/ICP|ICP]]: Integration with ICP system
;[[{{NAMESPACE}}:PBX/Objects/MCast Announce|MCast Announce]]: Calls endpoints and forwards media as IP multicast
;[[{{NAMESPACE}}:PBX/Objects/Message Waiting|Message Waiting]]: Message Waiting for external Systems
;[[{{NAMESPACE}}:PBX/Objects/Messages|Messages]]: used to connect messaging service
;[[{{NAMESPACE}}:PBX/Objects/Mobility|Mobility]]: Mobile Integration
;[[{{NAMESPACE}}:PBX/Objects/Node|Node]]: Numbering Node
;[[{{NAMESPACE}}:PBX/Objects/Number Map|Number Map]]: Maps to other number
;[[{{NAMESPACE}}:PBX/Objects/PBX|PBX]]: To register slave PBX
;[[{{NAMESPACE}}:PBX/Objects/Push|Push]]: Defines a push service
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Quick Dial]]: Allows Quickdial based on external LDAP Directory
;[[{{NAMESPACE}}:PBX/Objects/Session Border|Session Border]]: Allows proxy registrations to other PBX
;[[{{NAMESPACE}}:PBX/Objects/Settings|Settings]]: control dynamic group memberships via myPBX client
;[[{{NAMESPACE}}:PBX/Objects/Trunk Line|Trunk Line]]: To register a trunk line
;[[{{NAMESPACE}}:PBX/Objects/Voicemail|Voicemail]]: Defines a voicemail service
;[[{{NAMESPACE}}:PBX/Objects/Waiting Queue|Waiting Queue]]: Define a waiting queue

== General Object Properties ==

Some configuration properties are specific to the type of object, some are common to all objects. Not each object type supports all general configuration properties.

;Description: Any text which can be used to describe the objects. Nothing is done with this text on the PBX.

;Hide from LDAP: When this check-mark is set, this object is available with a read-only LDAP access, which means it does not show up in the PBX phonebook on the phones.

;New Account: This checkmark can be set, adding a new User Object after deleting a User Object with the same Name, to that this is a new user and old information should not be reconnected to this user. Without this checkmark set, the name is used to connect the new User Object to the old information. This is mainly useful for information stored in Apps. Not every App does support this feature altready. It is supported by Connect and Chat, so when adding a user the setting of this checkmark means, that this is a new user and the old messages in Chat or Connect from a user with the same name are not visible for this user anymore.

;Long Name: This name is used to identify the object in the database and for display purposes. The long name must be unique throughout the system. For practical reasons, you should limit it to ''20 - extension length'' characters.

;Name
:The name of the object. This name is used for H.323 and SIP signalling (like a call number) and must be unique throughout the system.
:In order for the name to be handled correctly in all protocols, a few rules should be followed regarding the characters used.
:# The name must not start with a "." dot (See [[{{NAMESPACE}}:Concept Group Pickup across PBXs|Concept Group Pickup across PBXs]] for more details on using a dot.)
:# The character "@" must not be used (It is used as separator for E-Mail-Adresses)
:# The character "?" is a specially reserved character to append arguments, which can be used when a call is sent. (See [[{{NAMESPACE}}:PBX/Objects/Trunk_Line| Name as Number]] for more details on using a ?-sign.)
:# It is best to use only characters that are also used in e-mail addresses (before the @ sign). So "a-z0-9-_" in lower case letters.

:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.
:Note: it is recommended to use the ''Name'' field for the e-mail address (everything prior the @) in combination with the ''Use as Domain'' flag at the ''System Name''.
:If the 'Name' is to be used as E-Mail address, the Check-mark on the ''E-Mail'' line besides the ''Name'' which is displayed there as well has to be set as well.

;Number
:The telephone number of the object. This is the number by which this object can be dialed within the same node. Which means it does not include any Node prefixes.
:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.

;E-Mail: Additional E-Mail addresses for the user. Multiple addresses are separated by ';'. The 'Name' is used as E-Mail address as well together with the 'System Name' as domain. The E-Mail addresses are used to match users from other applications (e.g. Exchange, Fax Server) to PBX User Objects. The first E-Mail address is used as destination if E-Mails are to be sent to the User (e.g. received Fax). If the 'Name' shall be used as E-Mail destination, the check-mark besides the 'Name', which is duplicated to the E-Mail line should be set.

;Critical: If marked as critical the object can only be changed by administrators allowed to edit critical objects

;Password / Retype Password: If a registration password is allocated here, then it must be specified during registration, or otherwise the registration will fail. The length of the password is limited to 23 characters ASCII. Be aware when using Unicode characters like ü,ä,ö,ï,ë,é,ă,î,â,ș,ț,Ă,Î,Â,Ș,Ț,ă,î, due to the conversion from Unicode to ASCII the amount of available characters in your password will be decreased. You can use an online Unicode to ASCII converter to check if the password length is not exceeded.

;Node: The node that the object is assigned to. A Node hierarchy can be configured using Node Objects. Objects which are assigned to the same node can call each other with just the number. To call an object in a different node escapes and node prefixes have to be used. If no node is configured, the object is assigned to the node of the respective local PBX.

;PBX: The PBX that the object is assigned to. This PBX accepts registrations for the object. If no PBX is configured, the object is assigned to the respective local PBX.

;Reject ext. Calls: Calls from external sources to this object are rejected.

;Local: Marks an object as local. Local means that it can be called from endpoints physically located at the same PBX without prefixes even if the calling endpoint is in a different node. Where the endpoint is physical located is defined by the PBX the endpoint contacts first (it may be redirected to another PBX then for registration). If the object does not have a PBX configured the call is routed to the PBX where the calling endpoint is registered.
:''Note: Phones using this mechanism should use a Gatekeeper Identifier of <local-pbx>@<System Name> for registration. This way this mechanism works even if the registration happens without redirection. This can be the case if a secondary address is configured in case the local PBX is down. The registration will then be done without redirection an is not renewed when the local PBX comes up again.''

;Send Number: If an object does a call, the calling party number for this call will be replaced by the number given (if any). Used to hide an extension. If a prefix of '.' is configured, this number is interpreted as a number within the node of the object, if no prefix is configured the number is interpreted as a number within the root node.

;External: This is used together with the ''Name as Number'' Feature of a trunk object. If a ''Name as Number'' configuration is set, starting with '?' it is matched to this entry. If only '?' is configured it always matches. Any digit following the matching part is sent as CLI for calls out through the trunk object.

;Dial In: If this check-mark is set, the external CLI which is sent out on the trunk, can also be used to dial in from the trunk. In this case this CLI must be unique.

;URL: A URL configured here is send with any call from this object as source URL. Only H.323 support sending a URL. Some called endpoints may make use of the URL. The URL is also available within the CDRs generated by the gateway.

;Max Calls: Limits the concurrent calls to this object. Any additional call is rejected with "No Channel Available"

;Group Indications: The group for which group indications are sent to the registered endpoints. The object must be active member in this group. The other objects (for which group indications are sent) need not to be active. To monitor other endpoints on a phone with a Partner/Pickup function key group indications are needed for the endpoints. The maximal length of the Group Indication Name in V7 is set to 48 characters.

;Hide Connected Endpoint: This check-mark hides the name and number of the connected endpoint if an object with this check-mark set is called. This applies for example if a call forwarding was configured or the object was a broadcast group. In these cases the connected endpoint is different from the called.

== License ==

For User and Executive objects licenses which shall be used for this user can be configured. The licensed features can only be used if they are checked on this page.

;UCC: includes App(phone), App(softphone), Video, AppSharing, Voicemail, Mobility, Fax, App(chat), App(connect), App(innovaphone-pbx-conferencing), App(innovaphone-assistant), [[{{NAMESPACE}}:Concept_App_Service_Documents|Documents]], [[{{NAMESPACE}}:Concept_App_Service_Conference_Transcriptions|Conference Transcriptions]]
;UCC Upgrade from UC: upgrade license from UC to UCC
;UCC Upgrade from Softphone: upgrade license from Softphone to UCC
;UC: includes App(phone), App(softphone), Video, AppSharing, Voicemail, Mobility, Fax
;Voicemail:[[{{NAMESPACE}}:Concept_App_Service_Voicemail|Voicemail for this user]]
;Fax:[[{{NAMESPACE}}:Concept_App_Service_Fax|Personal Fax Application]], included in UC/UCC
;Mobility:[[{{NAMESPACE}}:Concept_App_RCC|Mobility device integration]], included in UC/UCC
;myPBX: myPBX client (outdated)
;Video: Video integrated within Phone and Softphone application, included in UC/UCC
;AppSharing: Application Sharing integrated within Phone and Softphone application, included in UC/UCC
;Reporting:[[{{NAMESPACE}}:Concept_App_Service_Reports|Reporting Application]], call lists do not require this license
;App(phone):[[{{NAMESPACE}}:Concept_App_PhoneApp|Phone Application]], included in UC/UCC
;App(softphone):[[{{NAMESPACE}}:Concept_App_SoftphoneApp|Softphone Application]], included in UC/UCC
;App(chat):[[{{NAMESPACE}}:Concept_Chat|Premium Chat application]] with message storage, included in UCC
;App(innovaphone-assistant):[[{{NAMESPACE}}:Concept_App_Service_myApps_Assistant|Assistant Application]], included in UCC
;App(innovaphone-working):[[{{NAMESPACE}}:Concept_App_Service_Working|Working Application]]
;App(innovaphone-switchboard):[[{{NAMESPACE}}:Concept_App_Service_Queues|Switchboard Application]]
;App(innovaphone-recorder):[[{{NAMESPACE}}:Concept_App_Service_Recordings|Voice Recording Application]]
;App(innovaphone-projects):[[{{NAMESPACE}}:Concept_App_Service_Projects|Projects Application]]
;App(innovaphone-pbx-conferencing):[[{{NAMESPACE}}:Concept_Conference|Conferencing Application]], included in UCC
;App(innovaphone-myphonekeys):[[{{NAMESPACE}}:Concept_App_myPhoneKeys|Desk Phone Control]]
;App(innovaphone-microsoft365):[[{{NAMESPACE}}:Concept_App_Service_Connector_for_Microsoft_365|Teams Connector]]
;App(innovaphone-kuando):[[{{NAMESPACE}}:Concept_App_Service_Connector_for_kuando%C2%AE|Kuando Connector]]
;App(innovaphone-connect):[[{{NAMESPACE}}:Concept_App_Connect|Connect Application]], included in UCC

== Devices ==
This section enables assignment and identification of multiple devices for the same user. Those devices may register and operate in parallel for this user.

=== Devices Input Fields ===
; Hardware Id: identifies the connected device to match the incoming registration. Can either be a MAC-address (for fixed phones) or a unique descriptor (for softphones/3rd-pty-terminals).
: Filled in automatically when phones are provisioned by UsersAdminApp or ProfileApp.
: If a hardware id identical to the object name is configured, the name or the number of the object can be used for registration. For registrations with name or number of the object, the settings configured at this device are used in this case.
; Name: can be used for a description of the device.
: On the SOAP/TAPI interface Name can be used to let the user select the device which shall be controlled.
: If no device is configured the Name and Hardware Id are used for default devices to ensure configuration compatibility.
: To allow an endpoint to register with the objects Name or Number, a device must be configured with a hardware id that is equal to the object Name. (E.g. Registrations from DECT Base Stations)
: A registration by number does not succeed if the length of the number does not match, other when dialing an object in which case additional dialed digits are ignored.
: If a registration by number does not match any object number, the number is converted to a name and a device hardware id is searched with this name.
; App: this field allows to configure a V13-App used to control this device. E.g. "phone" or "softphone" in lower letters.
: If a hardware ID is already present, this field is not set automatically during install and thus must be manually set.
: Name field should also be filled with an unambiguous description for use in myApps. Example :
: <table>
<tr>
<th>Hardware Id</th>
<th>Name</th>
<th>App</th>
</tr>
<tr>
<td>009033000000</td>
<td>myDeskphoneName</td>
<td>phone</td>
</tr>
<tr>
<td>exampleSoft</td>
<td>mySoftphoneName</td>
<td>softphone</td>
</tr>
:</table>

=== Devices Config Flags ===

;PBX Pwd: Registration with the PBX master password only

;No IP Filter: Don't apply IP Filters for registrations

;TLS only: Allow Registration with H.323/TLS only. If this check-mark is set a matching certificate, which is trusted by the PBX must be provided.

;No Mobility: If a registration on this device is active don't call a mobility number

;Config VOIP: Add additional config for VoIP. E.g. configure a WebRTC endpoint. Apply has to be pressed once and Name Field must be set to allow enable the additional input page with the "defined" name.
: If this checkmark is set and a '''Name''' is configured for the Device a new tab-sheet with the configured name is available to allow more VoIP Parameters to be configured.

;Reverse Proxy: Allow the device to register through a reverse proxy. The registration through a reverse proxy is identified by the IP addresses configured for reverse proxies

;Single Reg.: Allow a single registration to this device only

;Media Relay: Force Media Relay on the PBX for this device only.
: When this is enabled and the registration of the device is coming in via a reverse proxy server server-reflexive address (SRFLX) obtained via STUN is provided as default media address.
: This feature is used so that third party SIP phones not supporting ICE/DTLS can be used together with the innovaphone PBX as on-site phones as well as phones in home offices or phones in a cloud scenario.

;No SRTP: Do not offer SRTP in SIP/SDP when Media Relay is set at the Hardware ID

=== Security issues ===

There are security build in mechanisms :

* If the '''PBX Pwd''' (in older V9 builds AdminPwd) check-mark is set, registration to this device is only possible with the PBX password, which is configured in PBX/Config/Security.

* The check-mark '''No IP Filter''' allows the registration to the device even if the IP Filter does not match. This way general registration can be restricted using the IP Filters and some selected devices can be opened for registration from the public internet. A registration without password is not allowed in this case. (Available from v9 hf15)

* If this object will have no registration, leave the device field empty (for security reasons). Nobody can abuse and register at that object.

* If a registration request comes with the wrong password the object deny´s '''all''' registration requests (with the reason REGISTER-REJ : Reason=PBX missing Authentication) for 20 seconds. After that time it is possible to register (with the right password).

== Objects with empty node or PBX ==
If an object has no '''PBX''' configured, it will be replicated (if replication is turned on) to all slaves. Furthermore, any PBX will satisfy incoming registration requests. Calls to such objects that are built-in to the PBX and thus do not require a registration to work (e.g. Waiting Queue) will be processed by each PBX the call is presented to.

If an object has no '''Node''' configured, it will be considered to live in the node of each PBX the object is known to. So if an object has neither '''Node''' nor '''PBX''' configured, it will be present in all nodes that have a PBX and calls to such objects will be processed locally for objects that are built-in to the PBX.

Reference16r1:PBX/Objects

2026-05-07T09:41:01Z

Vsc: /* License */

This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criteria. New objects can be created and existing objects can be changed or deleted.

== Display of existing Objects ==
By pressing the show link, existing objects are displayed. With the filter field (the input field left to the show link) the displayed objects are limited to those matching the filter. The filter is first applied to the 'Long Name' of the objects meaning a non case sensitive head match of the filter and the 'Long Name' is performed. If there are matching objects these are displayed.

If there are no matching objects the filter is used to match the Number of the objects including any node prefixes. This way objects of a given node with all sub-nodes can be displayed by entering the prefix of a node here.

Below the filter input field is a list of all PBXs in the system (at least the part of the system which is replicated to this device). By clicking on a PBX in the list only the objects which are assigned to this PBX are displayed and the groups configured on this PBX are displayed as well. By clicking on a group only the members of this group are displayed.

=== List of Objects ===

On the right side the list of objects is displayed. The most important configuration properties are displayed in this list to provide an overview. To view the full configuration of a given object it must be opened for editing by clicking the Long Name. The list can be sorted by clicking the table headers.

The Number of the objects in this list is not the number configured in the object but it is expanded with the prefixes of the nodes in which the object is configured.

Group memberships and Call Forwarding for an object are changed by clicking on the 'Groups' or 'CF*' link of the object. A '*' appended to a group displayed in this list means that the active flag of this group membership is set.
A '!' appended to a group displayed in this list means that group indications are configured for this group.

Fork number appended by a '*' indicates a mobility enabled user. In case the number is displayed in grey, the user consumes no mobility license on local PBX (e.g. because the user registers on other PBX).

The last column are the IP addresses of registered endpoints for a given object. If the physical location of the endpoint is not the same as the PBX, the physical location is indicated by @<physical-location> added to the IP address. A '*' appended to this field means that this is an password authenticated registration.
Registrations which are because of a standby situation, which means they are not at the PBX for which they are configured, are marked with a special colour (by default this is red).

=== New Objects ===

New objects are created by selecting the type of object in the drop down list and clicking the new link. If the list of displayed objects is limited to a PBX/Group (see above), the PBX property of the new object is preset accordingly and the group membership is added to the object.

== Object Types ==

There are different types of objects for different purposes available

;[[{{NAMESPACE}}:PBX/Objects/User|User]]: A normal User
;[[{{NAMESPACE}}:PBX/Objects/ap|AP]]: Used to enable pbx connection to Application Platform
;[[{{NAMESPACE}}:PBX/Objects/App|App]]: Create a reference to an innovaphone App that can be used in myApps
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast Conference|BC Conference]]: A Conference which automatically calls other users
;[[{{NAMESPACE}}:PBX/Objects/Boolean|Boolean]]: Used to enable Call Forwards an other things based on time/date or by calling to this object
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast|Call Broadcast]]: Forward a call to a group
;[[{{NAMESPACE}}:PBX/Objects/Conference|Conference]]: Used to create a conference
;[[{{NAMESPACE}}:PBX/Objects/Config Template|Config Template]]: Config which can be applied to other objects
;[[{{NAMESPACE}}:PBX/Objects/DECT System|DECT System]]: Defines a DECT system
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Directory Search]]: LDAP lookup based on number dialed
;[[{{NAMESPACE}}:PBX/Objects/DTMF Features|DTMF Features]]: Feature control for simple endpoints
;[[{{NAMESPACE}}:PBX/Objects/Executive|Executive]]: Executive in a executive/secretary configuration
;[[{{NAMESPACE}}:PBX/Objects/External UC|External UC]]: To forward presence subscriptions to external presence server
;[[{{NAMESPACE}}:PBX/Objects/Fax|Fax]]: Defines a fax service
;[[{{NAMESPACE}}:PBX/Objects/Gateway|Gateway]]: For registration of gateways
;[[{{NAMESPACE}}:PBX/Objects/ICP|ICP]]: Integration with ICP system
;[[{{NAMESPACE}}:PBX/Objects/MCast Announce|MCast Announce]]: Calls endpoints and forwards media as IP multicast
;[[{{NAMESPACE}}:PBX/Objects/Message Waiting|Message Waiting]]: Message Waiting for external Systems
;[[{{NAMESPACE}}:PBX/Objects/Messages|Messages]]: used to connect messaging service
;[[{{NAMESPACE}}:PBX/Objects/Mobility|Mobility]]: Mobile Integration
;[[{{NAMESPACE}}:PBX/Objects/Node|Node]]: Numbering Node
;[[{{NAMESPACE}}:PBX/Objects/Number Map|Number Map]]: Maps to other number
;[[{{NAMESPACE}}:PBX/Objects/PBX|PBX]]: To register slave PBX
;[[{{NAMESPACE}}:PBX/Objects/Push|Push]]: Defines a push service
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Quick Dial]]: Allows Quickdial based on external LDAP Directory
;[[{{NAMESPACE}}:PBX/Objects/Session Border|Session Border]]: Allows proxy registrations to other PBX
;[[{{NAMESPACE}}:PBX/Objects/Settings|Settings]]: control dynamic group memberships via myPBX client
;[[{{NAMESPACE}}:PBX/Objects/Trunk Line|Trunk Line]]: To register a trunk line
;[[{{NAMESPACE}}:PBX/Objects/Voicemail|Voicemail]]: Defines a voicemail service
;[[{{NAMESPACE}}:PBX/Objects/Waiting Queue|Waiting Queue]]: Define a waiting queue

== General Object Properties ==

Some configuration properties are specific to the type of object, some are common to all objects. Not each object type supports all general configuration properties.

;Description: Any text which can be used to describe the objects. Nothing is done with this text on the PBX.

;Hide from LDAP: When this check-mark is set, this object is available with a read-only LDAP access, which means it does not show up in the PBX phonebook on the phones.

;New Account: This checkmark can be set, adding a new User Object after deleting a User Object with the same Name, to that this is a new user and old information should not be reconnected to this user. Without this checkmark set, the name is used to connect the new User Object to the old information. This is mainly useful for information stored in Apps. Not every App does support this feature altready. It is supported by Connect and Chat, so when adding a user the setting of this checkmark means, that this is a new user and the old messages in Chat or Connect from a user with the same name are not visible for this user anymore.

;Long Name: This name is used to identify the object in the database and for display purposes. The long name must be unique throughout the system. For practical reasons, you should limit it to ''20 - extension length'' characters.

;Name
:The name of the object. This name is used for H.323 and SIP signalling (like a call number) and must be unique throughout the system.
:In order for the name to be handled correctly in all protocols, a few rules should be followed regarding the characters used.
:# The name must not start with a "." dot (See [[{{NAMESPACE}}:Concept Group Pickup across PBXs|Concept Group Pickup across PBXs]] for more details on using a dot.)
:# The character "@" must not be used (It is used as separator for E-Mail-Adresses)
:# The character "?" is a specially reserved character to append arguments, which can be used when a call is sent. (See [[{{NAMESPACE}}:PBX/Objects/Trunk_Line| Name as Number]] for more details on using a ?-sign.)
:# It is best to use only characters that are also used in e-mail addresses (before the @ sign). So "a-z0-9-_" in lower case letters.

:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.
:Note: it is recommended to use the ''Name'' field for the e-mail address (everything prior the @) in combination with the ''Use as Domain'' flag at the ''System Name''.
:If the 'Name' is to be used as E-Mail address, the Check-mark on the ''E-Mail'' line besides the ''Name'' which is displayed there as well has to be set as well.

;Number
:The telephone number of the object. This is the number by which this object can be dialed within the same node. Which means it does not include any Node prefixes.
:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.

;E-Mail: Additional E-Mail addresses for the user. Multiple addresses are separated by ';'. The 'Name' is used as E-Mail address as well together with the 'System Name' as domain. The E-Mail addresses are used to match users from other applications (e.g. Exchange, Fax Server) to PBX User Objects. The first E-Mail address is used as destination if E-Mails are to be sent to the User (e.g. received Fax). If the 'Name' shall be used as E-Mail destination, the check-mark besides the 'Name', which is duplicated to the E-Mail line should be set.

;Critical: If marked as critical the object can only be changed by administrators allowed to edit critical objects

;Password / Retype Password: If a registration password is allocated here, then it must be specified during registration, or otherwise the registration will fail. The length of the password is limited to 23 characters ASCII. Be aware when using Unicode characters like ü,ä,ö,ï,ë,é,ă,î,â,ș,ț,Ă,Î,Â,Ș,Ț,ă,î, due to the conversion from Unicode to ASCII the amount of available characters in your password will be decreased. You can use an online Unicode to ASCII converter to check if the password length is not exceeded.

;Node: The node that the object is assigned to. A Node hierarchy can be configured using Node Objects. Objects which are assigned to the same node can call each other with just the number. To call an object in a different node escapes and node prefixes have to be used. If no node is configured, the object is assigned to the node of the respective local PBX.

;PBX: The PBX that the object is assigned to. This PBX accepts registrations for the object. If no PBX is configured, the object is assigned to the respective local PBX.

;Reject ext. Calls: Calls from external sources to this object are rejected.

;Local: Marks an object as local. Local means that it can be called from endpoints physically located at the same PBX without prefixes even if the calling endpoint is in a different node. Where the endpoint is physical located is defined by the PBX the endpoint contacts first (it may be redirected to another PBX then for registration). If the object does not have a PBX configured the call is routed to the PBX where the calling endpoint is registered.
:''Note: Phones using this mechanism should use a Gatekeeper Identifier of <local-pbx>@<System Name> for registration. This way this mechanism works even if the registration happens without redirection. This can be the case if a secondary address is configured in case the local PBX is down. The registration will then be done without redirection an is not renewed when the local PBX comes up again.''

;Send Number: If an object does a call, the calling party number for this call will be replaced by the number given (if any). Used to hide an extension. If a prefix of '.' is configured, this number is interpreted as a number within the node of the object, if no prefix is configured the number is interpreted as a number within the root node.

;External: This is used together with the ''Name as Number'' Feature of a trunk object. If a ''Name as Number'' configuration is set, starting with '?' it is matched to this entry. If only '?' is configured it always matches. Any digit following the matching part is sent as CLI for calls out through the trunk object.

;Dial In: If this check-mark is set, the external CLI which is sent out on the trunk, can also be used to dial in from the trunk. In this case this CLI must be unique.

;URL: A URL configured here is send with any call from this object as source URL. Only H.323 support sending a URL. Some called endpoints may make use of the URL. The URL is also available within the CDRs generated by the gateway.

;Max Calls: Limits the concurrent calls to this object. Any additional call is rejected with "No Channel Available"

;Group Indications: The group for which group indications are sent to the registered endpoints. The object must be active member in this group. The other objects (for which group indications are sent) need not to be active. To monitor other endpoints on a phone with a Partner/Pickup function key group indications are needed for the endpoints. The maximal length of the Group Indication Name in V7 is set to 48 characters.

;Hide Connected Endpoint: This check-mark hides the name and number of the connected endpoint if an object with this check-mark set is called. This applies for example if a call forwarding was configured or the object was a broadcast group. In these cases the connected endpoint is different from the called.

== License ==

For User and Executive objects licenses which shall be used for this user can be configured. The licensed features can only be used if they are checked on this page.

;UCC: includes App(phone), App(softphone), Video, AppSharing, Voicemail, Mobility, Fax, App(chat), App(connect), App(innovaphone-pbx-conferencing), App(innovaphone-assistant)
;UCC Upgrade from UC: upgrade license from UC to UCC
;UCC Upgrade from Softphone: upgrade license from Softphone to UCC
;UC: includes App(phone), App(softphone), Video, AppSharing, Voicemail, Mobility, Fax
;Voicemail:[[{{NAMESPACE}}:Concept_App_Service_Voicemail|Voicemail for this user]]
;Fax:[[{{NAMESPACE}}:Concept_App_Service_Fax|Personal Fax Application]], included in UC/UCC
;Mobility:[[{{NAMESPACE}}:Concept_App_RCC|Mobility device integration]], included in UC/UCC
;myPBX: myPBX client (outdated)
;Video: Video integrated within Phone and Softphone application, included in UC/UCC
;AppSharing: Application Sharing integrated within Phone and Softphone application, included in UC/UCC
;Reporting:[[{{NAMESPACE}}:Concept_App_Service_Reports|Reporting Application]], call lists do not require this license
;App(phone):[[{{NAMESPACE}}:Concept_App_PhoneApp|Phone Application]], included in UC/UCC
;App(softphone):[[{{NAMESPACE}}:Concept_App_SoftphoneApp|Softphone Application]], included in UC/UCC
;App(chat):[[{{NAMESPACE}}:Concept_Chat|Premium Chat application]] with message storage, included in UCC
;App(innovaphone-assistant):[[{{NAMESPACE}}:Concept_App_Service_myApps_Assistant|Assistant Application]], included in UCC
;App(innovaphone-working):[[{{NAMESPACE}}:Concept_App_Service_Working|Working Application]]
;App(innovaphone-switchboard):[[{{NAMESPACE}}:Concept_App_Service_Queues|Switchboard Application]]
;App(innovaphone-recorder):[[{{NAMESPACE}}:Concept_App_Service_Recordings|Voice Recording Application]]
;App(innovaphone-projects):[[{{NAMESPACE}}:Concept_App_Service_Projects|Projects Application]]
;App(innovaphone-pbx-conferencing):[[{{NAMESPACE}}:Concept_Conference|Conferencing Application]], included in UCC
;App(innovaphone-myphonekeys):[[{{NAMESPACE}}:Concept_App_myPhoneKeys|Desk Phone Control]]
;App(innovaphone-microsoft365):[[{{NAMESPACE}}:Concept_App_Service_Connector_for_Microsoft_365|Teams Connector]]
;App(innovaphone-kuando):[[{{NAMESPACE}}:Concept_App_Service_Connector_for_kuando%C2%AE|Kuando Connector]]
;App(innovaphone-connect):[[{{NAMESPACE}}:Concept_App_Connect|Connect Application]], included in UCC

== Devices ==
This section enables assignment and identification of multiple devices for the same user. Those devices may register and operate in parallel for this user.

=== Devices Input Fields ===
; Hardware Id: identifies the connected device to match the incoming registration. Can either be a MAC-address (for fixed phones) or a unique descriptor (for softphones/3rd-pty-terminals).
: Filled in automatically when phones are provisioned by UsersAdminApp or ProfileApp.
: If a hardware id identical to the object name is configured, the name or the number of the object can be used for registration. For registrations with name or number of the object, the settings configured at this device are used in this case.
; Name: can be used for a description of the device.
: On the SOAP/TAPI interface Name can be used to let the user select the device which shall be controlled.
: If no device is configured the Name and Hardware Id are used for default devices to ensure configuration compatibility.
: To allow an endpoint to register with the objects Name or Number, a device must be configured with a hardware id that is equal to the object Name. (E.g. Registrations from DECT Base Stations)
: A registration by number does not succeed if the length of the number does not match, other when dialing an object in which case additional dialed digits are ignored.
: If a registration by number does not match any object number, the number is converted to a name and a device hardware id is searched with this name.
; App: this field allows to configure a V13-App used to control this device. E.g. "phone" or "softphone" in lower letters.
: If a hardware ID is already present, this field is not set automatically during install and thus must be manually set.
: Name field should also be filled with an unambiguous description for use in myApps. Example :
: <table>
<tr>
<th>Hardware Id</th>
<th>Name</th>
<th>App</th>
</tr>
<tr>
<td>009033000000</td>
<td>myDeskphoneName</td>
<td>phone</td>
</tr>
<tr>
<td>exampleSoft</td>
<td>mySoftphoneName</td>
<td>softphone</td>
</tr>
:</table>

=== Devices Config Flags ===

;PBX Pwd: Registration with the PBX master password only

;No IP Filter: Don't apply IP Filters for registrations

;TLS only: Allow Registration with H.323/TLS only. If this check-mark is set a matching certificate, which is trusted by the PBX must be provided.

;No Mobility: If a registration on this device is active don't call a mobility number

;Config VOIP: Add additional config for VoIP. E.g. configure a WebRTC endpoint. Apply has to be pressed once and Name Field must be set to allow enable the additional input page with the "defined" name.
: If this checkmark is set and a '''Name''' is configured for the Device a new tab-sheet with the configured name is available to allow more VoIP Parameters to be configured.

;Reverse Proxy: Allow the device to register through a reverse proxy. The registration through a reverse proxy is identified by the IP addresses configured for reverse proxies

;Single Reg.: Allow a single registration to this device only

;Media Relay: Force Media Relay on the PBX for this device only.
: When this is enabled and the registration of the device is coming in via a reverse proxy server server-reflexive address (SRFLX) obtained via STUN is provided as default media address.
: This feature is used so that third party SIP phones not supporting ICE/DTLS can be used together with the innovaphone PBX as on-site phones as well as phones in home offices or phones in a cloud scenario.

;No SRTP: Do not offer SRTP in SIP/SDP when Media Relay is set at the Hardware ID

=== Security issues ===

There are security build in mechanisms :

* If the '''PBX Pwd''' (in older V9 builds AdminPwd) check-mark is set, registration to this device is only possible with the PBX password, which is configured in PBX/Config/Security.

* The check-mark '''No IP Filter''' allows the registration to the device even if the IP Filter does not match. This way general registration can be restricted using the IP Filters and some selected devices can be opened for registration from the public internet. A registration without password is not allowed in this case. (Available from v9 hf15)

* If this object will have no registration, leave the device field empty (for security reasons). Nobody can abuse and register at that object.

* If a registration request comes with the wrong password the object deny´s '''all''' registration requests (with the reason REGISTER-REJ : Reason=PBX missing Authentication) for 20 seconds. After that time it is possible to register (with the right password).

== Objects with empty node or PBX ==
If an object has no '''PBX''' configured, it will be replicated (if replication is turned on) to all slaves. Furthermore, any PBX will satisfy incoming registration requests. Calls to such objects that are built-in to the PBX and thus do not require a registration to work (e.g. Waiting Queue) will be processed by each PBX the call is presented to.

If an object has no '''Node''' configured, it will be considered to live in the node of each PBX the object is known to. So if an object has neither '''Node''' nor '''PBX''' configured, it will be present in all nodes that have a PBX and calls to such objects will be processed locally for objects that are built-in to the PBX.

Reference16r1:PBX/Objects

2026-05-07T09:40:36Z

Vsc: /* License */

This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criteria. New objects can be created and existing objects can be changed or deleted.

== Display of existing Objects ==
By pressing the show link, existing objects are displayed. With the filter field (the input field left to the show link) the displayed objects are limited to those matching the filter. The filter is first applied to the 'Long Name' of the objects meaning a non case sensitive head match of the filter and the 'Long Name' is performed. If there are matching objects these are displayed.

If there are no matching objects the filter is used to match the Number of the objects including any node prefixes. This way objects of a given node with all sub-nodes can be displayed by entering the prefix of a node here.

Below the filter input field is a list of all PBXs in the system (at least the part of the system which is replicated to this device). By clicking on a PBX in the list only the objects which are assigned to this PBX are displayed and the groups configured on this PBX are displayed as well. By clicking on a group only the members of this group are displayed.

=== List of Objects ===

On the right side the list of objects is displayed. The most important configuration properties are displayed in this list to provide an overview. To view the full configuration of a given object it must be opened for editing by clicking the Long Name. The list can be sorted by clicking the table headers.

The Number of the objects in this list is not the number configured in the object but it is expanded with the prefixes of the nodes in which the object is configured.

Group memberships and Call Forwarding for an object are changed by clicking on the 'Groups' or 'CF*' link of the object. A '*' appended to a group displayed in this list means that the active flag of this group membership is set.
A '!' appended to a group displayed in this list means that group indications are configured for this group.

Fork number appended by a '*' indicates a mobility enabled user. In case the number is displayed in grey, the user consumes no mobility license on local PBX (e.g. because the user registers on other PBX).

The last column are the IP addresses of registered endpoints for a given object. If the physical location of the endpoint is not the same as the PBX, the physical location is indicated by @<physical-location> added to the IP address. A '*' appended to this field means that this is an password authenticated registration.
Registrations which are because of a standby situation, which means they are not at the PBX for which they are configured, are marked with a special colour (by default this is red).

=== New Objects ===

New objects are created by selecting the type of object in the drop down list and clicking the new link. If the list of displayed objects is limited to a PBX/Group (see above), the PBX property of the new object is preset accordingly and the group membership is added to the object.

== Object Types ==

There are different types of objects for different purposes available

;[[{{NAMESPACE}}:PBX/Objects/User|User]]: A normal User
;[[{{NAMESPACE}}:PBX/Objects/ap|AP]]: Used to enable pbx connection to Application Platform
;[[{{NAMESPACE}}:PBX/Objects/App|App]]: Create a reference to an innovaphone App that can be used in myApps
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast Conference|BC Conference]]: A Conference which automatically calls other users
;[[{{NAMESPACE}}:PBX/Objects/Boolean|Boolean]]: Used to enable Call Forwards an other things based on time/date or by calling to this object
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast|Call Broadcast]]: Forward a call to a group
;[[{{NAMESPACE}}:PBX/Objects/Conference|Conference]]: Used to create a conference
;[[{{NAMESPACE}}:PBX/Objects/Config Template|Config Template]]: Config which can be applied to other objects
;[[{{NAMESPACE}}:PBX/Objects/DECT System|DECT System]]: Defines a DECT system
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Directory Search]]: LDAP lookup based on number dialed
;[[{{NAMESPACE}}:PBX/Objects/DTMF Features|DTMF Features]]: Feature control for simple endpoints
;[[{{NAMESPACE}}:PBX/Objects/Executive|Executive]]: Executive in a executive/secretary configuration
;[[{{NAMESPACE}}:PBX/Objects/External UC|External UC]]: To forward presence subscriptions to external presence server
;[[{{NAMESPACE}}:PBX/Objects/Fax|Fax]]: Defines a fax service
;[[{{NAMESPACE}}:PBX/Objects/Gateway|Gateway]]: For registration of gateways
;[[{{NAMESPACE}}:PBX/Objects/ICP|ICP]]: Integration with ICP system
;[[{{NAMESPACE}}:PBX/Objects/MCast Announce|MCast Announce]]: Calls endpoints and forwards media as IP multicast
;[[{{NAMESPACE}}:PBX/Objects/Message Waiting|Message Waiting]]: Message Waiting for external Systems
;[[{{NAMESPACE}}:PBX/Objects/Messages|Messages]]: used to connect messaging service
;[[{{NAMESPACE}}:PBX/Objects/Mobility|Mobility]]: Mobile Integration
;[[{{NAMESPACE}}:PBX/Objects/Node|Node]]: Numbering Node
;[[{{NAMESPACE}}:PBX/Objects/Number Map|Number Map]]: Maps to other number
;[[{{NAMESPACE}}:PBX/Objects/PBX|PBX]]: To register slave PBX
;[[{{NAMESPACE}}:PBX/Objects/Push|Push]]: Defines a push service
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Quick Dial]]: Allows Quickdial based on external LDAP Directory
;[[{{NAMESPACE}}:PBX/Objects/Session Border|Session Border]]: Allows proxy registrations to other PBX
;[[{{NAMESPACE}}:PBX/Objects/Settings|Settings]]: control dynamic group memberships via myPBX client
;[[{{NAMESPACE}}:PBX/Objects/Trunk Line|Trunk Line]]: To register a trunk line
;[[{{NAMESPACE}}:PBX/Objects/Voicemail|Voicemail]]: Defines a voicemail service
;[[{{NAMESPACE}}:PBX/Objects/Waiting Queue|Waiting Queue]]: Define a waiting queue

== General Object Properties ==

Some configuration properties are specific to the type of object, some are common to all objects. Not each object type supports all general configuration properties.

;Description: Any text which can be used to describe the objects. Nothing is done with this text on the PBX.

;Hide from LDAP: When this check-mark is set, this object is available with a read-only LDAP access, which means it does not show up in the PBX phonebook on the phones.

;New Account: This checkmark can be set, adding a new User Object after deleting a User Object with the same Name, to that this is a new user and old information should not be reconnected to this user. Without this checkmark set, the name is used to connect the new User Object to the old information. This is mainly useful for information stored in Apps. Not every App does support this feature altready. It is supported by Connect and Chat, so when adding a user the setting of this checkmark means, that this is a new user and the old messages in Chat or Connect from a user with the same name are not visible for this user anymore.

;Long Name: This name is used to identify the object in the database and for display purposes. The long name must be unique throughout the system. For practical reasons, you should limit it to ''20 - extension length'' characters.

;Name
:The name of the object. This name is used for H.323 and SIP signalling (like a call number) and must be unique throughout the system.
:In order for the name to be handled correctly in all protocols, a few rules should be followed regarding the characters used.
:# The name must not start with a "." dot (See [[{{NAMESPACE}}:Concept Group Pickup across PBXs|Concept Group Pickup across PBXs]] for more details on using a dot.)
:# The character "@" must not be used (It is used as separator for E-Mail-Adresses)
:# The character "?" is a specially reserved character to append arguments, which can be used when a call is sent. (See [[{{NAMESPACE}}:PBX/Objects/Trunk_Line| Name as Number]] for more details on using a ?-sign.)
:# It is best to use only characters that are also used in e-mail addresses (before the @ sign). So "a-z0-9-_" in lower case letters.

:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.
:Note: it is recommended to use the ''Name'' field for the e-mail address (everything prior the @) in combination with the ''Use as Domain'' flag at the ''System Name''.
:If the 'Name' is to be used as E-Mail address, the Check-mark on the ''E-Mail'' line besides the ''Name'' which is displayed there as well has to be set as well.

;Number
:The telephone number of the object. This is the number by which this object can be dialed within the same node. Which means it does not include any Node prefixes.
:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.

;E-Mail: Additional E-Mail addresses for the user. Multiple addresses are separated by ';'. The 'Name' is used as E-Mail address as well together with the 'System Name' as domain. The E-Mail addresses are used to match users from other applications (e.g. Exchange, Fax Server) to PBX User Objects. The first E-Mail address is used as destination if E-Mails are to be sent to the User (e.g. received Fax). If the 'Name' shall be used as E-Mail destination, the check-mark besides the 'Name', which is duplicated to the E-Mail line should be set.

;Critical: If marked as critical the object can only be changed by administrators allowed to edit critical objects

;Password / Retype Password: If a registration password is allocated here, then it must be specified during registration, or otherwise the registration will fail. The length of the password is limited to 23 characters ASCII. Be aware when using Unicode characters like ü,ä,ö,ï,ë,é,ă,î,â,ș,ț,Ă,Î,Â,Ș,Ț,ă,î, due to the conversion from Unicode to ASCII the amount of available characters in your password will be decreased. You can use an online Unicode to ASCII converter to check if the password length is not exceeded.

;Node: The node that the object is assigned to. A Node hierarchy can be configured using Node Objects. Objects which are assigned to the same node can call each other with just the number. To call an object in a different node escapes and node prefixes have to be used. If no node is configured, the object is assigned to the node of the respective local PBX.

;PBX: The PBX that the object is assigned to. This PBX accepts registrations for the object. If no PBX is configured, the object is assigned to the respective local PBX.

;Reject ext. Calls: Calls from external sources to this object are rejected.

;Local: Marks an object as local. Local means that it can be called from endpoints physically located at the same PBX without prefixes even if the calling endpoint is in a different node. Where the endpoint is physical located is defined by the PBX the endpoint contacts first (it may be redirected to another PBX then for registration). If the object does not have a PBX configured the call is routed to the PBX where the calling endpoint is registered.
:''Note: Phones using this mechanism should use a Gatekeeper Identifier of <local-pbx>@<System Name> for registration. This way this mechanism works even if the registration happens without redirection. This can be the case if a secondary address is configured in case the local PBX is down. The registration will then be done without redirection an is not renewed when the local PBX comes up again.''

;Send Number: If an object does a call, the calling party number for this call will be replaced by the number given (if any). Used to hide an extension. If a prefix of '.' is configured, this number is interpreted as a number within the node of the object, if no prefix is configured the number is interpreted as a number within the root node.

;External: This is used together with the ''Name as Number'' Feature of a trunk object. If a ''Name as Number'' configuration is set, starting with '?' it is matched to this entry. If only '?' is configured it always matches. Any digit following the matching part is sent as CLI for calls out through the trunk object.

;Dial In: If this check-mark is set, the external CLI which is sent out on the trunk, can also be used to dial in from the trunk. In this case this CLI must be unique.

;URL: A URL configured here is send with any call from this object as source URL. Only H.323 support sending a URL. Some called endpoints may make use of the URL. The URL is also available within the CDRs generated by the gateway.

;Max Calls: Limits the concurrent calls to this object. Any additional call is rejected with "No Channel Available"

;Group Indications: The group for which group indications are sent to the registered endpoints. The object must be active member in this group. The other objects (for which group indications are sent) need not to be active. To monitor other endpoints on a phone with a Partner/Pickup function key group indications are needed for the endpoints. The maximal length of the Group Indication Name in V7 is set to 48 characters.

;Hide Connected Endpoint: This check-mark hides the name and number of the connected endpoint if an object with this check-mark set is called. This applies for example if a call forwarding was configured or the object was a broadcast group. In these cases the connected endpoint is different from the called.

== License ==

For User and Executive objects licenses which shall be used for this user can be configured. The licensed features can only be used if they are checked on this page.

;UCC: includes App(phone), App(softphone), Video, AppSharing, Voicemail, Mobility, Fax, App(chat), App(connect), App(innovaphone-pbx-conferencing), App(innovaphone-assistant)
;UCC Upgrade from UC:
upgrade license from UC to UCC
;UCC Upgrade from Softphone:
upgrade license from Softphone to UCC
;UC: includes App(phone), App(softphone), Video, AppSharing, Voicemail, Mobility, Fax
;Voicemail:[[{{NAMESPACE}}:Concept_App_Service_Voicemail|Voicemail for this user]]
;Fax:[[{{NAMESPACE}}:Concept_App_Service_Fax|Personal Fax Application]], included in UC/UCC
;Mobility:[[{{NAMESPACE}}:Concept_App_RCC|Mobility device integration]], included in UC/UCC
;myPBX: myPBX client (outdated)
;Video: Video integrated within Phone and Softphone application, included in UC/UCC
;AppSharing: Application Sharing integrated within Phone and Softphone application, included in UC/UCC
;Reporting:[[{{NAMESPACE}}:Concept_App_Service_Reports|Reporting Application]], call lists do not require this license
;App(phone):[[{{NAMESPACE}}:Concept_App_PhoneApp|Phone Application]], included in UC/UCC
;App(softphone):[[{{NAMESPACE}}:Concept_App_SoftphoneApp|Softphone Application]], included in UC/UCC
;App(chat):[[{{NAMESPACE}}:Concept_Chat|Premium Chat application]] with message storage, included in UCC
;App(innovaphone-assistant):[[{{NAMESPACE}}:Concept_App_Service_myApps_Assistant|Assistant Application]], included in UCC
;App(innovaphone-working):[[{{NAMESPACE}}:Concept_App_Service_Working|Working Application]]
;App(innovaphone-switchboard):[[{{NAMESPACE}}:Concept_App_Service_Queues|Switchboard Application]]
;App(innovaphone-recorder):[[{{NAMESPACE}}:Concept_App_Service_Recordings|Voice Recording Application]]
;App(innovaphone-projects):[[{{NAMESPACE}}:Concept_App_Service_Projects|Projects Application]]
;App(innovaphone-pbx-conferencing):[[{{NAMESPACE}}:Concept_Conference|Conferencing Application]], included in UCC
;App(innovaphone-myphonekeys):[[{{NAMESPACE}}:Concept_App_myPhoneKeys|Desk Phone Control]]
;App(innovaphone-microsoft365):[[{{NAMESPACE}}:Concept_App_Service_Connector_for_Microsoft_365|Teams Connector]]
;App(innovaphone-kuando):[[{{NAMESPACE}}:Concept_App_Service_Connector_for_kuando%C2%AE|Kuando Connector]]
;App(innovaphone-connect):[[{{NAMESPACE}}:Concept_App_Connect|Connect Application]], included in UCC

== Devices ==
This section enables assignment and identification of multiple devices for the same user. Those devices may register and operate in parallel for this user.

=== Devices Input Fields ===
; Hardware Id: identifies the connected device to match the incoming registration. Can either be a MAC-address (for fixed phones) or a unique descriptor (for softphones/3rd-pty-terminals).
: Filled in automatically when phones are provisioned by UsersAdminApp or ProfileApp.
: If a hardware id identical to the object name is configured, the name or the number of the object can be used for registration. For registrations with name or number of the object, the settings configured at this device are used in this case.
; Name: can be used for a description of the device.
: On the SOAP/TAPI interface Name can be used to let the user select the device which shall be controlled.
: If no device is configured the Name and Hardware Id are used for default devices to ensure configuration compatibility.
: To allow an endpoint to register with the objects Name or Number, a device must be configured with a hardware id that is equal to the object Name. (E.g. Registrations from DECT Base Stations)
: A registration by number does not succeed if the length of the number does not match, other when dialing an object in which case additional dialed digits are ignored.
: If a registration by number does not match any object number, the number is converted to a name and a device hardware id is searched with this name.
; App: this field allows to configure a V13-App used to control this device. E.g. "phone" or "softphone" in lower letters.
: If a hardware ID is already present, this field is not set automatically during install and thus must be manually set.
: Name field should also be filled with an unambiguous description for use in myApps. Example :
: <table>
<tr>
<th>Hardware Id</th>
<th>Name</th>
<th>App</th>
</tr>
<tr>
<td>009033000000</td>
<td>myDeskphoneName</td>
<td>phone</td>
</tr>
<tr>
<td>exampleSoft</td>
<td>mySoftphoneName</td>
<td>softphone</td>
</tr>
:</table>

=== Devices Config Flags ===

;PBX Pwd: Registration with the PBX master password only

;No IP Filter: Don't apply IP Filters for registrations

;TLS only: Allow Registration with H.323/TLS only. If this check-mark is set a matching certificate, which is trusted by the PBX must be provided.

;No Mobility: If a registration on this device is active don't call a mobility number

;Config VOIP: Add additional config for VoIP. E.g. configure a WebRTC endpoint. Apply has to be pressed once and Name Field must be set to allow enable the additional input page with the "defined" name.
: If this checkmark is set and a '''Name''' is configured for the Device a new tab-sheet with the configured name is available to allow more VoIP Parameters to be configured.

;Reverse Proxy: Allow the device to register through a reverse proxy. The registration through a reverse proxy is identified by the IP addresses configured for reverse proxies

;Single Reg.: Allow a single registration to this device only

;Media Relay: Force Media Relay on the PBX for this device only.
: When this is enabled and the registration of the device is coming in via a reverse proxy server server-reflexive address (SRFLX) obtained via STUN is provided as default media address.
: This feature is used so that third party SIP phones not supporting ICE/DTLS can be used together with the innovaphone PBX as on-site phones as well as phones in home offices or phones in a cloud scenario.

;No SRTP: Do not offer SRTP in SIP/SDP when Media Relay is set at the Hardware ID

=== Security issues ===

There are security build in mechanisms :

* If the '''PBX Pwd''' (in older V9 builds AdminPwd) check-mark is set, registration to this device is only possible with the PBX password, which is configured in PBX/Config/Security.

* The check-mark '''No IP Filter''' allows the registration to the device even if the IP Filter does not match. This way general registration can be restricted using the IP Filters and some selected devices can be opened for registration from the public internet. A registration without password is not allowed in this case. (Available from v9 hf15)

* If this object will have no registration, leave the device field empty (for security reasons). Nobody can abuse and register at that object.

* If a registration request comes with the wrong password the object deny´s '''all''' registration requests (with the reason REGISTER-REJ : Reason=PBX missing Authentication) for 20 seconds. After that time it is possible to register (with the right password).

== Objects with empty node or PBX ==
If an object has no '''PBX''' configured, it will be replicated (if replication is turned on) to all slaves. Furthermore, any PBX will satisfy incoming registration requests. Calls to such objects that are built-in to the PBX and thus do not require a registration to work (e.g. Waiting Queue) will be processed by each PBX the call is presented to.

If an object has no '''Node''' configured, it will be considered to live in the node of each PBX the object is known to. So if an object has neither '''Node''' nor '''PBX''' configured, it will be present in all nodes that have a PBX and calls to such objects will be processed locally for objects that are built-in to the PBX.

Reference16r1:PBX/Objects

2026-05-07T09:34:32Z

Vsc: /* License */

This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criteria. New objects can be created and existing objects can be changed or deleted.

== Display of existing Objects ==
By pressing the show link, existing objects are displayed. With the filter field (the input field left to the show link) the displayed objects are limited to those matching the filter. The filter is first applied to the 'Long Name' of the objects meaning a non case sensitive head match of the filter and the 'Long Name' is performed. If there are matching objects these are displayed.

If there are no matching objects the filter is used to match the Number of the objects including any node prefixes. This way objects of a given node with all sub-nodes can be displayed by entering the prefix of a node here.

Below the filter input field is a list of all PBXs in the system (at least the part of the system which is replicated to this device). By clicking on a PBX in the list only the objects which are assigned to this PBX are displayed and the groups configured on this PBX are displayed as well. By clicking on a group only the members of this group are displayed.

=== List of Objects ===

On the right side the list of objects is displayed. The most important configuration properties are displayed in this list to provide an overview. To view the full configuration of a given object it must be opened for editing by clicking the Long Name. The list can be sorted by clicking the table headers.

The Number of the objects in this list is not the number configured in the object but it is expanded with the prefixes of the nodes in which the object is configured.

Group memberships and Call Forwarding for an object are changed by clicking on the 'Groups' or 'CF*' link of the object. A '*' appended to a group displayed in this list means that the active flag of this group membership is set.
A '!' appended to a group displayed in this list means that group indications are configured for this group.

Fork number appended by a '*' indicates a mobility enabled user. In case the number is displayed in grey, the user consumes no mobility license on local PBX (e.g. because the user registers on other PBX).

The last column are the IP addresses of registered endpoints for a given object. If the physical location of the endpoint is not the same as the PBX, the physical location is indicated by @<physical-location> added to the IP address. A '*' appended to this field means that this is an password authenticated registration.
Registrations which are because of a standby situation, which means they are not at the PBX for which they are configured, are marked with a special colour (by default this is red).

=== New Objects ===

New objects are created by selecting the type of object in the drop down list and clicking the new link. If the list of displayed objects is limited to a PBX/Group (see above), the PBX property of the new object is preset accordingly and the group membership is added to the object.

== Object Types ==

There are different types of objects for different purposes available

;[[{{NAMESPACE}}:PBX/Objects/User|User]]: A normal User
;[[{{NAMESPACE}}:PBX/Objects/ap|AP]]: Used to enable pbx connection to Application Platform
;[[{{NAMESPACE}}:PBX/Objects/App|App]]: Create a reference to an innovaphone App that can be used in myApps
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast Conference|BC Conference]]: A Conference which automatically calls other users
;[[{{NAMESPACE}}:PBX/Objects/Boolean|Boolean]]: Used to enable Call Forwards an other things based on time/date or by calling to this object
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast|Call Broadcast]]: Forward a call to a group
;[[{{NAMESPACE}}:PBX/Objects/Conference|Conference]]: Used to create a conference
;[[{{NAMESPACE}}:PBX/Objects/Config Template|Config Template]]: Config which can be applied to other objects
;[[{{NAMESPACE}}:PBX/Objects/DECT System|DECT System]]: Defines a DECT system
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Directory Search]]: LDAP lookup based on number dialed
;[[{{NAMESPACE}}:PBX/Objects/DTMF Features|DTMF Features]]: Feature control for simple endpoints
;[[{{NAMESPACE}}:PBX/Objects/Executive|Executive]]: Executive in a executive/secretary configuration
;[[{{NAMESPACE}}:PBX/Objects/External UC|External UC]]: To forward presence subscriptions to external presence server
;[[{{NAMESPACE}}:PBX/Objects/Fax|Fax]]: Defines a fax service
;[[{{NAMESPACE}}:PBX/Objects/Gateway|Gateway]]: For registration of gateways
;[[{{NAMESPACE}}:PBX/Objects/ICP|ICP]]: Integration with ICP system
;[[{{NAMESPACE}}:PBX/Objects/MCast Announce|MCast Announce]]: Calls endpoints and forwards media as IP multicast
;[[{{NAMESPACE}}:PBX/Objects/Message Waiting|Message Waiting]]: Message Waiting for external Systems
;[[{{NAMESPACE}}:PBX/Objects/Messages|Messages]]: used to connect messaging service
;[[{{NAMESPACE}}:PBX/Objects/Mobility|Mobility]]: Mobile Integration
;[[{{NAMESPACE}}:PBX/Objects/Node|Node]]: Numbering Node
;[[{{NAMESPACE}}:PBX/Objects/Number Map|Number Map]]: Maps to other number
;[[{{NAMESPACE}}:PBX/Objects/PBX|PBX]]: To register slave PBX
;[[{{NAMESPACE}}:PBX/Objects/Push|Push]]: Defines a push service
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Quick Dial]]: Allows Quickdial based on external LDAP Directory
;[[{{NAMESPACE}}:PBX/Objects/Session Border|Session Border]]: Allows proxy registrations to other PBX
;[[{{NAMESPACE}}:PBX/Objects/Settings|Settings]]: control dynamic group memberships via myPBX client
;[[{{NAMESPACE}}:PBX/Objects/Trunk Line|Trunk Line]]: To register a trunk line
;[[{{NAMESPACE}}:PBX/Objects/Voicemail|Voicemail]]: Defines a voicemail service
;[[{{NAMESPACE}}:PBX/Objects/Waiting Queue|Waiting Queue]]: Define a waiting queue

== General Object Properties ==

Some configuration properties are specific to the type of object, some are common to all objects. Not each object type supports all general configuration properties.

;Description: Any text which can be used to describe the objects. Nothing is done with this text on the PBX.

;Hide from LDAP: When this check-mark is set, this object is available with a read-only LDAP access, which means it does not show up in the PBX phonebook on the phones.

;New Account: This checkmark can be set, adding a new User Object after deleting a User Object with the same Name, to that this is a new user and old information should not be reconnected to this user. Without this checkmark set, the name is used to connect the new User Object to the old information. This is mainly useful for information stored in Apps. Not every App does support this feature altready. It is supported by Connect and Chat, so when adding a user the setting of this checkmark means, that this is a new user and the old messages in Chat or Connect from a user with the same name are not visible for this user anymore.

;Long Name: This name is used to identify the object in the database and for display purposes. The long name must be unique throughout the system. For practical reasons, you should limit it to ''20 - extension length'' characters.

;Name
:The name of the object. This name is used for H.323 and SIP signalling (like a call number) and must be unique throughout the system.
:In order for the name to be handled correctly in all protocols, a few rules should be followed regarding the characters used.
:# The name must not start with a "." dot (See [[{{NAMESPACE}}:Concept Group Pickup across PBXs|Concept Group Pickup across PBXs]] for more details on using a dot.)
:# The character "@" must not be used (It is used as separator for E-Mail-Adresses)
:# The character "?" is a specially reserved character to append arguments, which can be used when a call is sent. (See [[{{NAMESPACE}}:PBX/Objects/Trunk_Line| Name as Number]] for more details on using a ?-sign.)
:# It is best to use only characters that are also used in e-mail addresses (before the @ sign). So "a-z0-9-_" in lower case letters.

:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.
:Note: it is recommended to use the ''Name'' field for the e-mail address (everything prior the @) in combination with the ''Use as Domain'' flag at the ''System Name''.
:If the 'Name' is to be used as E-Mail address, the Check-mark on the ''E-Mail'' line besides the ''Name'' which is displayed there as well has to be set as well.

;Number
:The telephone number of the object. This is the number by which this object can be dialed within the same node. Which means it does not include any Node prefixes.
:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.

;E-Mail: Additional E-Mail addresses for the user. Multiple addresses are separated by ';'. The 'Name' is used as E-Mail address as well together with the 'System Name' as domain. The E-Mail addresses are used to match users from other applications (e.g. Exchange, Fax Server) to PBX User Objects. The first E-Mail address is used as destination if E-Mails are to be sent to the User (e.g. received Fax). If the 'Name' shall be used as E-Mail destination, the check-mark besides the 'Name', which is duplicated to the E-Mail line should be set.

;Critical: If marked as critical the object can only be changed by administrators allowed to edit critical objects

;Password / Retype Password: If a registration password is allocated here, then it must be specified during registration, or otherwise the registration will fail. The length of the password is limited to 23 characters ASCII. Be aware when using Unicode characters like ü,ä,ö,ï,ë,é,ă,î,â,ș,ț,Ă,Î,Â,Ș,Ț,ă,î, due to the conversion from Unicode to ASCII the amount of available characters in your password will be decreased. You can use an online Unicode to ASCII converter to check if the password length is not exceeded.

;Node: The node that the object is assigned to. A Node hierarchy can be configured using Node Objects. Objects which are assigned to the same node can call each other with just the number. To call an object in a different node escapes and node prefixes have to be used. If no node is configured, the object is assigned to the node of the respective local PBX.

;PBX: The PBX that the object is assigned to. This PBX accepts registrations for the object. If no PBX is configured, the object is assigned to the respective local PBX.

;Reject ext. Calls: Calls from external sources to this object are rejected.

;Local: Marks an object as local. Local means that it can be called from endpoints physically located at the same PBX without prefixes even if the calling endpoint is in a different node. Where the endpoint is physical located is defined by the PBX the endpoint contacts first (it may be redirected to another PBX then for registration). If the object does not have a PBX configured the call is routed to the PBX where the calling endpoint is registered.
:''Note: Phones using this mechanism should use a Gatekeeper Identifier of <local-pbx>@<System Name> for registration. This way this mechanism works even if the registration happens without redirection. This can be the case if a secondary address is configured in case the local PBX is down. The registration will then be done without redirection an is not renewed when the local PBX comes up again.''

;Send Number: If an object does a call, the calling party number for this call will be replaced by the number given (if any). Used to hide an extension. If a prefix of '.' is configured, this number is interpreted as a number within the node of the object, if no prefix is configured the number is interpreted as a number within the root node.

;External: This is used together with the ''Name as Number'' Feature of a trunk object. If a ''Name as Number'' configuration is set, starting with '?' it is matched to this entry. If only '?' is configured it always matches. Any digit following the matching part is sent as CLI for calls out through the trunk object.

;Dial In: If this check-mark is set, the external CLI which is sent out on the trunk, can also be used to dial in from the trunk. In this case this CLI must be unique.

;URL: A URL configured here is send with any call from this object as source URL. Only H.323 support sending a URL. Some called endpoints may make use of the URL. The URL is also available within the CDRs generated by the gateway.

;Max Calls: Limits the concurrent calls to this object. Any additional call is rejected with "No Channel Available"

;Group Indications: The group for which group indications are sent to the registered endpoints. The object must be active member in this group. The other objects (for which group indications are sent) need not to be active. To monitor other endpoints on a phone with a Partner/Pickup function key group indications are needed for the endpoints. The maximal length of the Group Indication Name in V7 is set to 48 characters.

;Hide Connected Endpoint: This check-mark hides the name and number of the connected endpoint if an object with this check-mark set is called. This applies for example if a call forwarding was configured or the object was a broadcast group. In these cases the connected endpoint is different from the called.

== License ==

For User and Executive objects licenses which shall be used for this user can be configured. The licensed features can only be used if they are checked on this page.

;UCC: includes App(phone), App(softphone), Video, AppSharing, Voicemail, Mobility, Fax, App(chat), App(connect), App(innovaphone-pbx-conferencing), App(innovaphone-assistant)
;UCC: Upgrade from UC
;UCC: Upgrade from Softphone
;UC: includes App(phone), App(softphone), Video, AppSharing, Voicemail, Mobility, Fax
;Voicemail:[[{{NAMESPACE}}:Concept_App_Service_Voicemail|Voicemail for this user]]
;Fax:[[{{NAMESPACE}}:Concept_App_Service_Fax|Personal Fax Application]], included in UC/UCC
;Mobility:[[{{NAMESPACE}}:Concept_App_RCC|Mobility device integration]], included in UC/UCC
;myPBX: myPBX client (outdated)
;Video: Video integrated within Phone and Softphone application, included in UC/UCC
;AppSharing: Application Sharing integrated within Phone and Softphone application, included in UC/UCC
;Reporting:[[{{NAMESPACE}}:Concept_App_Service_Reports|Reporting Application]], call lists do not require this license
;App(phone):[[{{NAMESPACE}}:Concept_App_PhoneApp|Phone Application]], included in UC/UCC
;App(softphone):[[{{NAMESPACE}}:Concept_App_SoftphoneApp|Softphone Application]], included in UC/UCC
;App(chat):[[{{NAMESPACE}}:Concept_Chat|Premium Chat application]] with message storage, included in UCC
;App(innovaphone-assistant):[[{{NAMESPACE}}:Concept_App_Service_myApps_Assistant|Assistant Application]], included in UCC
;App(innovaphone-working):[[{{NAMESPACE}}:Concept_App_Service_Working|Working Application]]
;App(innovaphone-switchboard):[[{{NAMESPACE}}:Concept_App_Service_Queues|Switchboard Application]]
;App(innovaphone-recorder):[[{{NAMESPACE}}:Concept_App_Service_Recordings|Voice Recording Application]]
;App(innovaphone-projects):[[{{NAMESPACE}}:Concept_App_Service_Projects|Projects Application]]
;App(innovaphone-pbx-conferencing):[[{{NAMESPACE}}:Concept_Conference|Conferencing Application]], included in UCC
;App(innovaphone-myphonekeys):[[{{NAMESPACE}}:Concept_App_myPhoneKeys|Desk Phone Control]]
;App(innovaphone-microsoft365):[[{{NAMESPACE}}:Concept_App_Service_Connector_for_Microsoft_365|Teams Connector]]
;App(innovaphone-kuando):[[{{NAMESPACE}}:Concept_App_Service_Connector_for_kuando%C2%AE|Kuando Connector]]
;App(innovaphone-connect):[[{{NAMESPACE}}:Concept_App_Connect|Connect Application]], included in UCC

== Devices ==
This section enables assignment and identification of multiple devices for the same user. Those devices may register and operate in parallel for this user.

=== Devices Input Fields ===
; Hardware Id: identifies the connected device to match the incoming registration. Can either be a MAC-address (for fixed phones) or a unique descriptor (for softphones/3rd-pty-terminals).
: Filled in automatically when phones are provisioned by UsersAdminApp or ProfileApp.
: If a hardware id identical to the object name is configured, the name or the number of the object can be used for registration. For registrations with name or number of the object, the settings configured at this device are used in this case.
; Name: can be used for a description of the device.
: On the SOAP/TAPI interface Name can be used to let the user select the device which shall be controlled.
: If no device is configured the Name and Hardware Id are used for default devices to ensure configuration compatibility.
: To allow an endpoint to register with the objects Name or Number, a device must be configured with a hardware id that is equal to the object Name. (E.g. Registrations from DECT Base Stations)
: A registration by number does not succeed if the length of the number does not match, other when dialing an object in which case additional dialed digits are ignored.
: If a registration by number does not match any object number, the number is converted to a name and a device hardware id is searched with this name.
; App: this field allows to configure a V13-App used to control this device. E.g. "phone" or "softphone" in lower letters.
: If a hardware ID is already present, this field is not set automatically during install and thus must be manually set.
: Name field should also be filled with an unambiguous description for use in myApps. Example :
: <table>
<tr>
<th>Hardware Id</th>
<th>Name</th>
<th>App</th>
</tr>
<tr>
<td>009033000000</td>
<td>myDeskphoneName</td>
<td>phone</td>
</tr>
<tr>
<td>exampleSoft</td>
<td>mySoftphoneName</td>
<td>softphone</td>
</tr>
:</table>

=== Devices Config Flags ===

;PBX Pwd: Registration with the PBX master password only

;No IP Filter: Don't apply IP Filters for registrations

;TLS only: Allow Registration with H.323/TLS only. If this check-mark is set a matching certificate, which is trusted by the PBX must be provided.

;No Mobility: If a registration on this device is active don't call a mobility number

;Config VOIP: Add additional config for VoIP. E.g. configure a WebRTC endpoint. Apply has to be pressed once and Name Field must be set to allow enable the additional input page with the "defined" name.
: If this checkmark is set and a '''Name''' is configured for the Device a new tab-sheet with the configured name is available to allow more VoIP Parameters to be configured.

;Reverse Proxy: Allow the device to register through a reverse proxy. The registration through a reverse proxy is identified by the IP addresses configured for reverse proxies

;Single Reg.: Allow a single registration to this device only

;Media Relay: Force Media Relay on the PBX for this device only.
: When this is enabled and the registration of the device is coming in via a reverse proxy server server-reflexive address (SRFLX) obtained via STUN is provided as default media address.
: This feature is used so that third party SIP phones not supporting ICE/DTLS can be used together with the innovaphone PBX as on-site phones as well as phones in home offices or phones in a cloud scenario.

;No SRTP: Do not offer SRTP in SIP/SDP when Media Relay is set at the Hardware ID

=== Security issues ===

There are security build in mechanisms :

* If the '''PBX Pwd''' (in older V9 builds AdminPwd) check-mark is set, registration to this device is only possible with the PBX password, which is configured in PBX/Config/Security.

* The check-mark '''No IP Filter''' allows the registration to the device even if the IP Filter does not match. This way general registration can be restricted using the IP Filters and some selected devices can be opened for registration from the public internet. A registration without password is not allowed in this case. (Available from v9 hf15)

* If this object will have no registration, leave the device field empty (for security reasons). Nobody can abuse and register at that object.

* If a registration request comes with the wrong password the object deny´s '''all''' registration requests (with the reason REGISTER-REJ : Reason=PBX missing Authentication) for 20 seconds. After that time it is possible to register (with the right password).

== Objects with empty node or PBX ==
If an object has no '''PBX''' configured, it will be replicated (if replication is turned on) to all slaves. Furthermore, any PBX will satisfy incoming registration requests. Calls to such objects that are built-in to the PBX and thus do not require a registration to work (e.g. Waiting Queue) will be processed by each PBX the call is presented to.

If an object has no '''Node''' configured, it will be considered to live in the node of each PBX the object is known to. So if an object has neither '''Node''' nor '''PBX''' configured, it will be present in all nodes that have a PBX and calls to such objects will be processed locally for objects that are built-in to the PBX.

Reference16r1:PBX/Objects

2026-05-07T09:29:55Z

Vsc: Created page with "This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criteria. New objects can be created and existing objects can be changed or deleted. == Display of existing Objects == By pressing the show link, existing objects are displayed. With the filter field (the input field left to the show link) the displayed objects are limited to those matching the filter. The filter is first applied to the 'Lo..."

This page is used for the administration of PBX objects. A list of already configured objects can be displayed filtered by various criteria. New objects can be created and existing objects can be changed or deleted.

== Display of existing Objects ==
By pressing the show link, existing objects are displayed. With the filter field (the input field left to the show link) the displayed objects are limited to those matching the filter. The filter is first applied to the 'Long Name' of the objects meaning a non case sensitive head match of the filter and the 'Long Name' is performed. If there are matching objects these are displayed.

If there are no matching objects the filter is used to match the Number of the objects including any node prefixes. This way objects of a given node with all sub-nodes can be displayed by entering the prefix of a node here.

Below the filter input field is a list of all PBXs in the system (at least the part of the system which is replicated to this device). By clicking on a PBX in the list only the objects which are assigned to this PBX are displayed and the groups configured on this PBX are displayed as well. By clicking on a group only the members of this group are displayed.

=== List of Objects ===

On the right side the list of objects is displayed. The most important configuration properties are displayed in this list to provide an overview. To view the full configuration of a given object it must be opened for editing by clicking the Long Name. The list can be sorted by clicking the table headers.

The Number of the objects in this list is not the number configured in the object but it is expanded with the prefixes of the nodes in which the object is configured.

Group memberships and Call Forwarding for an object are changed by clicking on the 'Groups' or 'CF*' link of the object. A '*' appended to a group displayed in this list means that the active flag of this group membership is set.
A '!' appended to a group displayed in this list means that group indications are configured for this group.

Fork number appended by a '*' indicates a mobility enabled user. In case the number is displayed in grey, the user consumes no mobility license on local PBX (e.g. because the user registers on other PBX).

The last column are the IP addresses of registered endpoints for a given object. If the physical location of the endpoint is not the same as the PBX, the physical location is indicated by @<physical-location> added to the IP address. A '*' appended to this field means that this is an password authenticated registration.
Registrations which are because of a standby situation, which means they are not at the PBX for which they are configured, are marked with a special colour (by default this is red).

=== New Objects ===

New objects are created by selecting the type of object in the drop down list and clicking the new link. If the list of displayed objects is limited to a PBX/Group (see above), the PBX property of the new object is preset accordingly and the group membership is added to the object.

== Object Types ==

There are different types of objects for different purposes available

;[[{{NAMESPACE}}:PBX/Objects/User|User]]: A normal User
;[[{{NAMESPACE}}:PBX/Objects/ap|AP]]: Used to enable pbx connection to Application Platform
;[[{{NAMESPACE}}:PBX/Objects/App|App]]: Create a reference to an innovaphone App that can be used in myApps
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast Conference|BC Conference]]: A Conference which automatically calls other users
;[[{{NAMESPACE}}:PBX/Objects/Boolean|Boolean]]: Used to enable Call Forwards an other things based on time/date or by calling to this object
;[[{{NAMESPACE}}:PBX/Objects/Call Broadcast|Call Broadcast]]: Forward a call to a group
;[[{{NAMESPACE}}:PBX/Objects/Conference|Conference]]: Used to create a conference
;[[{{NAMESPACE}}:PBX/Objects/Config Template|Config Template]]: Config which can be applied to other objects
;[[{{NAMESPACE}}:PBX/Objects/DECT System|DECT System]]: Defines a DECT system
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Directory Search]]: LDAP lookup based on number dialed
;[[{{NAMESPACE}}:PBX/Objects/DTMF Features|DTMF Features]]: Feature control for simple endpoints
;[[{{NAMESPACE}}:PBX/Objects/Executive|Executive]]: Executive in a executive/secretary configuration
;[[{{NAMESPACE}}:PBX/Objects/External UC|External UC]]: To forward presence subscriptions to external presence server
;[[{{NAMESPACE}}:PBX/Objects/Fax|Fax]]: Defines a fax service
;[[{{NAMESPACE}}:PBX/Objects/Gateway|Gateway]]: For registration of gateways
;[[{{NAMESPACE}}:PBX/Objects/ICP|ICP]]: Integration with ICP system
;[[{{NAMESPACE}}:PBX/Objects/MCast Announce|MCast Announce]]: Calls endpoints and forwards media as IP multicast
;[[{{NAMESPACE}}:PBX/Objects/Message Waiting|Message Waiting]]: Message Waiting for external Systems
;[[{{NAMESPACE}}:PBX/Objects/Messages|Messages]]: used to connect messaging service
;[[{{NAMESPACE}}:PBX/Objects/Mobility|Mobility]]: Mobile Integration
;[[{{NAMESPACE}}:PBX/Objects/Node|Node]]: Numbering Node
;[[{{NAMESPACE}}:PBX/Objects/Number Map|Number Map]]: Maps to other number
;[[{{NAMESPACE}}:PBX/Objects/PBX|PBX]]: To register slave PBX
;[[{{NAMESPACE}}:PBX/Objects/Push|Push]]: Defines a push service
;[[{{NAMESPACE}}:PBX/Objects/Directory Search|Quick Dial]]: Allows Quickdial based on external LDAP Directory
;[[{{NAMESPACE}}:PBX/Objects/Session Border|Session Border]]: Allows proxy registrations to other PBX
;[[{{NAMESPACE}}:PBX/Objects/Settings|Settings]]: control dynamic group memberships via myPBX client
;[[{{NAMESPACE}}:PBX/Objects/Trunk Line|Trunk Line]]: To register a trunk line
;[[{{NAMESPACE}}:PBX/Objects/Voicemail|Voicemail]]: Defines a voicemail service
;[[{{NAMESPACE}}:PBX/Objects/Waiting Queue|Waiting Queue]]: Define a waiting queue

== General Object Properties ==

Some configuration properties are specific to the type of object, some are common to all objects. Not each object type supports all general configuration properties.

;Description: Any text which can be used to describe the objects. Nothing is done with this text on the PBX.

;Hide from LDAP: When this check-mark is set, this object is available with a read-only LDAP access, which means it does not show up in the PBX phonebook on the phones.

;New Account: This checkmark can be set, adding a new User Object after deleting a User Object with the same Name, to that this is a new user and old information should not be reconnected to this user. Without this checkmark set, the name is used to connect the new User Object to the old information. This is mainly useful for information stored in Apps. Not every App does support this feature altready. It is supported by Connect and Chat, so when adding a user the setting of this checkmark means, that this is a new user and the old messages in Chat or Connect from a user with the same name are not visible for this user anymore.

;Long Name: This name is used to identify the object in the database and for display purposes. The long name must be unique throughout the system. For practical reasons, you should limit it to ''20 - extension length'' characters.

;Name
:The name of the object. This name is used for H.323 and SIP signalling (like a call number) and must be unique throughout the system.
:In order for the name to be handled correctly in all protocols, a few rules should be followed regarding the characters used.
:# The name must not start with a "." dot (See [[{{NAMESPACE}}:Concept Group Pickup across PBXs|Concept Group Pickup across PBXs]] for more details on using a dot.)
:# The character "@" must not be used (It is used as separator for E-Mail-Adresses)
:# The character "?" is a specially reserved character to append arguments, which can be used when a call is sent. (See [[{{NAMESPACE}}:PBX/Objects/Trunk_Line| Name as Number]] for more details on using a ?-sign.)
:# It is best to use only characters that are also used in e-mail addresses (before the @ sign). So "a-z0-9-_" in lower case letters.

:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.
:Note: it is recommended to use the ''Name'' field for the e-mail address (everything prior the @) in combination with the ''Use as Domain'' flag at the ''System Name''.
:If the 'Name' is to be used as E-Mail address, the Check-mark on the ''E-Mail'' line besides the ''Name'' which is displayed there as well has to be set as well.

;Number
:The telephone number of the object. This is the number by which this object can be dialed within the same node. Which means it does not include any Node prefixes.
:Note: Clients ''cannot'' use the ''Name'' and ''Number'' property as registration name without adding the ''name'' as hardware-id.

;E-Mail: Additional E-Mail addresses for the user. Multiple addresses are separated by ';'. The 'Name' is used as E-Mail address as well together with the 'System Name' as domain. The E-Mail addresses are used to match users from other applications (e.g. Exchange, Fax Server) to PBX User Objects. The first E-Mail address is used as destination if E-Mails are to be sent to the User (e.g. received Fax). If the 'Name' shall be used as E-Mail destination, the check-mark besides the 'Name', which is duplicated to the E-Mail line should be set.

;Critical: If marked as critical the object can only be changed by administrators allowed to edit critical objects

;Password / Retype Password: If a registration password is allocated here, then it must be specified during registration, or otherwise the registration will fail. The length of the password is limited to 23 characters ASCII. Be aware when using Unicode characters like ü,ä,ö,ï,ë,é,ă,î,â,ș,ț,Ă,Î,Â,Ș,Ț,ă,î, due to the conversion from Unicode to ASCII the amount of available characters in your password will be decreased. You can use an online Unicode to ASCII converter to check if the password length is not exceeded.

;Node: The node that the object is assigned to. A Node hierarchy can be configured using Node Objects. Objects which are assigned to the same node can call each other with just the number. To call an object in a different node escapes and node prefixes have to be used. If no node is configured, the object is assigned to the node of the respective local PBX.

;PBX: The PBX that the object is assigned to. This PBX accepts registrations for the object. If no PBX is configured, the object is assigned to the respective local PBX.

;Reject ext. Calls: Calls from external sources to this object are rejected.

;Local: Marks an object as local. Local means that it can be called from endpoints physically located at the same PBX without prefixes even if the calling endpoint is in a different node. Where the endpoint is physical located is defined by the PBX the endpoint contacts first (it may be redirected to another PBX then for registration). If the object does not have a PBX configured the call is routed to the PBX where the calling endpoint is registered.
:''Note: Phones using this mechanism should use a Gatekeeper Identifier of <local-pbx>@<System Name> for registration. This way this mechanism works even if the registration happens without redirection. This can be the case if a secondary address is configured in case the local PBX is down. The registration will then be done without redirection an is not renewed when the local PBX comes up again.''

;Send Number: If an object does a call, the calling party number for this call will be replaced by the number given (if any). Used to hide an extension. If a prefix of '.' is configured, this number is interpreted as a number within the node of the object, if no prefix is configured the number is interpreted as a number within the root node.

;External: This is used together with the ''Name as Number'' Feature of a trunk object. If a ''Name as Number'' configuration is set, starting with '?' it is matched to this entry. If only '?' is configured it always matches. Any digit following the matching part is sent as CLI for calls out through the trunk object.

;Dial In: If this check-mark is set, the external CLI which is sent out on the trunk, can also be used to dial in from the trunk. In this case this CLI must be unique.

;URL: A URL configured here is send with any call from this object as source URL. Only H.323 support sending a URL. Some called endpoints may make use of the URL. The URL is also available within the CDRs generated by the gateway.

;Max Calls: Limits the concurrent calls to this object. Any additional call is rejected with "No Channel Available"

;Group Indications: The group for which group indications are sent to the registered endpoints. The object must be active member in this group. The other objects (for which group indications are sent) need not to be active. To monitor other endpoints on a phone with a Partner/Pickup function key group indications are needed for the endpoints. The maximal length of the Group Indication Name in V7 is set to 48 characters.

;Hide Connected Endpoint: This check-mark hides the name and number of the connected endpoint if an object with this check-mark set is called. This applies for example if a call forwarding was configured or the object was a broadcast group. In these cases the connected endpoint is different from the called.

== License ==

For User and Executive objects licenses which shall be used for this user can be configured. The licensed features can only be used if they are checked on this page.

;UCC: includes App(phone), App(softphone), Video, AppSharing, Voicemail, Mobility, Fax, App(chat), App(connect), App(innovaphone-pbx-conferencing), App(innovaphone-assistant)
;UCC: Upgrade from UC
;UCC: Upgrade from Softphone
;UC: includes App(phone), App(softphone), Video, AppSharing, Voicemail, Mobility, Fax
;Voicemail:[[{{NAMESPACE}}:Concept_App_Service_Voicemail|Voicemail for this user]]
;Fax:[[{{NAMESPACE}}:Concept_App_Service_Fax|Personal Fax Application]], included in UC/UCC
;Mobility: Mobility integration
;myPBX: myPBX client (outdated)
;Video: Video integrated within Phone and Softphone application, included in UC/UCC
;AppSharing: Application Sharing integrated within Phone and Softphone application, included in UC/UCC
;Reporting:[[{{NAMESPACE}}:Concept_App_Service_Reports|Reporting Application]], call lists do not require this license
;App(phone):[[{{NAMESPACE}}:Concept_App_PhoneApp|Phone Application]], included in UC/UCC
;App(softphone):[[{{NAMESPACE}}:Concept_App_SoftphoneApp|Softphone Application]], included in UC/UCC
;App(chat):[[{{NAMESPACE}}:Concept_Chat|Premium Chat application]] with message storage, included in UCC
;App(innovaphone-assistant):[[{{NAMESPACE}}:Concept_App_Service_myApps_Assistant|Assistant Application]], included in UCC
;App(innovaphone-working):[[{{NAMESPACE}}:Concept_App_Service_Working|Working Application]]
;App(innovaphone-assistantui):
;App(innovaphone-switchboard):[[{{NAMESPACE}}:Concept_App_Service_Queues|Switchboard Application]]
;App(innovaphone-recorder):[[{{NAMESPACE}}:Concept_App_Service_Recordings|Voice Recording Application]]
;App(innovaphone-projects):[[{{NAMESPACE}}:Concept_App_Service_Projects|Projects Application]]
;App(innovaphone-pbx-conferencing):[[{{NAMESPACE}}:Concept_Conference|Conferencing Application]], included in UCC
;App(innovaphone-myphonekeys):[[{{NAMESPACE}}:Concept_App_myPhoneKeys|Desk Phone Control]]
;App(innovaphone-microsoft365):[[{{NAMESPACE}}:Concept_App_Service_Connector_for_Microsoft_365|MS365 Connector]]
;App(innovaphone-kuando):[[{{NAMESPACE}}:Concept_App_Service_Connector_for_kuando%C2%AE|Kuando Connector]]
;App(innovaphone-connect):[[{{NAMESPACE}}:Concept_App_Connect|Connect Application]], included in UCC

== Devices ==
This section enables assignment and identification of multiple devices for the same user. Those devices may register and operate in parallel for this user.

=== Devices Input Fields ===
; Hardware Id: identifies the connected device to match the incoming registration. Can either be a MAC-address (for fixed phones) or a unique descriptor (for softphones/3rd-pty-terminals).
: Filled in automatically when phones are provisioned by UsersAdminApp or ProfileApp.
: If a hardware id identical to the object name is configured, the name or the number of the object can be used for registration. For registrations with name or number of the object, the settings configured at this device are used in this case.
; Name: can be used for a description of the device.
: On the SOAP/TAPI interface Name can be used to let the user select the device which shall be controlled.
: If no device is configured the Name and Hardware Id are used for default devices to ensure configuration compatibility.
: To allow an endpoint to register with the objects Name or Number, a device must be configured with a hardware id that is equal to the object Name. (E.g. Registrations from DECT Base Stations)
: A registration by number does not succeed if the length of the number does not match, other when dialing an object in which case additional dialed digits are ignored.
: If a registration by number does not match any object number, the number is converted to a name and a device hardware id is searched with this name.
; App: this field allows to configure a V13-App used to control this device. E.g. "phone" or "softphone" in lower letters.
: If a hardware ID is already present, this field is not set automatically during install and thus must be manually set.
: Name field should also be filled with an unambiguous description for use in myApps. Example :
: <table>
<tr>
<th>Hardware Id</th>
<th>Name</th>
<th>App</th>
</tr>
<tr>
<td>009033000000</td>
<td>myDeskphoneName</td>
<td>phone</td>
</tr>
<tr>
<td>exampleSoft</td>
<td>mySoftphoneName</td>
<td>softphone</td>
</tr>
:</table>

=== Devices Config Flags ===

;PBX Pwd: Registration with the PBX master password only

;No IP Filter: Don't apply IP Filters for registrations

;TLS only: Allow Registration with H.323/TLS only. If this check-mark is set a matching certificate, which is trusted by the PBX must be provided.

;No Mobility: If a registration on this device is active don't call a mobility number

;Config VOIP: Add additional config for VoIP. E.g. configure a WebRTC endpoint. Apply has to be pressed once and Name Field must be set to allow enable the additional input page with the "defined" name.
: If this checkmark is set and a '''Name''' is configured for the Device a new tab-sheet with the configured name is available to allow more VoIP Parameters to be configured.

;Reverse Proxy: Allow the device to register through a reverse proxy. The registration through a reverse proxy is identified by the IP addresses configured for reverse proxies

;Single Reg.: Allow a single registration to this device only

;Media Relay: Force Media Relay on the PBX for this device only.
: When this is enabled and the registration of the device is coming in via a reverse proxy server server-reflexive address (SRFLX) obtained via STUN is provided as default media address.
: This feature is used so that third party SIP phones not supporting ICE/DTLS can be used together with the innovaphone PBX as on-site phones as well as phones in home offices or phones in a cloud scenario.

;No SRTP: Do not offer SRTP in SIP/SDP when Media Relay is set at the Hardware ID

=== Security issues ===

There are security build in mechanisms :

* If the '''PBX Pwd''' (in older V9 builds AdminPwd) check-mark is set, registration to this device is only possible with the PBX password, which is configured in PBX/Config/Security.

* The check-mark '''No IP Filter''' allows the registration to the device even if the IP Filter does not match. This way general registration can be restricted using the IP Filters and some selected devices can be opened for registration from the public internet. A registration without password is not allowed in this case. (Available from v9 hf15)

* If this object will have no registration, leave the device field empty (for security reasons). Nobody can abuse and register at that object.

* If a registration request comes with the wrong password the object deny´s '''all''' registration requests (with the reason REGISTER-REJ : Reason=PBX missing Authentication) for 20 seconds. After that time it is possible to register (with the right password).

== Objects with empty node or PBX ==
If an object has no '''PBX''' configured, it will be replicated (if replication is turned on) to all slaves. Furthermore, any PBX will satisfy incoming registration requests. Calls to such objects that are built-in to the PBX and thus do not require a registration to work (e.g. Waiting Queue) will be processed by each PBX the call is presented to.

If an object has no '''Node''' configured, it will be considered to live in the node of each PBX the object is known to. So if an object has neither '''Node''' nor '''PBX''' configured, it will be present in all nodes that have a PBX and calls to such objects will be processed locally for objects that are built-in to the PBX.

Technische gegevens IP270

2026-05-06T10:31:17Z

Vsc: Created page with "{{datasheet_header|innovaphone IP270| De myApps telefoon}} <div class="datasheets-mehrspaltig"> Image:IP270.png ===Firmware=== Compatibel met versie 16r1final of hoger ===Behuizing=== 7-inch touchscreen, 1280 x 800 pixels Telefoontoetsenbord en alfanumeriek toetsenbord op het scherm LED-indicator 9 functietoetsen voor volumeregeling, opnieuw bellen, dempen en bediening van headset/luidspreker Verstelbare standaard in vier standen Afmetingen met standaard voetst..."

{{datasheet_header|innovaphone IP270| De myApps telefoon}}
<div class="datasheets-mehrspaltig">
[[Image:IP270.png]]
===Firmware===
Compatibel met versie 16r1final of hoger

===Behuizing===
7-inch touchscreen, 1280 x 800 pixels

Telefoontoetsenbord en alfanumeriek toetsenbord op het scherm

LED-indicator

9 functietoetsen voor volumeregeling, opnieuw bellen, dempen en bediening van headset/luidspreker

Verstelbare standaard in vier standen

Afmetingen met standaard voetsteun: 260 x 200 x 160 mm

Gewicht: ± 1000 g inclusief standaard voetsteun
===Interfaces===
1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) met “Power over Ethernet” volgens IEEE 802.3af en Energy Efficient Ethernet volgens IEEE 802.3az

1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) voor pc-aansluiting

2 x USB 2.0 Type-A-poorten aan de achterzijde

2 x USB 2.0 Type-C-poorten aan de achterzijde

1 x USB 2.0 Type-C-poort aan de achterzijde voor externe voeding

1 x USB 2.0 Type-C-poort aan de voorzijde
===Hardware===
Voeding: Power over Ethernet volgens IEEE 802.3af, Klasse 3 of externe USB-C-voedingsadapter 20V, 6W max. 2A

2 GB LPDDR4 RAM, 8 GB eMMC Flash

Bedrijfstemperatuur: 0 °C tot +45 °C

Opslagtemperatuur: -10 °C tot +70 °C

Luchtvochtigheid: 10% tot 90% (niet-condenserend)

Energiebesparende modus met automatische schermdimming

Dubbele microfoons, handsfree en open luisteren
===Netwerk===
Ondersteuning voor IPv4/IPv6

SRTP (SDES, DTLS 1.2)ICE

STUN, TURN via UDP/TCP

Ondersteuning voor DHCP

Ondersteuning voor NTP
===Beheer===
* Gecentraliseerd beheer via myApps-apparaten voor configuratiewijzigingen en firmware-updates
* Aanmaken van tracebestanden en weergave van het statuslogboek
===Communicatie===
Geïntegreerde myApps Linux-client
* Tweefactorauthenticatie, schermvergrendeling
* Ondersteuning voor meerdere talen
* Ondersteuning voor USB-apparaten (headset, toetsenbord, muis, camera)
* Clientservices (uitreksel):
** Zakelijke toepassingen – Sociaal intranet, projectmanagement, tijdregistratie
** UC-toepassingen – Softphone, video, chat, fax, voicemail, conferencing
** Centraal telefoonboek
Geïntegreerde softphone voor telefonie. Functieoverzicht:
* Audio- en video-ondersteuning
* Gesprek in wachtstand met de juiste signalering aan de beller
* Gesprek doorverbinden met/zonder overleg
* Gesprek in de wacht zetten met muziek
* Favorietenlijst met aanwezigheids- en gespreksstatusweergave
* Gesprekken beantwoorden vanuit de favorietenlijst
* Gesprekken ophalen uit de favorietenlijst
* Gesprek doorschakelen: permanent, bezet en geen antwoord
* In- en uitloggen bij oproepgroepen
* Microfoon dempen, tijdelijk dempen
* Driewegconferentiegesprekken, ook met externe deelnemers
* Gesprek opnemen
* Meerdere geïntegreerde beltonen
===Licenties===
* Softphone-applicentie (bestelnummer: 02-00050-004) en telefoon-applicentie (bestelnummer: 02-00050-005) vereist (één per gebruiker). UCC licentie wordt aanbevolen.
* Voor het registreren van PBX-gebruikers is een PBX-poortlicentie vereist (één per gebruiker).
* Voor het gebruik van optionele applicaties kunnen specifieke applicatielicenties vereist zijn (één per gebruiker).

{{Template:CE-Decl_Phones|Conformiteiten|zie afzonderlijk informatieblad}}
===Bestelnummer: 01-00270-001===
</div>
{{Template:Datasheet_footer|NL}}
[[Category:Technische gegevens Phones NL‏‎|{{PAGENAME}}]]

Specyfikacja IP270

2026-05-06T10:20:30Z

Vsc: Created page with "{{datasheet_header|innovaphone IP270| Telefon z myApps}} <div class="datasheets-mehrspaltig"> Image:IP270.png ===Oprogramowanie=== Obsługiwany z wersją 16r1final lub nowszą ===Obudowa=== 7-calowy ekran dotykowy, 1280 x 800 pikseli Klawiatura telefonu oraz pojawiająca się klawiatura alfanumeryczna Dioda LED 9 klawiszy funkcyjnych do regulacji głośności, ponownego wybierania, wyciszania, obsługi zestawu słuchawkowego i głośnika Regulowana podstawa w cz..."

{{datasheet_header|innovaphone IP270| Telefon z myApps}}
<div class="datasheets-mehrspaltig">
[[Image:IP270.png]]
===Oprogramowanie===
Obsługiwany z wersją 16r1final lub nowszą
===Obudowa===
7-calowy ekran dotykowy, 1280 x 800 pikseli

Klawiatura telefonu oraz pojawiająca się klawiatura alfanumeryczna

Dioda LED

9 klawiszy funkcyjnych do regulacji głośności, ponownego wybierania, wyciszania, obsługi zestawu
słuchawkowego i głośnika

Regulowana podstawa w czterech kątach nachylenia

Wymiary ze standardową podstawą (szer. x wys. x gł.): 260 x 200 x 160 mm

Waga: około 1000 gramów ze standardową podstawą
===Interfejsy===
1 x Gigabit-Ethernet: 1000-BASE-T (auto negocjacja), RJ-45 (modular Jack 8P8C) z “Power over Ethernet” nzgodnie z IEEE 802.3af i “Energy Efficient Ethernet” zgodnie z IEEE 802.3az

1 x Gigabit-Ethernet: 1000-BASE-T (auto negocjacja), RJ-45 (modular Jack 8P8C) do podłączenia komputera

2 x USB 2.0 typu A (z tyłu)

2 x USB 2.0 typu C (z tyłu)

1 x USB 2.0 typu C (z tyłu) do zewnętrznego zasilania

1 x USB 2.0 typu C (z przodu)
===Hardware===
Obsługa IPv4/IPv6

SRTP (SDES, DTLS 1.2), ICE

STUN, TURN przez UDP/TCP

Obsługa klienta DHCP

Obsługa NTP
===Administracja===
*Scentralizowane zarządzanie poprzez aplikację myApps-Devices do zmian konfiguracji i aktualizacji firmware
*Generowanie plików śledzenia (trace) i wyświetlanie logów statusu
===Komunikacja===
Zintegrowany klient myApps-Linux
* Dostęp z uwierzytelnianiem dwuskładnikowym, blokada ekranu
* Obsługa wielu języków
* Obsługa urządzeń USB (zestaw słuchawkowy, klawiatura, mysz, kamera)
* Wbudowane usługi klienckie (wybrane):
** Aplikacje biznesowe – Social Intranet, zarządzanie projektami, rejestracja czasu pracy
** Aplikacje UC – Softphone, wideo, czat, faks, poczta głosowa, konferencje
** Centralna książka telefoniczna (Contacts)
Aplikacja Softphone do telefonii – wybrane funkcje:
* Obsługa audio i wideo
* Połączenie oczekujące wraz z sygnalizacją dla dzwoniącego
* Przekazywanie połączeń z konsultacją lub bez
* Zawieszanie połączeń z muzyką w tle (Music-on-Hold)
* Lista ulubionych z informacją o statusie i dostępności
* Odbieranie połączeń z listy ulubionych
* Przekierowanie połączeń: bezwarunkowe, przy zajętości i przy braku odpowiedzi
* Logowanie i wylogowanie w grupach połączeń
* Wyciszenie mikrofonu
* Konferencja trójstronna, również z uczestnikami zewnętrznymi
* Nagrywanie połączeń
* Wiele wbudowanych dzwonków
===Licencje===
* Wymagana licencja Softphone-App (nr zamówienia: 02-00050-004) oraz Phone-App (nr zamówienia: 02-00050-005) – po jednej na użytkownika
* Do rejestracji użytkownika w PBX wymagana licencja PBX-Port – po jednej na użytkownika
* Do korzystania z opcjonalnych aplikacji mogą być wymagane dodatkowe licencje – po jednej na użytkownika
{{Template:CE-Decl_Phones|Deklaracje zgodności|patrz oddzielny arkusz informacyjny}}
===Nr katalogowy: 01-00270-001===
</div>
{{Template:Datasheet_footer|PL}}
[[Category:Specyfikacja techniczna Phones PL|{{PAGENAME}}]]

Dati tecnici IP270

2026-05-06T10:11:58Z

Vsc: Created page with "{{datasheet_header|innovaphone IP270|Il telefono myApps}} <div class="datasheets-mehrspaltig"> Image:IP270.png ===Firmware=== funzionante con la versione 16r1final o successive ===Box=== Display touch da 7 pollici, 1280 x 800 pixel Tastiera telefonica e tastiera alfanumerica a comparsa graduale LED 9 tasti funzione per il controllo del volume, la ricomposizione, la disattivazione dell'audio, le cuffie e l'altoparlante Piedino regolabile in quattro angolazioni Di..."

{{datasheet_header|innovaphone IP270|Il telefono myApps}}
<div class="datasheets-mehrspaltig">
[[Image:IP270.png]]
===Firmware===
funzionante con la versione 16r1final o successive
===Box===
Display touch da 7 pollici, 1280 x 800 pixel

Tastiera telefonica e tastiera alfanumerica a comparsa graduale

LED

9 tasti funzione per il controllo del volume, la ricomposizione, la disattivazione dell'audio, le cuffie e l'altoparlante

Piedino regolabile in quattro angolazioni

Dimensioni con piedistallo standard (L x A x P): 260 x 200 x 160 mm

Peso: circa 1000 grammi con piedistallo standard
===Interfacce===
1 x Gigabit Ethernet: 1000-BASE-T (auto-negoziazione), RJ-45 (connettore modulare 8P8C) con “Power over Ethernet” secondo lo standard 802.3af e “Energy Efficient Ethernet” secondo lo standard 802.3az

1 x Gigabit Ethernet: 1000-BASE-T (auto-negoziazione), RJ-45 (connettore modulare 8P8C) per il collegamento al PC

2 x porte USB 2.0 tipo A sul retro

2 x porte USB 2.0 tipo C sul retro

1 x porta USB 2.0 tipo C sul retro per alimentazione esterna

1 porta USB 2.0 tipo C sul lato anteriore
===Hardware===
Alimentazione: Power over Ethernet 802.3af, Classe 3 o alimentatore USB-C esterno 20 V, 6 W a max. 2 A

2 GB di RAM LPDDR4, 8 GB di memoria flash eMMC

Temperatura di esercizio: da 0 °C a +45 °C

Temperatura di stoccaggio: da -10 °C a +70 °C

Umidità: dal 10% al 90% (senza condensa)

Modalità di risparmio energetico con regolazione automatica della luminosità dello schermo

Due microfoni, vivavoce e >>ascolto aperto<< - no clue what open listening is
===Rete===
Supporto IPv4/IPv6

SRTP (SDES, DTLS 1.2), ICE

STUN, TURN su UDP/TCP

Supporto client DHCP

Supporto NTP
===Amministrazione===
* Amministrazione centralizzata tramite l'applicazione myApps-Devices per modifiche alla configurazione e aggiornamenti del firmware
* Generazione di tracciati di debug e visualizzazione del registro di stato
===Comunicazione===
myApps-Linux-Client integrato
* Accesso con autenticazione a due fattori, blocco schermo
* Supporto multilingue
* Supporto per la connettività di dispositivi USB (cuffie, tastiera, mouse, fotocamera)
* Servizi client integrati (per esempio):
** Applicazioni aziendali – Social aziendale (intranet), Gestione progetti, Time Tracking
** Applicazioni UC – Softphone, Video, Chat, Fax, Segreteria telefonica, Conferenze
** Rubrica telefonica centrale Contatti
Applicazione softphone per la telefonia. Esempio di funzionalità:
* Supporto audio e video
* Avviso di chiamata, con segnalazione di chiamata in attesa al chiamante
* Trasferimento di chiamata, con o senza consultazione
* Messa in attesa, con musica di attesa
* Elenco dei preferiti con indicazione della presenza e dello stato della chiamata
* Risposta alle chiamate dall'elenco dei preferiti
* Deviazione delle chiamate: incondizionata, in caso di occupato e in caso di mancata risposta
* Accesso e uscita dai gruppi di chiamata
* Muto per disattivazione del microfono
* Conferenza a tre, anche con utenti esterni
* Registrazione delle chiamate
* Diverse suonerie integrate
===Licenze===
* Softphone-App-License (numero d'ordine: 02-00050-004) e Phone-App-License (numero d'ordine: 02-00050-005) necessarie (una per utente)
* Per la registrazione degli utenti PBX è necessaria la PBX-Port-license (una per utente)
* Per l'utilizzo di applicazioni opzionali potrebbero essere necessarie licenze applicative specifiche (una per utente)
{{Template:CE-Decl_Phones|Conformità|vedi cheda informativa separata}}
===Numero d'ordine: 01-00270-001===
</div>
{{Template:Datasheet_footer|IT}}
[[Category:Dati tecnici Phones IT‏‎|{{PAGENAME}}]]

Fiche technique IP270

2026-05-06T08:56:48Z

Vsc: Created page with "{{datasheet_header|innovaphone IP270|Le téléphone myApps}} <div class="datasheets-mehrspaltig"> Image:IP270.png ===Firmware=== L'appareil fonctionne avec la version 16r1 ou supérieure ===Boîtier=== Écran 7 pouces (17,78cm), résolution 1280 x 800 pixel Clavier téléphonique et clavier alphanumérique à apparition progressive LED 9 touches de fonction pour le contrôle du volume, la recomposition, couper le micro, ainsi que le contrôle du casque et du ha..."

{{datasheet_header|innovaphone IP270|Le téléphone myApps}}
<div class="datasheets-mehrspaltig">
[[Image:IP270.png]]
===Firmware===
L'appareil fonctionne avec la version 16r1 ou supérieure

===Boîtier===
Écran 7 pouces (17,78cm), résolution 1280 x 800 pixel

Clavier téléphonique et clavier alphanumérique à apparition progressive

LED

9 touches de fonction pour le contrôle du volume, la recomposition, couper le micro, ainsi que le contrôle du casque et du haut-parleur

Pied réglable sur quatre angles

Dimensions avec pied standard (L x H x P) : 260 x 200 x 160 mm

Poids : env. 1000 grammes avec pied standard
===Interfaces===
1 x Gigabit Ethernet : 1000BASE-T (auto-négociation), RJ-45 (connecteur modulaire 8P8C) avec “Power over Ethernet” selon la norme 802.3af et “Energy Efficient Ethernet” selon la norme 802.3az

1 x Gigabit Ethernet : 1000BASE-T (auto-négociation), RJ-45 (connecteur modulaire 8P8C) pour connexion PC

2 x USB 2.0 type-A port à l'arrière

2 x USB 2.0 type-C port à l'arrière

1 x USB 2.0 type-C port à l'arrière pour alimentation externe

1 x USB 2.0 type-C port à l'avant
===Hardware===
Alimentation : Power over Ethernet 802.3af, Classe 3 ou alimentation externe USB-C 20V, 6W max. 2A

2Go de RAM LPDDR4, 8Go de mémoire flash eMMC

Température ambiante de fonctionnement : 0°C à +45°C

Humidité ambiante : 10% à 90% (sans condensation)

Température de stockage : -10°C à +70°C

Mode d’économie d’énergie avec atténuation automatique de l’écran

Deux microphones, mains libres et écoute en mode ouvert
===Réseau===
Support IPv4/IPv6

SRTP (SDES, DTLS 1.2), ICE

STUN, TURN via UDP/TCP

Support DHCP client

Support NTP
===Administration===
* Administration centralisée via l’application myApps-Devices pour les changement de configuration et les mises à jour du firmware
* Génération de fichiers de trace et affichage des journaux de logs
===Communication===
Client intégré myApps-Linux
* Accès authentifié à deux facteurs, verrouillage de l’écran
* Support multilingue
* Prise en charge de la connectivité des périphériques USB (casque, clavier, souris, caméra)
* Services clients intégrés (extrait) :
** Applications métier : réseau social d'entreprise, gestion de projet, gestion du temps
** Applications UC : softphone, vidéo, chat, fax, messagerie vocale, conférences
** Annuaire centralisé (Contacts)

Application Softphone pour la téléphonie – Extrait des fonctionnalités :
* Prise en charge de l’audio et de la vidéo
* Mise en attente avec signalisation de l’appel en attente vers l’appelant
* Transfert d’appel, avec ou sans consultation
* Mise en attente des appels,avec musique d’attente (Music-on-Hold)
* Liste de favoris avec la présence et le statut des appels
* Prise d’appel depuis la liste de favoris
* Renvoi d’appel : toujours, si occupé et sans réponse
* Quitter/rejoindre les groupes d’appels
* Désactivation du microphone
* Conférence à trois, également avec des participants externes
* Enregistrement des appels
* Plusieurs sonneries intégrées
===Licences===
* Licence Softphone App (numéro de commande : 02-00050-004) et licence Phone App (numéro de commande : 02-00050-005) requises (une par utilisateur)
* Pour connecter le téléphone au PBX, une licence port est requise (une par utilisateur)
* Pour l’utilisation d’applications optionnelles, des licences spécifiques peuvent être nécessaires (une par utilisateur)
{{Template:CE-Decl_Phones|Conformities|voir fiche d'information séparée}}
===Numéro de commande : 01-00270-001===
</div>
{{Template:Datasheet_footer|FR}}
[[Category:Fiche technique Phones FR|{{PAGENAME}}]]

Datasheet IP270

2026-05-06T08:47:28Z

Vsc:

{{datasheet_header|innovaphone IP270|The myApps Phone}}
<div class="datasheets-mehrspaltig">
[[Image:IP270.png]]
===Firmware===
operated with Version 16r1final or higher
===Housing===
7-inch touch display, 1280 x 800 pixel

Phone keypad and fade-in alphanumeric keyboard

LED

9 function keys for volume control, redial, mute, headset and speaker control

Adjustable footer in four angles

Size with standard footer (W x H x D): 260 x 200 x 160 mm

Weight: ca. 1000 grams with standard footer

===Interfaces===
1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) with “Power over Ethernet” according to 802.3af and “Energy Efficient Ethernet” according to 802.3az

1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) for PC connection

2 x USB 2.0 type-A port backsided

2 x USB 2.0 type-C port backsided

1 x USB 2.0 type-C port backsided for external power supply

1 x USB 2.0 type-C port frontsided

===Hardware===
Power supply: Power over Ethernet 802.3af, Class 3 or external USB-C PSU 20V, 6W at max. 2A

2 GB LPDDR4-RAM, 8 GB eMMC Flash

Operating temperature: 0 °C to +45 °C

Storage temperature: -10 °C to +70 °C

Humidity: 10% to 90% (non-condensing)

Power saving mode with automatic screen dimming

Two microphones, Hands-free and open listening

===Network===
IPv4/IPv6 Support

SRTP (SDES, DTLS 1.2), ICE

STUN, TURN over UDP/TCP

DHCP client support

NTP support

===Administration===
* Centralized administration via myApps-Devices application for configuration changes and firmware updates
* Trace file generation and status log display

===Communication===
Integrated myApps-Linux-Client
* Two-factor authenticated access, screenlock
* Multi language support
* USB device connectivity support (headset, keyboard, mouse, camera)
* Embedded client services (excerpt):
** Business applications – Social Intranet, Project Management, Time Tracking
** UC applications – Softphone, Video, Chat, Fax, Voicemail, Conferencing
** Central phone book Contacts

Softphone Application for telephony. Feature excerpt:
* Audio and Video support
* Call waiting, respective signalling of waiting call to caller
* Call transfer, with/without consultation
* Call hold, supported by Music-on-Hold
* Favorite list showing Presence and call status
* Call pick up from favorite list
* Call diversion: unconditional, on busy and on no answer
* Login and logout in call groups
* Mute for microphone deactivation
* Three party conference, also with external subscribers
* Call recording
* Several built-in ringtones

=== Licenses ===
* Softphone-App-License (Order Number: 02-00050-004) and Phone-App-License (Order Number: 02-00050-005) required (once per user)
* For PBX user registration PBX-Port-license is required (once per user)
* For use of optional applications specific application-licenses might be required (once per user)

{{Template:CE-Decl_Phones|Conformities|see separate information sheet}}
===Order Number: 01-00270-001===
</div>
{{Template:Datasheet_footer|EN}}
[[Category:Technical Data Phones EN|{{PAGENAME}}]]

Datenblatt IP270

2026-05-06T08:47:12Z

Vsc:

{{datasheet_header|innovaphone IP270|Das myApps Telefon}}
<div class="datasheets-mehrspaltig">
[[Image:IP270.png]]
===Firmware===
betreibbar ab Version 16r1final oder höher

===Gehäuse===
7-Zoll-Touchdisplay, 1280 x 800 Pixel

Telefon-Tastatur und einblendbare alphanumerische Tastatur

LED

9 Funktionstasten für Lautstärkeregelung, Wahlwiederholung, Stummschaltung sowie Headset- und Lautsprechersteuerung

In vier Stufen verstellbarer Standfuß

Maße mit Standardfuss: 260 x 200 x 160 mm

Gewicht: ca. 1000 g mit Standardfuss
===Schnittstellen===
1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) mit “Power over Ethernet” nach IEEE 802.3af und “Energy Efficient Ethernet” nach IEEE 802.3az

1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) für PC Anbindung

2 x rückseitiger USB 2.0 Typ-A-Anschluss

2 x rückseitiger USB 2.0 Typ-C-Anschluss

1 x rückseitiger USB 2.0 Typ-C-Anschluss für externe Stromversorgung

1 x frontseitiger USB 2.0 Typ-C-Anschluss
===Hardware===
Stromversorgung: Power over Ethernet nach IEEE 802.3af, Class 3 oder externes USB-C-Netzteil 20V, 6W bei max. 2A

2 GB LPDDR4-RAM, 8 GB eMMC Flash

Betriebstemperatur: 0 °C bis +45 °C

Lagertemperatur: -10 °C bis +70 °C

Luftfeuchtigkeit: 10% bis 90% (nicht kondensierend)

Energiesparmodus mit automatischer Bildschirmabdunkelung

Zwei Mikrofone, Freisprechen und offenes Hören

===Netzwerk===
IPv4/IPv6 Unterstützung

SRTP (SDES, DTLS 1.2), ICE

STUN, TURN über UDP/TCP

DHCP Unterstützung

NTP Unterstützung

===Verwaltung===
* Zentralisierte Verwaltung über myApps-Devices für Konfigurationsänderungen und Firmware-Updates
* Erstellung von Trace-Dateien und Anzeige des Statusprotokolls

===Kommunikation===
Integrierter myApps-Linux-Client
* Zwei-Faktor-Authentifizierung, Bildschirmsperre
* Mehrsprachige Unterstützung
* Unterstützung für USB-Geräte (Headset, Tastatur, Maus, Kamera)
* Client-Dienste (Auszug):
** Geschäftsanwendungen – Soziales Intranet, Projektmanagement, Zeiterfassung
** UC-Anwendungen – Softphone, Video, Chat, Fax, Voicemail, Konferenzen
** Zentrales Telefonbuch

Integriertes Softphone für Telefonie. Funktionsauszug:
* Audio- und Video-Unterstützung
* Anklopfen mit entsprechender Signalisierung zum rufenden Teilnehmer
* Rufvermittlung mit/ohne Rückfrage
* Anruf halten, unterstützt durch Wartemusik
* Favoritenliste mit Anzeige von Präsenz und Anrufstatus
* Anrufannahme aus der Favoritenliste
* Heranholen von Rufen aus der Favoritenliste
* Rufumleitung: permanent, bei Besetzt und bei keiner Antwort
* Ein- und Ausloggen in Anrufgruppen
* Stummschaltung, kurzfristiges Abschalten des Mikrofons
* Dreierkonferenz, auch mit externen Teilnehmern
* Anrufaufzeichnung
* Mehrere integrierte Klingeltöne

===Lizenzen===
* Softphone-App-Lizenz (Bestellnummer: 02-00050-004) und Phone-App-Lizenz (Bestellnummer: 02-00050-005) erforderlich (einmal pro Benutzer)
* Für die Registrierung von PBX-Benutzern ist eine PBX-Port-Lizenz erforderlich (einmal pro Benutzer)
* Für die Nutzung optionaler Anwendungen sind unter Umständen spezifische Anwendungslizenzen erforderlich (einmal pro Benutzer)

{{Template:CE-Decl_Phones|Konformitäten|siehe gesondertes Informationsblatt}}
===Bestellnummer: 01-00270-001===
</div>
{{Template:Datasheet_footer|DE}}
[[Category:Technische Daten Phones DE|{{PAGENAME}}]]

Datenblatt IP270

2026-05-05T11:45:09Z

Vsc: Created page with "{{datasheet_header|innovaphone IP270|Das myApps Telefon}} <div class="datasheets-mehrspaltig"> Image:IP270.png ===Firmware=== betreibbar ab Version 16r1final oder höher ===Gehäuse=== 7-Zoll-Touchdisplay, 1280 x 800 Pixel Telefon-Tastatur und einblendbare alphanumerische Tastatur LED 9 Funktionstasten für Lautstärkeregelung, Wahlwiederholung, Stummschaltung sowie Headset- und Lautsprechersteuerung In vier Stufen verstellbarer Standfuß Maße mit Standardfus..."

{{datasheet_header|innovaphone IP270|Das myApps Telefon}}
<div class="datasheets-mehrspaltig">
[[Image:IP270.png]]
===Firmware===
betreibbar ab Version 16r1final oder höher

===Gehäuse===
7-Zoll-Touchdisplay, 1280 x 800 Pixel

Telefon-Tastatur und einblendbare alphanumerische Tastatur

LED

9 Funktionstasten für Lautstärkeregelung, Wahlwiederholung, Stummschaltung sowie Headset- und Lautsprechersteuerung

In vier Stufen verstellbarer Standfuß

Maße mit Standardfuss: 260 x 200 x 160 mm

Gewicht: ca. 1000 g mit Standardfuss
===Schnittstellen===
1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) mit “Power over Ethernet” nach IEEE 802.3af und “Energy Efficient Ethernet” nach IEEE 802.3az

1 x Gigabit-Ethernet: 1000-BASE-T (auto negotiation), RJ-45 (modular Jack 8P8C) für PC Anbindung

2 x rückseitiger USB 2.0 Typ-A-Anschluss

2 x rückseitiger USB 2.0 Typ-C-Anschluss

1 x rückseitiger USB 2.0 Typ-C-Anschluss für externe Stromversorgung

1 x frontseitiger USB 2.0 Typ-C-Anschluss
===Hardware===
Stromversorgung: Power over Ethernet nach IEEE 802.3af, Class 3 oder externes USB-C-Netzteil 20V, 6W bei max. 2A

2 GB LPDDR4-RAM, 8 GB eMMC Flash

Betriebstemperatur: 0 °C bis +45 °C

Lagertemperatur: -10 °C bis +70 °C

Luftfeuchtigkeit: 10% bis 90% (nicht kondensierend)

Energiesparmodus mit automatischer Bildschirmabdunkelung

Zwei Mikrofone, Freisprechen und offenes Hören

===Netzwerk===
IPv4/IPv6 Unterstützung

SRTP (SDES, DTLS 1.2), ICE

STUN, TURN über UDP/TCP

DHCP Unterstützung

NTP Unterstützung

===Verwaltung===
* Zentralisierte Verwaltung über myApps-Devices für Konfigurationsänderungen und Firmware-Updates
* Erstellung von Trace-Dateien und Anzeige des Statusprotokolls

===Kommunikation===
Integrierter myApps-Linux-Client
* Zwei-Faktor-Authentifizierung, Bildschirmsperre
* Mehrsprachige Unterstützung
* Unterstützung für USB-Geräte (Headset, Tastatur, Maus, Kamera)
* Client-Dienste (Auszug):
** Geschäftsanwendungen – Soziales Intranet, Projektmanagement, Zeiterfassung
** UC-Anwendungen – Softphone, Video, Chat, Fax, Voicemail, Konferenzen
** Zentrales Telefonbuch
** Vermittlungsarbeitsplatz

Integriertes Softphone für Telefonie. Funktionsauszug:
* Audio- und Video-Unterstützung
* Anklopfen mit entsprechender Signalisierung zum rufenden Teilnehmer
* Rufvermittlung mit/ohne Rückfrage
* Anruf halten, unterstützt durch Wartemusik
* Favoritenliste mit Anzeige von Präsenz und Anrufstatus
* Anrufannahme aus der Favoritenliste
* Heranholen von Rufen aus der Favoritenliste
* Rufumleitung: permanent, bei Besetzt und bei keiner Antwort
* Ein- und Ausloggen in Anrufgruppen
* Stummschaltung, kurzfristiges Abschalten des Mikrofons
* Dreierkonferenz, auch mit externen Teilnehmern
* Anrufaufzeichnung
* Mehrere integrierte Klingeltöne

===Lizenzen===
* Softphone-App-Lizenz (Bestellnummer: 02-00050-004) und Phone-App-Lizenz (Bestellnummer: 02-00050-005) erforderlich (einmal pro Benutzer)
* Für die Registrierung von PBX-Benutzern ist eine PBX-Port-Lizenz erforderlich (einmal pro Benutzer)
* Für die Nutzung optionaler Anwendungen sind unter Umständen spezifische Anwendungslizenzen erforderlich (einmal pro Benutzer)

{{Template:CE-Decl_Phones|Konformitäten|siehe gesondertes Informationsblatt}}
===Bestellnummer: 01-00270-001===
</div>
{{Template:Datasheet_footer|DE}}
[[Category:Technische Daten Phones DE|{{PAGENAME}}]]

2026-04-28T14:41:30Z

Vsc:

== Applies To ==
* innovaphone IP270
* Firmware V16r1final 1610869 onwards

== Requirements ==
* innovaphone PBX with at least firmware 16r1final 1610869
* innovaphone App Platform with Devices and Users Application with at least firmware 16r1final 1610869
* IP270 firmware with at least version 16r1final 1610869
* PhonePlatform with at least build 2165
* PBX-Port-license (once per user)
* Softphone-App-License (Order Number: 02-00050-004) and Phone-App-License (Order Number: 02-00050-005) required (once per user)
* optional app licenses (once per user)

== Concept ==
myApps-powered phone for use with the innovaphone PBX

New hardware running a Yocto-based Linux distribution and hosting a native myApps IP270 client

Telephony via the myApps-softphone-application provided by the innovaphone PBX

Additional services of the myApps application platform

== Features ==
=== myApps-Features ===
See respective column for IP270 in [[Reference16r1:Concept_myApps_platform_services#Features|myApps-platform services]].

=== Telephony-Features ===
See columns for IP270 in [[Reference16r1:Concept_App_SoftphoneApp#Features|myApps-Softphone features]].

=== Headset support ===
myApps-IP270 supports use of [[Reference9:Concept_USB_Headset|USB devices known for innovaphone desk phones]].

== Configuration ==
=== Start ===
The IP270 is factory-configured as a DHCP client and obtains an IP address from a DHCP server—if available—via the LAN connection.

When the device starts up, myApps launches automatically and offers the following configuration options upon first startup after delivery:
* Provisioning Code input field
* Start provisioning
* Skip provisioning

Text input after a factory reset or upon delivery can be performed using the [[#On-screen keyboard|onscreen keyboard]] or the device’s hardware keypad.

After successful provisioning, this home screen is no longer displayed.

The device can be reset to factory settings by performing a power cycle while holding down the Home button until the LED stops flashing. This resets the home screen to the provisioning state and disables SSH login and remote browser debugging.

=== Automatic Provisioning (Recommended) ===
When the device is started for the first time after delivery or a factory reset, it displays the provisioning page, where a provisioning code can be entered.

The required provisioning code can be generated either by the administrator via UsersAdmin or by the user themselves via Profiles. In this process, the device is set up as a '''standard innovaphone phone'''.
The generated provisioning code can be entered on the device via the provisioning page.

After the provisioning code has been successfully entered, the device is added to Devices and assigned to the user. The myApps login page is displayed on the device and the device may attempt to load latest firmware. The LED flashes during this process.

After ~3 minutes, the device automatically reboots.

Afterwards, externally connected input devices such as a mouse and keyboard can also be used for myApps login and navigation.

In the user object, a device entry in the format “<ip270-mac> | Phone IP270, Softphone IP270 | phone,softphone” is created.

After successfully connecting to the server, the user’s login credentials can be entered.

=== Manual Configuration ===
==== Domain Assignment ====
After the device starts up, skip the provisioning process and go to “Change Server” on the myApps login screen.

There, select “Platform Setup” and enter your own Sysclient URL under / CONFIG / Sysclient URL.

Adapt the URL to your own domain in the following format

wss://<ap>.<domain>/<domain>/devices/sysclients

After confirming with Set, the device MAC appears in Devices and can be renamed and categorized there by the administrator.

==== User Assignment ====
* The administrator creates the device for the respective user via UsersAdmin
* A device entry is made in the User Object in the following format: HW-ID | Name1, Name2 | softphone,phone
* The HW-ID is the device MAC in the format 00903365xxxx, where xxxx are the last 4 digits of the serial number on the back label
* Name1 (e.g. IP270-Soft) identifies the SoftphoneApp. This must be set as the default telephony application on the IP270. It does not need to be visible on the home screen.
* Name2 (e.g. IP270-Remote) identifies the PhoneApp, which allows the IP270 to be controlled from a PC. This must be launched on the PC.

=== myApps ===
Log in to myApps on the login screen using the on-screen keyboard.
If the on-screen keyboard does not disappear automatically tap an empty field in myApps.

The IP270 softphone mandatorily must be set as the default telephony application.
 It is recommended to set the softphone as the focus application.

==== Settings ====
* Lock: Lock screen manually
* Default Apps: IP270-Softphone as telephony application
* More:
** Display: Backlight brightness for active and standby modes, power-saving options with display switch-off for adjustable start and end times
** Audio: Volume settings for ringtone, handset, speakerphone and headset. Use with caution.
** Lockscreen: Pin code and timeout in minutes, three different c-lock screens, emergency number list. As security measure in case of forgotten PIN, after six incorrect PIN entries the user is logged out and system switches back to login screen.
** Trace: Definition of trace flags for error analysis. The trace file can be downloaded via the administrative UI at Devices > Debug/Traces and opened in the default editor.

==== Task bar ====
* Loudspeaker symbol: indicates set handsfree volume
* Counter [optional]: yellow indicates the firmware download progress in percent; red indicates ongoing installation process
* Warning sign [optional]: indicates enabled SSH and/or Remotebrowser debug connection. To be set via Administrative UI in Devices.

==== On-screen keyboard ====
Alphabetical keyboard with access to additional symbols via the Cmp key (Compose):
* Cmp + . to access more punctuation
* Cmp + - or , to access 'mathematical' symbols (+,-,=,etc)
* Cmp + ' or 0 or 9 to access more brackets and quotes
* Cmp + a to access variants with diacritics like á,à,â,ä,
* Cmp + q to access emojis
Return to alphabetical keyboard using the ABC key.

=== Administrative UI ===
Access via Devices or directly from the device via Platform Setup without myApps login. Following options are available:

* SHOW - display system status
** ENET : NIC status, IP@ and MAC
** OS-VERSION : used yocto build & publication date
** SshD : SSH login status
** SshD toggle : de/activate SSH login
** UIDbg : Remotebrowserdebug status
** UIDbg toggle : de/activate remote browser debugging

* UPDATE - manual update according to provided update server path
** myApps Update : available myApps version to be installed upon selection
** rootfs2 Update : available phone platform build to be installed upon selection

* CONFIG
** Sysclient URL : URL to system device application for device management. Format : wss://<ap>.<domain>/<domain>/devices/sysclients Confirm entry with SET

* DEBUG - to be used when instructed by support
** various menues to display dedicated function status.
** TRACES : trace output according to set trace flags. Upon selection download to default download folder and opened in standard editor.
** COREDUMP : list of present compressed core dump files. Upon selection download to default download folder. Download may take a while - do not select multiple times.

* REBOOT
** restart system : reboot complete device
** restart myApps : restart myApps only

== Firmware Update ==
Device is operated with its own device firmware and hosts a native myApps client on top of it.

In the innovaphone Store (https://store.innovaphone.com/), the device firmware can be found under the "Phone Platform" tab.

In Devices, the device can access the device firmware via the domain upgrade using the URL https://store.innovaphone.com/release/download/phoneplatform.json.

The native IP270 myApps client is available in the Store under “Firmware” and is provided via https://store.innovaphone.com/release/download/firmware.json for the Devices upgrade.

During firmware update, the LED flashes.

== Factory Reset ==
Reset the device to factory settings is performed by power cycle whilst holding down the Home button until the LED stops flashing.

==Best practice use cases==
The device can be used locally or controlled remotely. Intended use cases are described below.

===Prerequisites===
* Audio device used must always be connected locally to the IP270
* Video devices can be connected to the IP270 and/or the PC

===Device Security===
It is recommended to set a personal PIN and lock timer via myApps/Settings/More.
After lock timer expiry and the device is locked automatically. Alternatively, the device can be locked manually via the myApps menu.
The lock timer is not interrupted by input from an external device such as mouce or keyboard.

Unlock using the button on the screen and enter the unlock code with the phone’s hardware keypad or an external hardware keyboard.

===Audio Device Handling===
General prioritization of audio devices when answering a call
# Handset when lifted
# Headset if available and handset is not used
# Speakerphone if no headset is available and the handset is not used

Switching audio devices during an active call:
* In the Softphone app using the button
* On the device using the Microphone (= handset), Headset, or Speaker buttons

=== Local Telephony ===
==== Outgoing calls ====
* Use the hardware keypad or SoftphoneApp to dial. When entering a number via the hardware keypad, the softphone app opens.
* When lifting the handset, outgoing call and all signaling tones are played through it.
* To route the call to a connected headset, initiate the call using the headset-button either on the headset or the IP270.
* To play audio in hands-free mode, initiate the call using the speaker button.

==== Incoming calls ====
* When answering a call using the headset-button either on the headset or the IP270, the call is played through the headset.
* When answering by lifting the handset, the call is played through the handset
* Answering via the speaker button on the device plays the call through the speaker in hands-free mode
* Alternatively, answer via the softphone app using the green handset icon. If no headset is connected and the handset is on the cradle, the call is answered in hands-free mode.

====Video====
* Video playback takes place in myApps on the IP270 if a video camera is connected to the IP270-PhoneApp
* No Remote Phone app may be open at the same time.

=== Remote Control via PC ===
IP270 can be remote controlled using the PhoneApp. It is recommended toset the IP270-PhoneApp as the default telephony application on the PC.

==== Outgoing calls ====
* Dial via PhoneApp. A headset connected to the IP270 is the default audio device; otherwise, the handset is used.
* During an active call, lifting the handset routes the call to the handset.
* Switch to speakerphone using the speakerphone button.

==== Incoming calls ====
* When answering a call using the headset-button either on the headset or the IP270, the call is played through the headset.
* When answering by lifting the handset, the call is played through the handset
* Answering via the speaker button on the device plays the call through the speaker in hands-free mode
* When answering the call via PhoneApp on the PC, the call is routed to the connected headset; otherwise, it to the handset

====Video====
If the remote PhoneApp is opened on the PC or defined as default telephony application, the video call will be displayed there.

== Troubleshooting ==
* Set trace options as told by innovaphone support via myApps-Client/More/Trace
* Collect traces at Devices/<IP270>/Debug TRACES and/or COREDUMPS . Tracefiles will be downloaded and opened automatically - stay patient and do not doubleclick!

== Known restrictions ==
* No file downloads from certain applications (e.g. Connect or similar)
* no LLDP-med support
* USB input devices are detected after the provisioning reboot
* USB ports are not intended for charging devices such as cell phones, power banks, or similar items

== Related Articles ==
[[Reference16r1:Concept_myApps_platform_services]]

https://wiki.innovaphone.com/index.php?title=Reference14r1:Concept_App_SoftphoneApp

https://wiki.innovaphone.com/index.php?title=Reference9:Concept_USB_Headset

https://wiki.innovaphone.com/index.php?title=Datasheet_IP270

Howto:Algo 8301 IP Paging Adapter - Algo - 3rd Party Product

2026-04-28T05:52:41Z

Vsc: /* Configuration */

[[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==
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
* 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|/AlgoSIPConfirmation.png|473x473px|/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|/Innovaphone_Config_Status.png|400x400px|/Innovaphone_Config_Status.png]]
# [[File:Status Confirmation.png|none|thumb|/Status_Confirmation.png|402x402px|/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|/Innovaphone_Config_Status2.png|418x418px|/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|/Innovaphone_Config_Status_using_GUI.png|400x400px|/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-28T05:51:45Z

Vsc: /* 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==

{{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==
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
* 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|/AlgoSIPConfirmation.png|473x473px|/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|/Innovaphone_Config_Status.png|400x400px|/Innovaphone_Config_Status.png]]
# [[File:Status Confirmation.png|none|thumb|/Status_Confirmation.png|402x402px|/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|/Innovaphone_Config_Status2.png|418x418px|/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|/Innovaphone_Config_Status_using_GUI.png|400x400px|/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].