innovaphone wiki - User contributions [en]

Howto:WakeUp App - Installation and Configuration

2026-09-09T11:56:18Z

Daz:

== Applies To ==

This information applies to:

* innovaphone PBX 14r1 and later.
* WakeUp package build 1037 RLS, built with the 15r1 SDK/runtime.

The documented test system uses PBX 16r1.


== Overview ==
WakeUp brings wake-up calls to myApps and IP phones with a simple, multilingual experience. Schedule multiple wake-ups, choose your preferred sound and adjust your settings in just a few steps.

For Hotels and Teams, WakeUp Moderator makes it easy to find users and manage their wake-ups from one place, while WakeUp Admin keeps service status and sound options under central control. Everything stays synchronized through the PBX, and scheduled calls work even when the app is closed.

<gallery widths="360" heights="240" perrow="2">
File:WakeUp App - Installation and Configuration Product 01.png|Wake-up calls made simple
File:WakeUp App - Installation and Configuration Product 02.png|Your wake-ups in one place
File:WakeUp App - Installation and Configuration Product 03.png|Get started in a few steps
File:WakeUp App - Installation and Configuration Product 04.png|Manage wake-ups for users and extensions
</gallery>

== More Information ==

=== Problem Details ===

WakeUp manages wake-up calls from myApps or an IP phone. All interfaces use the same wake-ups stored in the PBX. The PBX calls the user at the configured time, even when the user app is closed.

{| class="wikitable"
! App !! Purpose
|-
| '''WakeUp''' || Create, edit and delete your own wake-ups.
|-
| '''WakeUp Admin''' || Check service status and configure the available alarm sounds.
|-
| '''WakeUp Moderator''' || Search for users or extensions and manage their wake-ups.
|}

Telephone access uses a '''Voicemail object''' with an XML menu. The XML and voice prompts are stored in the '''Files App'''.

=== System Requirements ===

* An operational innovaphone PBX, Application Platform and Files App.
* Administrator access to the Application Platform, Settings and PBX Admin UI.
* A WakeUp package matching the platform architecture: <code>x86_64</code>, <code>arm64</code> or <code>arm</code>.
* A free internal number for the Voicemail menu.
* HTTPS connectivity and trusted certificates between the PBX and Application Platform.

=== Download ===

[[Media:WakeUp App - Installation and Configuration 1037 RLS.zip|Download WakeUp installation package (1037 RLS)]]

Download and extract the ZIP before installation. It contains the application files for the available platform architectures, the five telephone language folders, optional alarm sounds and documentation. Keep its folder structure unchanged.

== Installation ==

Follow these steps in order.
Examples use host <code>apps.example.com</code>, PBX domain <code>customer.example.com</code> and instance names <code>wakeup</code> and <code>files</code>. Replace them with your system's values.

=== 1. Install the WakeUp service ===

These instructions use the supplied release package; App Store availability is not required.

<ol start="1">
<li>Open the '''Application Platform Manager''' enable developer mode and choose the App upload button near the Appstore.</li>
<li>Enter App ID '''<code>wakeup</code>''' and title '''WakeUp'''. The App ID is always <code>wakeup</code> in lowercase.</li>
<li>Leave '''Disable verification of app ID''' unchecked.</li>
<li>From the package folder matching your platform architecture, upload <code>innovaphone-wakeup</code> and <code>innovaphone-wakeup.png</code>. Do not rename the files.</li>
<li>Open the installed service and add an instance:</li>
</ol>

{| class="wikitable"
! Field !! Value
|-
| Name || <code>wakeup</code>, or your chosen instance name
|-
| Domain || Your PBX domain
|-
| Password || A strong, unique password
|-
| Webserver path || Normally <code>customer.example.com/wakeup</code>
|-
| Database settings || Keep the platform-generated values
|}

<ol start="6">
<li>Save, start the instance and note its generated App URL.</li>
</ol>[[File:WakeUp App - Installation and Configuration 01.png|863x863px|wakeup_app_-_installation_and_configuration_01.png/|wakeup_app_-_installation_and_configuration_01.png/]]
[[File:WakeUp App - Installation and Configuration 01.2.png|863x863px|wakeup_app_-_installation_and_configuration_01.2.png/|wakeup_app_-_installation_and_configuration_01.2.png/]]

=== 2. Add the apps in Settings ===

<ol start="1">
<li>Close and reopen '''Settings''' to refresh the plugins.</li>
<li>Open '''Settings → WakeUp''' and select '''Add an App'''.</li>
<li>Create '''WakeUp''' first. Enter a display name, a unique SIP name and the user templates that should receive it.</li>
<li>Create '''WakeUp Admin''' for technical administrators.</li>
<li>Create '''WakeUp Moderator''' for trusted users who may manage other users' wake-ups.</li>
<li>Open WakeUp Admin and confirm that a PBX connection is shown.</li>
</ol>

The Settings plugin configures the App Objects and their required access. The primary WakeUp object provides the PBX connection, so create it even if you mainly use Moderator.

Only assign Admin and Moderator to the appropriate users or templates.

[[File:WakeUp App - Installation and Configuration 02.png|911x911px|Available WakeUp apps in Settings|wakeup_app_-_installation_and_configuration_02.png/]]

[[File:WakeUp App - Installation and Configuration 02.2.png|913x913px|App creation and template assignment|wakeup_app_-_installation_and_configuration_02.2.png/]]

=== XML Voicemail Configuration ===

=== 3. Choose the telephone language ===
Choose the language '''before uploading the files''' and configuring the Voicemail URL.

{| class="wikitable"
! Spoken language !! Folder in the package
|-
| English || <code>files-app/wakeup-en</code>
|-
| Italian || <code>files-app/wakeup-it</code>
|-
| German || <code>files-app/wakeup-de</code>
|-
| French || <code>files-app/wakeup-fr</code>
|-
| Spanish || <code>files-app/wakeup-es</code>
|}

The XML flow is the same; the audio files provide the selected language. The graphical apps follow the myApps language independently.

The following steps use '''Italian'''. For another language, replace <code>wakeup-it</code> with the matching folder name.

=== 4. Upload the files and edit config.xml ===
<ol start="1">
<li>In the '''Files App''', prepare an account/share that the PBX can use to read the files. Keep its username and password for the next step.</li>
<li>Using WebDAV, copy the complete <code>wakeup-en</code> folder from the package into <code>root</code>.</li>
<li>Check the layout:</li>
</ol>

<pre>
root/
└── wakeup-it/
├── config.xml
├── wakeup.xml
├── audio-test.xml
└── audio/
└── ... .g711a voice files
</pre>

<ol start="4">
<li>Open '''<code>config.xml</code>''' in a text editor. Find <code>INSTALLATION SETTING</code> and replace only the URL on this line:</li>
</ol>

<syntaxhighlight lang="html5">
<assign out="$api-base" value="https://apps.example.com/customer.example.com/wakeup/wakeup-ivr"/>
</syntaxhighlight>

<ol start="5">
<li>Use your WakeUp instance's webserver address followed by <code>/wakeup-ivr</code>, then save the file back to Files.</li>
</ol>

'''Do not edit <code>wakeup.xml</code>.''' Keep <code>config.xml</code> next to it. Do not add a trailing slash, password, token or query parameters to the API URL. Preserve filenames and the lowercase <code>audio</code> folder.


[[File:WakeUp App - Installation and Configuration 03.png|863x863px|English telephone package in Files|wakeup_app_-_installation_and_configuration_03.png/]]

''Italian telephone package in Files''

[[File:WakeUp App - Installation and Configuration 03.2.png|873x873px|WakeUp API address in config.xml|wakeup_app_-_installation_and_configuration_03.2.png/]]

''WakeUp API address in config.xml''

=== 5. Configure the Voicemail number ===
<ol start="1">
<li>In the PBX configuration, create an object of type '''Voicemail'''.</li>
<li>Configure:</li>
</ol>

{| class="wikitable"
! Setting !! Value
|-
| Long Name || <code>WakeUp Voicemail</code>
|-
| Name || A unique SIP name, for example <code>wakeup-voicemail</code>
|-
| Number || A free internal number chosen for this installation
|-
| Node / PBX || The PBX serving the users
|-
| Max Calls || The required simultaneous menu calls, within PBX capacity
|-
| User / Password || The Files credentials from step 4
|}

<ol start="3">
<li>Set the '''Script URL''', replacing the example host, domain and Files instance:</li>
</ol>

<pre>
https://apps.example.com/customer.example.com/files/root/wakeup-it/wakeup.xml?$_pbxcoder=g711a
</pre>

<ol start="4">
<li>Save and call the assigned number from a known PBX extension. You should hear the welcome message and menu.</li>
</ol>

The Files credentials are '''not''' the WakeUp instance password. No HTTP Client authentication entry is needed for the WakeUp API. Do not add <code>$_wakeup_api</code> or credentials to the Script URL.


[[File:WakeUp App - Installation and Configuration 05.png|909x909px|Voicemail General settings|wakeup_app_-_installation_and_configuration_05.png/]]

''Voicemail General settings''

[[File:WakeUp App - Installation and Configuration 05.2.png|910x910px|Voicemail script and Files access|wakeup_app_-_installation_and_configuration_05.2.png/]]

''Voicemail script and Files access''

'''To change the spoken language later:''' upload the other complete language folder, set its <code>config.xml</code> to the same API URL, and change the folder name in the Script URL. For separate access numbers in several languages, create one Voicemail object per language.

=== Alarm Sounds (Optional) ===
Without extra configuration, WakeUp uses the PBX default MOH. To offer other sounds, create a PBX '''Waiting Queue''' for each sound and publish it from WakeUp Admin.

===== Configure a Waiting Queue =====

<ol start="1">
<li>Upload the audio to Files or another WebDAV location accessible to the PBX. Optional samples are included in <code>files-app/Alarm/audio</code>.</li>
<li>Create a '''Waiting Queue''' with a unique SIP name, for example <code>alarm-gentle</code>.</li>
<li>Configure the audio URL in '''both announcement fields''' and enable repeating playback so the sound continues during the wake-up call.</li>
<li>Save and test the queue directly before adding it to WakeUp.</li>
</ol>

For a supplied G.711 A-law sample in Files, use this URL pattern:

<pre>
https://apps.example.com/customer.example.com/files/root/Alarm/audio/alarm-gentle.$coder?coder=g711a&repeat=true&fileskey=<FILES_KEY>
</pre>

Replace <code><FILES_KEY></code> with your Files share access key. Preserve the uppercase <code>Alarm</code> folder. Treat the key as a credential and hide it in public screenshots.


[[File:WakeUp App - Installation and Configuration 06.png|920x920px|Waiting Queue announcements|wakeup_app_-_installation_and_configuration_06.png/]]

''Waiting Queue announcements''

===== Make the sound available to users =====

<ol start="1">
<li>Open '''WakeUp Admin → Selectable alarm sources'''.</li>
<li>Click '''Add source''' and enter a label, the exact Waiting Queue '''SIP name''', and an optional description.</li>
<li>Select the default source for new wake-ups.</li>
<li>Click '''Save alarm sources'''. WakeUp checks the queue before making it available.</li>
</ol>

Use the <code>?</code> button for a short setup reminder. Changing the default or removing a catalog entry does not change existing wake-ups.


[[File:WakeUp App - Installation and Configuration 07.png|921x921px|WakeUp Admin and alarm sources|wakeup_app_-_installation_and_configuration_07.png/]]

''WakeUp Admin and alarm sources''

== Operation ==

=== WakeUp ===
Click '''Add wake-up''', choose the time, sound, retry count and optional daily repetition, then save. Use '''Edit''' or '''Delete''' to manage an entry. Type the time or adjust it using the clock dial.

Times use the '''PBX local clock''', not the phone or browser time zone. A green service indicator confirms connectivity; test an actual wake-up call before putting the service into use.


[[File:WakeUp App - Installation and Configuration 08.2.png|756x756px|WakeUp schedule|wakeup_app_-_installation_and_configuration_08.2.png/]]

''WakeUp schedule''

[[File:WakeUp App - Installation and Configuration 08 editor.png|WakeUp alarm editor|wakeup_app_-_installation_and_configuration_08_editor.png/]]

''WakeUp alarm editor''

=== WakeUp Moderator ===
Search by name, extension or SIP name. Users with wake-ups are highlighted. Filters show all users, those with wake-ups, or those without. Select a user to create, edit or delete their wake-ups.

The introductory tour explains the controls. It can be hidden and reopened from <code>?</code>.


[[File:WakeUp App - Installation and Configuration 09.png|979x979px|WakeUp Moderator|wakeup_app_-_installation_and_configuration_09.png/]]

[[File:WakeUp App - Installation and Configuration 09.2.png|979x979px|WakeUp Moderator|wakeup_app_-_installation_and_configuration_09.2.png/]]

''WakeUp Moderator editing hours''

== Telephone menu ==
Call the configured Voicemail number from your extension.

{| class="wikitable"
! Key !! Action
|-
| <code>1</code> || Hear the configured wake-ups
|-
| <code>2</code> || Create another wake-up
|-
| <code>3</code> || Change a wake-up
|-
| <code>4</code> || Delete a wake-up
|-
| <code>9</code> || Repeat the menu
|-
| <code>0</code> || End the call
|}

* Enter times as four digits in 24-hour format: <code>0730</code> means 07:30. No <code>#</code> is needed for the time.
* When asked to select a wake-up, enter its announced index followed by <code>#</code>. Press <code>*</code> to cancel.
* After an operation, press <code>1</code> to return to the menu or <code>0</code> to finish.
* New telephone wake-ups are one-time entries with no retries and use the default sound configured in WakeUp Admin. Changing a time preserves the other settings.

== Test Before Use ==
<ol start="1">
<li>Create a wake-up a few minutes ahead in WakeUp. Check that Moderator shows the same entry.</li>
<li>Call the Voicemail menu, listen to the entry, change its time and check the result in the app.</li>
<li>Create and delete a second entry by telephone. Check that returning to the menu and pressing <code>0</code> work.</li>
<li>Let a wake-up run: confirm the PBX calls the correct extension and the selected sound is heard.</li>
<li>Test retries, daily repetition and simultaneous callers if these will be used.</li>
</ol>

Limit Admin and Moderator access to authorized users. The IVR API has '''no HTTP authentication''': anyone who can reach it may attempt wake-up operations. Restrict the <code>/wakeup-ivr</code> route to the PBX or trusted networks without blocking normal myApps access. Validation alone is not access control.

== Known Problems ==
{| class="wikitable"
! Problem !! What to check
|-
| App upload fails || Use App ID <code>wakeup</code> in lowercase and the binary for your platform architecture.
|-
| No PBX connection or app login fails || Check the running instance and primary WakeUp App Object. Reopen Settings → WakeUp and check/save the affected object and its access settings.
|-
| No voice prompts || Check Files credentials, Script URL, complete audio folder and <code>g711a</code> parameter. Temporarily replace <code>wakeup.xml</code> with <code>audio-test.xml</code> in the Script URL to test audio, then restore it.
|-
| “Service temporarily unavailable” || Check that config.xml is beside wakeup.xml, its API URL is correct, and WakeUp Admin shows a PBX connection.
|-
| Opening the API base URL shows 404 || The API base is not a web page. Test through the telephone menu and check the last IVR result in WakeUp Admin.
|-
| Caller is not recognized || Call with a visible internal number that belongs to a PBX user.
|-
| A sound source is rejected or silent || Use the exact Waiting Queue SIP name, not its number or label. Test the queue and both announcements directly.
|-
| Wake-up is saved but no call arrives || Check the PBX clock, user reachability and PBX call trace.
|}

For telephone diagnostics, temporarily append <code>&$_trace=255</code> to the Script URL. Record the failed call's time and collect the Voicemail/PBX trace and WakeUp service log. Remove tracing afterwards and redact credentials before sharing logs.

== Updating ==
<ol start="1">
<li>Back up the current package, Files content and PBX configuration.</li>
<li>Update the service with the new binary for your architecture, preserving the instance settings.</li>
<li>Update the language folder's XML and audio together, but '''preserve your configured <code>config.xml</code>''' unless the release requires a configuration change.</li>
<li>Reopen the apps, check the build in WakeUp Admin and repeat the test above.</li>
</ol>

== Related Articles ==

* [[Reference16r1:Concept App Platform|innovaphone Application Platform]]
* [[Reference12r2:PBX/Objects/Edit Wakeup|PBX native wake-up settings]]

Howto:WakeUp App - Installation and Configuration

2026-09-09T10:17:32Z

Daz:

== Applies To ==

This information applies to:

* innovaphone PBX 14r1 and later.
* WakeUp package build 1037 RLS, built with the 15r1 SDK/runtime.

The documented test system uses PBX 16r1.


== Overview ==
WakeUp brings wake-up calls to myApps and IP phones with a simple, multilingual experience. Schedule multiple wake-ups, choose your preferred sound and adjust your settings in just a few steps.

For Hotels and Teams, WakeUp Moderator makes it easy to find users and manage their wake-ups from one place, while WakeUp Admin keeps service status and sound options under central control. Everything stays synchronized through the PBX, and scheduled calls work even when the app is closed.

<gallery widths="360" heights="240" perrow="2">
File:WakeUp App - Installation and Configuration Product 01.png|Wake-up calls made simple
File:WakeUp App - Installation and Configuration Product 02.png|Your wake-ups in one place
File:WakeUp App - Installation and Configuration Product 03.png|Get started in a few steps
File:WakeUp App - Installation and Configuration Product 04.png|Manage wake-ups for users and extensions
</gallery>

== More Information ==

=== Problem Details ===

WakeUp manages wake-up calls from myApps or an IP phone. All interfaces use the same wake-ups stored in the PBX. The PBX calls the user at the configured time, even when the user app is closed.

{| class="wikitable"
! App !! Purpose
|-
| '''WakeUp''' || Create, edit and delete your own wake-ups.
|-
| '''WakeUp Admin''' || Check service status and configure the available alarm sounds.
|-
| '''WakeUp Moderator''' || Search for users or extensions and manage their wake-ups.
|}

Telephone access uses a '''Voicemail object''' with an XML menu. The XML and voice prompts are stored in the '''Files App'''.

=== System Requirements ===

* An operational innovaphone PBX, Application Platform and Files App.
* Administrator access to the Application Platform, Settings and PBX Admin UI.
* A WakeUp package matching the platform architecture: <code>x86_64</code>, <code>arm64</code> or <code>arm</code>.
* A free internal number for the Voicemail menu.
* HTTPS connectivity and trusted certificates between the PBX and Application Platform.

=== Download ===

[[index.php?title=Media:WakeUp App - Installation and Configuration 1037 RLS.zip|Download WakeUp installation package (1037 RLS)]]

Download and extract the ZIP before installation. It contains the application files for the available platform architectures, the five telephone language folders, optional alarm sounds and documentation. Keep its folder structure unchanged.

== Installation ==

Follow these steps in order.
Examples use host <code>apps.example.com</code>, PBX domain <code>customer.example.com</code> and instance names <code>wakeup</code> and <code>files</code>. Replace them with your system's values.

=== 1. Install the WakeUp service ===

These instructions use the supplied release package; App Store availability is not required.

<ol start="1">
<li>Open the '''Application Platform Manager''' enable developer mode and choose the App upload button near the Appstore.</li>
<li>Enter App ID '''<code>wakeup</code>''' and title '''WakeUp'''. The App ID is always <code>wakeup</code> in lowercase.</li>
<li>Leave '''Disable verification of app ID''' unchecked.</li>
<li>From the package folder matching your platform architecture, upload <code>innovaphone-wakeup</code> and <code>innovaphone-wakeup.png</code>. Do not rename the files.</li>
<li>Open the installed service and add an instance:</li>
</ol>

{| class="wikitable"
! Field !! Value
|-
| Name || <code>wakeup</code>, or your chosen instance name
|-
| Domain || Your PBX domain
|-
| Password || A strong, unique password
|-
| Webserver path || Normally <code>customer.example.com/wakeup</code>
|-
| Database settings || Keep the platform-generated values
|}

<ol start="6">
<li>Save, start the instance and note its generated App URL.</li>
</ol>[[File:WakeUp App - Installation and Configuration 01.png|863x863px|wakeup_app_-_installation_and_configuration_01.png/|wakeup_app_-_installation_and_configuration_01.png/]]
[[File:WakeUp App - Installation and Configuration 01.2.png|863x863px|wakeup_app_-_installation_and_configuration_01.2.png/|wakeup_app_-_installation_and_configuration_01.2.png/]]

=== 2. Add the apps in Settings ===

<ol start="1">
<li>Close and reopen '''Settings''' to refresh the plugins.</li>
<li>Open '''Settings → WakeUp''' and select '''Add an App'''.</li>
<li>Create '''WakeUp''' first. Enter a display name, a unique SIP name and the user templates that should receive it.</li>
<li>Create '''WakeUp Admin''' for technical administrators.</li>
<li>Create '''WakeUp Moderator''' for trusted users who may manage other users' wake-ups.</li>
<li>Open WakeUp Admin and confirm that a PBX connection is shown.</li>
</ol>

The Settings plugin configures the App Objects and their required access. The primary WakeUp object provides the PBX connection, so create it even if you mainly use Moderator.

Only assign Admin and Moderator to the appropriate users or templates.

[[File:WakeUp App - Installation and Configuration 02.png|911x911px|Available WakeUp apps in Settings|wakeup_app_-_installation_and_configuration_02.png/]]

[[File:WakeUp App - Installation and Configuration 02.2.png|913x913px|App creation and template assignment|wakeup_app_-_installation_and_configuration_02.2.png/]]

=== XML Voicemail Configuration ===

=== 3. Choose the telephone language ===
Choose the language '''before uploading the files''' and configuring the Voicemail URL.

{| class="wikitable"
! Spoken language !! Folder in the package
|-
| English || <code>files-app/wakeup-en</code>
|-
| Italian || <code>files-app/wakeup-it</code>
|-
| German || <code>files-app/wakeup-de</code>
|-
| French || <code>files-app/wakeup-fr</code>
|-
| Spanish || <code>files-app/wakeup-es</code>
|}

The XML flow is the same; the audio files provide the selected language. The graphical apps follow the myApps language independently.

The following steps use '''Italian'''. For another language, replace <code>wakeup-it</code> with the matching folder name.

=== 4. Upload the files and edit config.xml ===
<ol start="1">
<li>In the '''Files App''', prepare an account/share that the PBX can use to read the files. Keep its username and password for the next step.</li>
<li>Using WebDAV, copy the complete <code>wakeup-en</code> folder from the package into <code>root</code>.</li>
<li>Check the layout:</li>
</ol>

<pre>
root/
└── wakeup-it/
├── config.xml
├── wakeup.xml
├── audio-test.xml
└── audio/
└── ... .g711a voice files
</pre>

<ol start="4">
<li>Open '''<code>config.xml</code>''' in a text editor. Find <code>INSTALLATION SETTING</code> and replace only the URL on this line:</li>
</ol>

<syntaxhighlight lang="html5">
<assign out="$api-base" value="https://apps.example.com/customer.example.com/wakeup/wakeup-ivr"/>
</syntaxhighlight>

<ol start="5">
<li>Use your WakeUp instance's webserver address followed by <code>/wakeup-ivr</code>, then save the file back to Files.</li>
</ol>

'''Do not edit <code>wakeup.xml</code>.''' Keep <code>config.xml</code> next to it. Do not add a trailing slash, password, token or query parameters to the API URL. Preserve filenames and the lowercase <code>audio</code> folder.


[[File:WakeUp App - Installation and Configuration 03.png|863x863px|English telephone package in Files|wakeup_app_-_installation_and_configuration_03.png/]]

''Italian telephone package in Files''

[[File:WakeUp App - Installation and Configuration 03.2.png|873x873px|WakeUp API address in config.xml|wakeup_app_-_installation_and_configuration_03.2.png/]]

''WakeUp API address in config.xml''

=== 5. Configure the Voicemail number ===
<ol start="1">
<li>In the PBX configuration, create an object of type '''Voicemail'''.</li>
<li>Configure:</li>
</ol>

{| class="wikitable"
! Setting !! Value
|-
| Long Name || <code>WakeUp Voicemail</code>
|-
| Name || A unique SIP name, for example <code>wakeup-voicemail</code>
|-
| Number || A free internal number chosen for this installation
|-
| Node / PBX || The PBX serving the users
|-
| Max Calls || The required simultaneous menu calls, within PBX capacity
|-
| User / Password || The Files credentials from step 4
|}

<ol start="3">
<li>Set the '''Script URL''', replacing the example host, domain and Files instance:</li>
</ol>

<pre>
https://apps.example.com/customer.example.com/files/root/wakeup-it/wakeup.xml?$_pbxcoder=g711a
</pre>

<ol start="4">
<li>Save and call the assigned number from a known PBX extension. You should hear the welcome message and menu.</li>
</ol>

The Files credentials are '''not''' the WakeUp instance password. No HTTP Client authentication entry is needed for the WakeUp API. Do not add <code>$_wakeup_api</code> or credentials to the Script URL.


[[File:WakeUp App - Installation and Configuration 05.png|909x909px|Voicemail General settings|wakeup_app_-_installation_and_configuration_05.png/]]

''Voicemail General settings''

[[File:WakeUp App - Installation and Configuration 05.2.png|910x910px|Voicemail script and Files access|wakeup_app_-_installation_and_configuration_05.2.png/]]

''Voicemail script and Files access''

'''To change the spoken language later:''' upload the other complete language folder, set its <code>config.xml</code> to the same API URL, and change the folder name in the Script URL. For separate access numbers in several languages, create one Voicemail object per language.

=== Alarm Sounds (Optional) ===
Without extra configuration, WakeUp uses the PBX default MOH. To offer other sounds, create a PBX '''Waiting Queue''' for each sound and publish it from WakeUp Admin.

===== Configure a Waiting Queue =====

<ol start="1">
<li>Upload the audio to Files or another WebDAV location accessible to the PBX. Optional samples are included in <code>files-app/Alarm/audio</code>.</li>
<li>Create a '''Waiting Queue''' with a unique SIP name, for example <code>alarm-gentle</code>.</li>
<li>Configure the audio URL in '''both announcement fields''' and enable repeating playback so the sound continues during the wake-up call.</li>
<li>Save and test the queue directly before adding it to WakeUp.</li>
</ol>

For a supplied G.711 A-law sample in Files, use this URL pattern:

<pre>
https://apps.example.com/customer.example.com/files/root/Alarm/audio/alarm-gentle.$coder?coder=g711a&repeat=true&fileskey=<FILES_KEY>
</pre>

Replace <code><FILES_KEY></code> with your Files share access key. Preserve the uppercase <code>Alarm</code> folder. Treat the key as a credential and hide it in public screenshots.


[[File:WakeUp App - Installation and Configuration 06.png|920x920px|Waiting Queue announcements|wakeup_app_-_installation_and_configuration_06.png/]]

''Waiting Queue announcements''

===== Make the sound available to users =====

<ol start="1">
<li>Open '''WakeUp Admin → Selectable alarm sources'''.</li>
<li>Click '''Add source''' and enter a label, the exact Waiting Queue '''SIP name''', and an optional description.</li>
<li>Select the default source for new wake-ups.</li>
<li>Click '''Save alarm sources'''. WakeUp checks the queue before making it available.</li>
</ol>

Use the <code>?</code> button for a short setup reminder. Changing the default or removing a catalog entry does not change existing wake-ups.


[[File:WakeUp App - Installation and Configuration 07.png|921x921px|WakeUp Admin and alarm sources|wakeup_app_-_installation_and_configuration_07.png/]]

''WakeUp Admin and alarm sources''

== Operation ==

=== WakeUp ===
Click '''Add wake-up''', choose the time, sound, retry count and optional daily repetition, then save. Use '''Edit''' or '''Delete''' to manage an entry. Type the time or adjust it using the clock dial.

Times use the '''PBX local clock''', not the phone or browser time zone. A green service indicator confirms connectivity; test an actual wake-up call before putting the service into use.


[[File:WakeUp App - Installation and Configuration 08.2.png|756x756px|WakeUp schedule|wakeup_app_-_installation_and_configuration_08.2.png/]]

''WakeUp schedule''

[[File:WakeUp App - Installation and Configuration 08 editor.png|WakeUp alarm editor|wakeup_app_-_installation_and_configuration_08_editor.png/]]

''WakeUp alarm editor''

=== WakeUp Moderator ===
Search by name, extension or SIP name. Users with wake-ups are highlighted. Filters show all users, those with wake-ups, or those without. Select a user to create, edit or delete their wake-ups.

The introductory tour explains the controls. It can be hidden and reopened from <code>?</code>.


[[File:WakeUp App - Installation and Configuration 09.png|979x979px|WakeUp Moderator|wakeup_app_-_installation_and_configuration_09.png/]]

[[File:WakeUp App - Installation and Configuration 09.2.png|979x979px|WakeUp Moderator|wakeup_app_-_installation_and_configuration_09.2.png/]]

''WakeUp Moderator editing hours''

== Telephone menu ==
Call the configured Voicemail number from your extension.

{| class="wikitable"
! Key !! Action
|-
| <code>1</code> || Hear the configured wake-ups
|-
| <code>2</code> || Create another wake-up
|-
| <code>3</code> || Change a wake-up
|-
| <code>4</code> || Delete a wake-up
|-
| <code>9</code> || Repeat the menu
|-
| <code>0</code> || End the call
|}

* Enter times as four digits in 24-hour format: <code>0730</code> means 07:30. No <code>#</code> is needed for the time.
* When asked to select a wake-up, enter its announced index followed by <code>#</code>. Press <code>*</code> to cancel.
* After an operation, press <code>1</code> to return to the menu or <code>0</code> to finish.
* New telephone wake-ups are one-time entries with no retries and use the default sound configured in WakeUp Admin. Changing a time preserves the other settings.

== Test Before Use ==
<ol start="1">
<li>Create a wake-up a few minutes ahead in WakeUp. Check that Moderator shows the same entry.</li>
<li>Call the Voicemail menu, listen to the entry, change its time and check the result in the app.</li>
<li>Create and delete a second entry by telephone. Check that returning to the menu and pressing <code>0</code> work.</li>
<li>Let a wake-up run: confirm the PBX calls the correct extension and the selected sound is heard.</li>
<li>Test retries, daily repetition and simultaneous callers if these will be used.</li>
</ol>

Limit Admin and Moderator access to authorized users. The IVR API has '''no HTTP authentication''': anyone who can reach it may attempt wake-up operations. Restrict the <code>/wakeup-ivr</code> route to the PBX or trusted networks without blocking normal myApps access. Validation alone is not access control.

== Known Problems ==
{| class="wikitable"
! Problem !! What to check
|-
| App upload fails || Use App ID <code>wakeup</code> in lowercase and the binary for your platform architecture.
|-
| No PBX connection or app login fails || Check the running instance and primary WakeUp App Object. Reopen Settings → WakeUp and check/save the affected object and its access settings.
|-
| No voice prompts || Check Files credentials, Script URL, complete audio folder and <code>g711a</code> parameter. Temporarily replace <code>wakeup.xml</code> with <code>audio-test.xml</code> in the Script URL to test audio, then restore it.
|-
| “Service temporarily unavailable” || Check that config.xml is beside wakeup.xml, its API URL is correct, and WakeUp Admin shows a PBX connection.
|-
| Opening the API base URL shows 404 || The API base is not a web page. Test through the telephone menu and check the last IVR result in WakeUp Admin.
|-
| Caller is not recognized || Call with a visible internal number that belongs to a PBX user.
|-
| A sound source is rejected or silent || Use the exact Waiting Queue SIP name, not its number or label. Test the queue and both announcements directly.
|-
| Wake-up is saved but no call arrives || Check the PBX clock, user reachability and PBX call trace.
|}

For telephone diagnostics, temporarily append <code>&$_trace=255</code> to the Script URL. Record the failed call's time and collect the Voicemail/PBX trace and WakeUp service log. Remove tracing afterwards and redact credentials before sharing logs.

== Updating ==
<ol start="1">
<li>Back up the current package, Files content and PBX configuration.</li>
<li>Update the service with the new binary for your architecture, preserving the instance settings.</li>
<li>Update the language folder's XML and audio together, but '''preserve your configured <code>config.xml</code>''' unless the release requires a configuration change.</li>
<li>Reopen the apps, check the build in WakeUp Admin and repeat the test above.</li>
</ol>

== Related Articles ==

* [[Reference16r1:Concept App Platform|innovaphone Application Platform]]
* [[Reference12r2:PBX/Objects/Edit Wakeup|PBX native wake-up settings]]

File:WakeUp App - Installation and Configuration Product 04.png

2026-09-09T10:16:57Z

Daz:

File:WakeUp App - Installation and Configuration Product 03.png

2026-09-09T10:16:46Z

Daz:

File:WakeUp App - Installation and Configuration Product 02.png

2026-09-09T10:16:34Z

Daz:

File:WakeUp App - Installation and Configuration Product 01.png

2026-09-09T10:16:20Z

Daz:

Howto:WakeUp App - Installation and Configuration

2026-09-09T10:02:32Z

Daz:

== Applies To ==

This information applies to:

* innovaphone PBX 14r1 and later.
* WakeUp package build 1037 RLS, built with the 15r1 SDK/runtime.

The documented test system uses PBX 16r1.


== Overview ==
WakeUp brings wake-up calls to myApps and IP phones with a simple, multilingual experience. Schedule multiple wake-ups, choose your preferred sound and adjust your settings in just a few steps.

For Hotels and Teams, WakeUp Moderator makes it easy to find users and manage their wake-ups from one place, while WakeUp Admin keeps service status and sound options under central control. Everything stays synchronized through the PBX, and scheduled calls work even when the app is closed.

== More Information ==

=== Problem Details ===

WakeUp manages wake-up calls from myApps or an IP phone. All interfaces use the same wake-ups stored in the PBX. The PBX calls the user at the configured time, even when the user app is closed.

{| class="wikitable"
! App !! Purpose
|-
| '''WakeUp''' || Create, edit and delete your own wake-ups.
|-
| '''WakeUp Admin''' || Check service status and configure the available alarm sounds.
|-
| '''WakeUp Moderator''' || Search for users or extensions and manage their wake-ups.
|}

Telephone access uses a '''Voicemail object''' with an XML menu. The XML and voice prompts are stored in the '''Files App'''.

=== System Requirements ===

* An operational innovaphone PBX, Application Platform and Files App.
* Administrator access to the Application Platform, Settings and PBX Admin UI.
* A WakeUp package matching the platform architecture: <code>x86_64</code>, <code>arm64</code> or <code>arm</code>.
* A free internal number for the Voicemail menu.
* HTTPS connectivity and trusted certificates between the PBX and Application Platform.

=== Download ===

[[Media:WakeUp App - Installation and Configuration 1037 RLS.zip|Download WakeUp installation package (1037 RLS)]]

Download and extract the ZIP before installation. It contains the application files for the available platform architectures, the five telephone language folders, optional alarm sounds and documentation. Keep its folder structure unchanged.

== Installation ==

Follow these steps in order.
Examples use host <code>apps.example.com</code>, PBX domain <code>customer.example.com</code> and instance names <code>wakeup</code> and <code>files</code>. Replace them with your system's values.

=== 1. Install the WakeUp service ===

These instructions use the supplied release package; App Store availability is not required.

<ol start="1">
<li>Open the '''Application Platform Manager''' enable developer mode and choose the App upload button near the Appstore.</li>
<li>Enter App ID '''<code>wakeup</code>''' and title '''WakeUp'''. The App ID is always <code>wakeup</code> in lowercase.</li>
<li>Leave '''Disable verification of app ID''' unchecked.</li>
<li>From the package folder matching your platform architecture, upload <code>innovaphone-wakeup</code> and <code>innovaphone-wakeup.png</code>. Do not rename the files.</li>
<li>Open the installed service and add an instance:</li>
</ol>

{| class="wikitable"
! Field !! Value
|-
| Name || <code>wakeup</code>, or your chosen instance name
|-
| Domain || Your PBX domain
|-
| Password || A strong, unique password
|-
| Webserver path || Normally <code>customer.example.com/wakeup</code>
|-
| Database settings || Keep the platform-generated values
|}

<ol start="6">
<li>Save, start the instance and note its generated App URL.</li>
</ol>[[File:WakeUp App - Installation and Configuration 01.png|863x863px|WakeUp instance settings|wakeup_app_-_installation_and_configuration_01.png/]]
[[File:WakeUp App - Installation and Configuration 01.2.png|863x863px|WakeUp instance settings|wakeup_app_-_installation_and_configuration_01.2.png/]]

=== 2. Add the apps in Settings ===

<ol start="1">
<li>Close and reopen '''Settings''' to refresh the plugins.</li>
<li>Open '''Settings → WakeUp''' and select '''Add an App'''.</li>
<li>Create '''WakeUp''' first. Enter a display name, a unique SIP name and the user templates that should receive it.</li>
<li>Create '''WakeUp Admin''' for technical administrators.</li>
<li>Create '''WakeUp Moderator''' for trusted users who may manage other users' wake-ups.</li>
<li>Open WakeUp Admin and confirm that a PBX connection is shown.</li>
</ol>

The Settings plugin configures the App Objects and their required access. The primary WakeUp object provides the PBX connection, so create it even if you mainly use Moderator.

Only assign Admin and Moderator to the appropriate users or templates.

[[File:WakeUp App - Installation and Configuration 02.png|911x911px|Available WakeUp apps in Settings]]

[[File:WakeUp App - Installation and Configuration 02.2.png|913x913px|App creation and template assignment]]

=== XML Voicemail Configuration ===

=== 3. Choose the telephone language ===
Choose the language '''before uploading the files''' and configuring the Voicemail URL.

{| class="wikitable"
! Spoken language !! Folder in the package
|-
| English || <code>files-app/wakeup-en</code>
|-
| Italian || <code>files-app/wakeup-it</code>
|-
| German || <code>files-app/wakeup-de</code>
|-
| French || <code>files-app/wakeup-fr</code>
|-
| Spanish || <code>files-app/wakeup-es</code>
|}

The XML flow is the same; the audio files provide the selected language. The graphical apps follow the myApps language independently.

The following steps use '''Italian'''. For another language, replace <code>wakeup-it</code> with the matching folder name.

=== 4. Upload the files and edit config.xml ===
<ol start="1">
<li>In the '''Files App''', prepare an account/share that the PBX can use to read the files. Keep its username and password for the next step.</li>
<li>Using WebDAV, copy the complete <code>wakeup-en</code> folder from the package into <code>root</code>.</li>
<li>Check the layout:</li>
</ol>

<pre>
root/
└── wakeup-it/
├── config.xml
├── wakeup.xml
├── audio-test.xml
└── audio/
└── ... .g711a voice files
</pre>

<ol start="4">
<li>Open '''<code>config.xml</code>''' in a text editor. Find <code>INSTALLATION SETTING</code> and replace only the URL on this line:</li>
</ol>

<syntaxhighlight lang="html5">
<assign out="$api-base" value="https://apps.example.com/customer.example.com/wakeup/wakeup-ivr"/>
</syntaxhighlight>

<ol start="5">
<li>Use your WakeUp instance's webserver address followed by <code>/wakeup-ivr</code>, then save the file back to Files.</li>
</ol>

'''Do not edit <code>wakeup.xml</code>.''' Keep <code>config.xml</code> next to it. Do not add a trailing slash, password, token or query parameters to the API URL. Preserve filenames and the lowercase <code>audio</code> folder.


[[File:WakeUp App - Installation and Configuration 03.png|863x863px|English telephone package in Files]]

''Italian telephone package in Files''

[[File:WakeUp App - Installation and Configuration 03.2.png|873x873px|WakeUp API address in config.xml]]

''WakeUp API address in config.xml''

=== 5. Configure the Voicemail number ===
<ol start="1">
<li>In the PBX configuration, create an object of type '''Voicemail'''.</li>
<li>Configure:</li>
</ol>

{| class="wikitable"
! Setting !! Value
|-
| Long Name || <code>WakeUp Voicemail</code>
|-
| Name || A unique SIP name, for example <code>wakeup-voicemail</code>
|-
| Number || A free internal number chosen for this installation
|-
| Node / PBX || The PBX serving the users
|-
| Max Calls || The required simultaneous menu calls, within PBX capacity
|-
| User / Password || The Files credentials from step 4
|}

<ol start="3">
<li>Set the '''Script URL''', replacing the example host, domain and Files instance:</li>
</ol>

<pre>
https://apps.example.com/customer.example.com/files/root/wakeup-it/wakeup.xml?$_pbxcoder=g711a
</pre>

<ol start="4">
<li>Save and call the assigned number from a known PBX extension. You should hear the welcome message and menu.</li>
</ol>

The Files credentials are '''not''' the WakeUp instance password. No HTTP Client authentication entry is needed for the WakeUp API. Do not add <code>$_wakeup_api</code> or credentials to the Script URL.


[[File:WakeUp App - Installation and Configuration 05.png|909x909px|Voicemail General settings]]

''Voicemail General settings''

[[File:WakeUp App - Installation and Configuration 05.2.png|910x910px|Voicemail script and Files access]]

''Voicemail script and Files access''

'''To change the spoken language later:''' upload the other complete language folder, set its <code>config.xml</code> to the same API URL, and change the folder name in the Script URL. For separate access numbers in several languages, create one Voicemail object per language.

=== Alarm Sounds (Optional) ===
Without extra configuration, WakeUp uses the PBX default MOH. To offer other sounds, create a PBX '''Waiting Queue''' for each sound and publish it from WakeUp Admin.

===== Configure a Waiting Queue =====

<ol start="1">
<li>Upload the audio to Files or another WebDAV location accessible to the PBX. Optional samples are included in <code>files-app/Alarm/audio</code>.</li>
<li>Create a '''Waiting Queue''' with a unique SIP name, for example <code>alarm-gentle</code>.</li>
<li>Configure the audio URL in '''both announcement fields''' and enable repeating playback so the sound continues during the wake-up call.</li>
<li>Save and test the queue directly before adding it to WakeUp.</li>
</ol>

For a supplied G.711 A-law sample in Files, use this URL pattern:

<pre>
https://apps.example.com/customer.example.com/files/root/Alarm/audio/alarm-gentle.$coder?coder=g711a&repeat=true&fileskey=<FILES_KEY>
</pre>

Replace <code><FILES_KEY></code> with your Files share access key. Preserve the uppercase <code>Alarm</code> folder. Treat the key as a credential and hide it in public screenshots.


[[File:WakeUp App - Installation and Configuration 06.png|920x920px|Waiting Queue announcements]]

''Waiting Queue announcements''

===== Make the sound available to users =====

<ol start="1">
<li>Open '''WakeUp Admin → Selectable alarm sources'''.</li>
<li>Click '''Add source''' and enter a label, the exact Waiting Queue '''SIP name''', and an optional description.</li>
<li>Select the default source for new wake-ups.</li>
<li>Click '''Save alarm sources'''. WakeUp checks the queue before making it available.</li>
</ol>

Use the <code>?</code> button for a short setup reminder. Changing the default or removing a catalog entry does not change existing wake-ups.


[[File:WakeUp App - Installation and Configuration 07.png|921x921px|WakeUp Admin and alarm sources]]

''WakeUp Admin and alarm sources''

== Operation ==

=== WakeUp ===
Click '''Add wake-up''', choose the time, sound, retry count and optional daily repetition, then save. Use '''Edit''' or '''Delete''' to manage an entry. Type the time or adjust it using the clock dial.

Times use the '''PBX local clock''', not the phone or browser time zone. A green service indicator confirms connectivity; test an actual wake-up call before putting the service into use.


[[File:WakeUp App - Installation and Configuration 08.2.png|756x756px|WakeUp schedule]]

''WakeUp schedule''

[[File:WakeUp App - Installation and Configuration 08 editor.png|WakeUp alarm editor]]

''WakeUp alarm editor''

=== WakeUp Moderator ===
Search by name, extension or SIP name. Users with wake-ups are highlighted. Filters show all users, those with wake-ups, or those without. Select a user to create, edit or delete their wake-ups.

The introductory tour explains the controls. It can be hidden and reopened from <code>?</code>.


[[File:WakeUp App - Installation and Configuration 09.png|979x979px|WakeUp Moderator]]

[[File:WakeUp App - Installation and Configuration 09.2.png|979x979px|WakeUp Moderator]]

''WakeUp Moderator editing hours''

== Telephone menu ==
Call the configured Voicemail number from your extension.

{| class="wikitable"
! Key !! Action
|-
| <code>1</code> || Hear the configured wake-ups
|-
| <code>2</code> || Create another wake-up
|-
| <code>3</code> || Change a wake-up
|-
| <code>4</code> || Delete a wake-up
|-
| <code>9</code> || Repeat the menu
|-
| <code>0</code> || End the call
|}

* Enter times as four digits in 24-hour format: <code>0730</code> means 07:30. No <code>#</code> is needed for the time.
* When asked to select a wake-up, enter its announced index followed by <code>#</code>. Press <code>*</code> to cancel.
* After an operation, press <code>1</code> to return to the menu or <code>0</code> to finish.
* New telephone wake-ups are one-time entries with no retries and use the default sound configured in WakeUp Admin. Changing a time preserves the other settings.

== Test Before Use ==
<ol start="1">
<li>Create a wake-up a few minutes ahead in WakeUp. Check that Moderator shows the same entry.</li>
<li>Call the Voicemail menu, listen to the entry, change its time and check the result in the app.</li>
<li>Create and delete a second entry by telephone. Check that returning to the menu and pressing <code>0</code> work.</li>
<li>Let a wake-up run: confirm the PBX calls the correct extension and the selected sound is heard.</li>
<li>Test retries, daily repetition and simultaneous callers if these will be used.</li>
</ol>

Limit Admin and Moderator access to authorized users. The IVR API has '''no HTTP authentication''': anyone who can reach it may attempt wake-up operations. Restrict the <code>/wakeup-ivr</code> route to the PBX or trusted networks without blocking normal myApps access. Validation alone is not access control.

== Known Problems ==
{| class="wikitable"
! Problem !! What to check
|-
| App upload fails || Use App ID <code>wakeup</code> in lowercase and the binary for your platform architecture.
|-
| No PBX connection or app login fails || Check the running instance and primary WakeUp App Object. Reopen Settings → WakeUp and check/save the affected object and its access settings.
|-
| No voice prompts || Check Files credentials, Script URL, complete audio folder and <code>g711a</code> parameter. Temporarily replace <code>wakeup.xml</code> with <code>audio-test.xml</code> in the Script URL to test audio, then restore it.
|-
| “Service temporarily unavailable” || Check that config.xml is beside wakeup.xml, its API URL is correct, and WakeUp Admin shows a PBX connection.
|-
| Opening the API base URL shows 404 || The API base is not a web page. Test through the telephone menu and check the last IVR result in WakeUp Admin.
|-
| Caller is not recognized || Call with a visible internal number that belongs to a PBX user.
|-
| A sound source is rejected or silent || Use the exact Waiting Queue SIP name, not its number or label. Test the queue and both announcements directly.
|-
| Wake-up is saved but no call arrives || Check the PBX clock, user reachability and PBX call trace.
|}

For telephone diagnostics, temporarily append <code>&$_trace=255</code> to the Script URL. Record the failed call's time and collect the Voicemail/PBX trace and WakeUp service log. Remove tracing afterwards and redact credentials before sharing logs.

== Updating ==
<ol start="1">
<li>Back up the current package, Files content and PBX configuration.</li>
<li>Update the service with the new binary for your architecture, preserving the instance settings.</li>
<li>Update the language folder's XML and audio together, but '''preserve your configured <code>config.xml</code>''' unless the release requires a configuration change.</li>
<li>Reopen the apps, check the build in WakeUp Admin and repeat the test above.</li>
</ol>

== Related Articles ==

* [[Reference16r1:Concept App Platform|innovaphone Application Platform]]
* [[Reference12r2:PBX/Objects/Edit Wakeup|PBX native wake-up settings]]

File:WakeUp App - Installation and Configuration 1037 RLS.zip

2026-09-09T09:59:35Z

Daz: Daz uploaded a new version of File:WakeUp App - Installation and Configuration 1037 RLS.zip

Howto:WakeUp App - Installation and Configuration

2026-09-09T09:56:20Z

Daz: Images added and Overview added

== Applies To ==

This information applies to:

* innovaphone PBX 14r1 and later.
* WakeUp package build 1037 RLS, built with the 15r1 SDK/runtime.

The documented test system uses PBX 16r1.


== Overview ==
WakeUp brings wake-up calls to myApps and IP phones with a simple, multilingual experience. Schedule multiple wake-ups, choose your preferred sound and adjust your settings in just a few steps.

For Hotels and Teams, WakeUp Moderator makes it easy to find users and manage their wake-ups from one place, while WakeUp Admin keeps service status and sound options under central control. Everything stays synchronized through the PBX, and scheduled calls work even when the app is closed.

== More Information ==

=== Problem Details ===

WakeUp manages wake-up calls from myApps or an IP phone. All interfaces use the same wake-ups stored in the PBX. The PBX calls the user at the configured time, even when the user app is closed.

{| class="wikitable"
! App !! Purpose
|-
| '''WakeUp''' || Create, edit and delete your own wake-ups.
|-
| '''WakeUp Admin''' || Check service status and configure the available alarm sounds.
|-
| '''WakeUp Moderator''' || Search for users or extensions and manage their wake-ups.
|}

Telephone access uses a '''Voicemail object''' with an XML menu. The XML and voice prompts are stored in the '''Files App'''.

=== System Requirements ===

* An operational innovaphone PBX, Application Platform and Files App.
* Administrator access to the Application Platform, Settings and PBX Admin UI.
* A WakeUp package matching the platform architecture: <code>x86_64</code>, <code>arm64</code> or <code>arm</code>.
* A free internal number for the Voicemail menu.
* HTTPS connectivity and trusted certificates between the PBX and Application Platform.

=== Download ===

[[Index.php?title=Media:WakeUp App - Installation and Configuration 1037 RLS.zip&action=edit&redlink=1|Download the WakeUp package (build 1037 RLS)]]

Download and extract the ZIP before installation. It contains the application files for the available platform architectures, the five telephone language folders, optional alarm sounds and documentation. Keep its folder structure unchanged.

== Installation ==

Follow these steps in order.
Examples use host <code>apps.example.com</code>, PBX domain <code>customer.example.com</code> and instance names <code>wakeup</code> and <code>files</code>. Replace them with your system's values.

=== 1. Install the WakeUp service ===

These instructions use the supplied release package; App Store availability is not required.

<ol start="1">
<li>Open the '''Application Platform Manager''' enable developer mode and choose the App upload button near the Appstore.</li>
<li>Enter App ID '''<code>wakeup</code>''' and title '''WakeUp'''. The App ID is always <code>wakeup</code> in lowercase.</li>
<li>Leave '''Disable verification of app ID''' unchecked.</li>
<li>From the package folder matching your platform architecture, upload <code>innovaphone-wakeup</code> and <code>innovaphone-wakeup.png</code>. Do not rename the files.</li>
<li>Open the installed service and add an instance:</li>
</ol>

{| class="wikitable"
! Field !! Value
|-
| Name || <code>wakeup</code>, or your chosen instance name
|-
| Domain || Your PBX domain
|-
| Password || A strong, unique password
|-
| Webserver path || Normally <code>customer.example.com/wakeup</code>
|-
| Database settings || Keep the platform-generated values
|}

<ol start="6">
<li>Save, start the instance and note its generated App URL.</li>
</ol>[[File:WakeUp App - Installation and Configuration 01.png|863x863px|WakeUp instance settings|wakeup_app_-_installation_and_configuration_01.png/]]
[[File:WakeUp App - Installation and Configuration 01.2.png|863x863px|WakeUp instance settings|wakeup_app_-_installation_and_configuration_01.2.png/]]

=== 2. Add the apps in Settings ===

<ol start="1">
<li>Close and reopen '''Settings''' to refresh the plugins.</li>
<li>Open '''Settings → WakeUp''' and select '''Add an App'''.</li>
<li>Create '''WakeUp''' first. Enter a display name, a unique SIP name and the user templates that should receive it.</li>
<li>Create '''WakeUp Admin''' for technical administrators.</li>
<li>Create '''WakeUp Moderator''' for trusted users who may manage other users' wake-ups.</li>
<li>Open WakeUp Admin and confirm that a PBX connection is shown.</li>
</ol>

The Settings plugin configures the App Objects and their required access. The primary WakeUp object provides the PBX connection, so create it even if you mainly use Moderator.

Only assign Admin and Moderator to the appropriate users or templates.

[[File:WakeUp App - Installation and Configuration 02.png|911x911px|Available WakeUp apps in Settings]]

[[File:WakeUp App - Installation and Configuration 02.2.png|913x913px|App creation and template assignment]]

=== XML Voicemail Configuration ===

=== 3. Choose the telephone language ===
Choose the language '''before uploading the files''' and configuring the Voicemail URL.

{| class="wikitable"
! Spoken language !! Folder in the package
|-
| English || <code>files-app/wakeup-en</code>
|-
| Italian || <code>files-app/wakeup-it</code>
|-
| German || <code>files-app/wakeup-de</code>
|-
| French || <code>files-app/wakeup-fr</code>
|-
| Spanish || <code>files-app/wakeup-es</code>
|}

The XML flow is the same; the audio files provide the selected language. The graphical apps follow the myApps language independently.

The following steps use '''Italian'''. For another language, replace <code>wakeup-it</code> with the matching folder name.

=== 4. Upload the files and edit config.xml ===
<ol start="1">
<li>In the '''Files App''', prepare an account/share that the PBX can use to read the files. Keep its username and password for the next step.</li>
<li>Using WebDAV, copy the complete <code>wakeup-en</code> folder from the package into <code>root</code>.</li>
<li>Check the layout:</li>
</ol>

<pre>
root/
└── wakeup-it/
├── config.xml
├── wakeup.xml
├── audio-test.xml
└── audio/
└── ... .g711a voice files
</pre>

<ol start="4">
<li>Open '''<code>config.xml</code>''' in a text editor. Find <code>INSTALLATION SETTING</code> and replace only the URL on this line:</li>
</ol>

<syntaxhighlight lang="html5">
<assign out="$api-base" value="https://apps.example.com/customer.example.com/wakeup/wakeup-ivr"/>
</syntaxhighlight>

<ol start="5">
<li>Use your WakeUp instance's webserver address followed by <code>/wakeup-ivr</code>, then save the file back to Files.</li>
</ol>

'''Do not edit <code>wakeup.xml</code>.''' Keep <code>config.xml</code> next to it. Do not add a trailing slash, password, token or query parameters to the API URL. Preserve filenames and the lowercase <code>audio</code> folder.


[[File:WakeUp App - Installation and Configuration 03.png|863x863px|English telephone package in Files]]

''Italian telephone package in Files''

[[File:WakeUp App - Installation and Configuration 03.2.png|873x873px|WakeUp API address in config.xml]]

''WakeUp API address in config.xml''

=== 5. Configure the Voicemail number ===
<ol start="1">
<li>In the PBX configuration, create an object of type '''Voicemail'''.</li>
<li>Configure:</li>
</ol>

{| class="wikitable"
! Setting !! Value
|-
| Long Name || <code>WakeUp Voicemail</code>
|-
| Name || A unique SIP name, for example <code>wakeup-voicemail</code>
|-
| Number || A free internal number chosen for this installation
|-
| Node / PBX || The PBX serving the users
|-
| Max Calls || The required simultaneous menu calls, within PBX capacity
|-
| User / Password || The Files credentials from step 4
|}

<ol start="3">
<li>Set the '''Script URL''', replacing the example host, domain and Files instance:</li>
</ol>

<pre>
https://apps.example.com/customer.example.com/files/root/wakeup-it/wakeup.xml?$_pbxcoder=g711a
</pre>

<ol start="4">
<li>Save and call the assigned number from a known PBX extension. You should hear the welcome message and menu.</li>
</ol>

The Files credentials are '''not''' the WakeUp instance password. No HTTP Client authentication entry is needed for the WakeUp API. Do not add <code>$_wakeup_api</code> or credentials to the Script URL.


[[File:WakeUp App - Installation and Configuration 05.png|909x909px|Voicemail General settings]]

''Voicemail General settings''

[[File:WakeUp App - Installation and Configuration 05.2.png|910x910px|Voicemail script and Files access]]

''Voicemail script and Files access''

'''To change the spoken language later:''' upload the other complete language folder, set its <code>config.xml</code> to the same API URL, and change the folder name in the Script URL. For separate access numbers in several languages, create one Voicemail object per language.

=== Alarm Sounds (Optional) ===
Without extra configuration, WakeUp uses the PBX default MOH. To offer other sounds, create a PBX '''Waiting Queue''' for each sound and publish it from WakeUp Admin.

===== Configure a Waiting Queue =====

<ol start="1">
<li>Upload the audio to Files or another WebDAV location accessible to the PBX. Optional samples are included in <code>files-app/Alarm/audio</code>.</li>
<li>Create a '''Waiting Queue''' with a unique SIP name, for example <code>alarm-gentle</code>.</li>
<li>Configure the audio URL in '''both announcement fields''' and enable repeating playback so the sound continues during the wake-up call.</li>
<li>Save and test the queue directly before adding it to WakeUp.</li>
</ol>

For a supplied G.711 A-law sample in Files, use this URL pattern:

<pre>
https://apps.example.com/customer.example.com/files/root/Alarm/audio/alarm-gentle.$coder?coder=g711a&repeat=true&fileskey=<FILES_KEY>
</pre>

Replace <code><FILES_KEY></code> with your Files share access key. Preserve the uppercase <code>Alarm</code> folder. Treat the key as a credential and hide it in public screenshots.


[[File:WakeUp App - Installation and Configuration 06.png|920x920px|Waiting Queue announcements]]

''Waiting Queue announcements''

===== Make the sound available to users =====

<ol start="1">
<li>Open '''WakeUp Admin → Selectable alarm sources'''.</li>
<li>Click '''Add source''' and enter a label, the exact Waiting Queue '''SIP name''', and an optional description.</li>
<li>Select the default source for new wake-ups.</li>
<li>Click '''Save alarm sources'''. WakeUp checks the queue before making it available.</li>
</ol>

Use the <code>?</code> button for a short setup reminder. Changing the default or removing a catalog entry does not change existing wake-ups.


[[File:WakeUp App - Installation and Configuration 07.png|921x921px|WakeUp Admin and alarm sources]]

''WakeUp Admin and alarm sources''

== Operation ==

=== WakeUp ===
Click '''Add wake-up''', choose the time, sound, retry count and optional daily repetition, then save. Use '''Edit''' or '''Delete''' to manage an entry. Type the time or adjust it using the clock dial.

Times use the '''PBX local clock''', not the phone or browser time zone. A green service indicator confirms connectivity; test an actual wake-up call before putting the service into use.


[[File:WakeUp App - Installation and Configuration 08.2.png|756x756px|WakeUp schedule]]

''WakeUp schedule''

[[File:WakeUp App - Installation and Configuration 08 editor.png|WakeUp alarm editor]]

''WakeUp alarm editor''

=== WakeUp Moderator ===
Search by name, extension or SIP name. Users with wake-ups are highlighted. Filters show all users, those with wake-ups, or those without. Select a user to create, edit or delete their wake-ups.

The introductory tour explains the controls. It can be hidden and reopened from <code>?</code>.


[[File:WakeUp App - Installation and Configuration 09.png|979x979px|WakeUp Moderator]]

[[File:WakeUp App - Installation and Configuration 09.2.png|979x979px|WakeUp Moderator]]

''WakeUp Moderator editing hours''

== Telephone menu ==
Call the configured Voicemail number from your extension.

{| class="wikitable"
! Key !! Action
|-
| <code>1</code> || Hear the configured wake-ups
|-
| <code>2</code> || Create another wake-up
|-
| <code>3</code> || Change a wake-up
|-
| <code>4</code> || Delete a wake-up
|-
| <code>9</code> || Repeat the menu
|-
| <code>0</code> || End the call
|}

* Enter times as four digits in 24-hour format: <code>0730</code> means 07:30. No <code>#</code> is needed for the time.
* When asked to select a wake-up, enter its announced index followed by <code>#</code>. Press <code>*</code> to cancel.
* After an operation, press <code>1</code> to return to the menu or <code>0</code> to finish.
* New telephone wake-ups are one-time entries with no retries and use the default sound configured in WakeUp Admin. Changing a time preserves the other settings.

== Test Before Use ==
<ol start="1">
<li>Create a wake-up a few minutes ahead in WakeUp. Check that Moderator shows the same entry.</li>
<li>Call the Voicemail menu, listen to the entry, change its time and check the result in the app.</li>
<li>Create and delete a second entry by telephone. Check that returning to the menu and pressing <code>0</code> work.</li>
<li>Let a wake-up run: confirm the PBX calls the correct extension and the selected sound is heard.</li>
<li>Test retries, daily repetition and simultaneous callers if these will be used.</li>
</ol>

Limit Admin and Moderator access to authorized users. The IVR API has '''no HTTP authentication''': anyone who can reach it may attempt wake-up operations. Restrict the <code>/wakeup-ivr</code> route to the PBX or trusted networks without blocking normal myApps access. Validation alone is not access control.

== Known Problems ==
{| class="wikitable"
! Problem !! What to check
|-
| App upload fails || Use App ID <code>wakeup</code> in lowercase and the binary for your platform architecture.
|-
| No PBX connection or app login fails || Check the running instance and primary WakeUp App Object. Reopen Settings → WakeUp and check/save the affected object and its access settings.
|-
| No voice prompts || Check Files credentials, Script URL, complete audio folder and <code>g711a</code> parameter. Temporarily replace <code>wakeup.xml</code> with <code>audio-test.xml</code> in the Script URL to test audio, then restore it.
|-
| “Service temporarily unavailable” || Check that config.xml is beside wakeup.xml, its API URL is correct, and WakeUp Admin shows a PBX connection.
|-
| Opening the API base URL shows 404 || The API base is not a web page. Test through the telephone menu and check the last IVR result in WakeUp Admin.
|-
| Caller is not recognized || Call with a visible internal number that belongs to a PBX user.
|-
| A sound source is rejected or silent || Use the exact Waiting Queue SIP name, not its number or label. Test the queue and both announcements directly.
|-
| Wake-up is saved but no call arrives || Check the PBX clock, user reachability and PBX call trace.
|}

For telephone diagnostics, temporarily append <code>&$_trace=255</code> to the Script URL. Record the failed call's time and collect the Voicemail/PBX trace and WakeUp service log. Remove tracing afterwards and redact credentials before sharing logs.

== Updating ==
<ol start="1">
<li>Back up the current package, Files content and PBX configuration.</li>
<li>Update the service with the new binary for your architecture, preserving the instance settings.</li>
<li>Update the language folder's XML and audio together, but '''preserve your configured <code>config.xml</code>''' unless the release requires a configuration change.</li>
<li>Reopen the apps, check the build in WakeUp Admin and repeat the test above.</li>
</ol>

== Related Articles ==

* [[Reference16r1:Concept App Platform|innovaphone Application Platform]]
* [[Reference12r2:PBX/Objects/Edit Wakeup|PBX native wake-up settings]]

File:WakeUp App - Installation and Configuration 09.2.png

2026-09-09T09:48:16Z

Daz:

moderator changing and editing hours

File:WakeUp App - Installation and Configuration 09.png

2026-09-09T09:47:15Z

Daz:

wake app moderator first view

File:WakeUp App - Installation and Configuration 08 editor.png

2026-09-09T09:46:11Z

Daz:

WakeUp App alarm editor

File:WakeUp App - Installation and Configuration 08.2.png

2026-09-09T09:44:30Z

Daz:

wake up app alarm view schedule

File:WakeUp App - Installation and Configuration 07.png

2026-09-09T09:43:33Z

Daz:

wakeup app admin view

File:WakeUp App - Installation and Configuration 06.png

2026-09-09T09:41:47Z

Daz:

waiting queue configuration

File:WakeUp App - Installation and Configuration 05.2.png

2026-09-09T09:38:46Z

Daz:

Webdav access settings

File:WakeUp App - Installation and Configuration 05.png

2026-09-09T09:38:15Z

Daz:

general settings voicemail

File:WakeUp App - Installation and Configuration 03.2.png

2026-09-09T09:35:26Z

Daz:

wake up api image edit config file

File:WakeUp App - Installation and Configuration 03.png

2026-09-09T09:34:17Z

Daz:

Files app with package

File:WakeUp App - Installation and Configuration 02.2.png

2026-09-09T09:32:11Z

Daz:

3 apps created

File:WakeUp App - Installation and Configuration 02.png

2026-09-09T09:30:57Z

Daz:

App Creation

Howto:WakeUp App - Installation and Configuration

2026-09-09T09:27:41Z

Daz: image added v1.

= This is a draft article =
== Applies To ==

This information applies to:

* innovaphone PBX 14r1 and later.
* WakeUp package build 1037 RLS, built with the 15r1 SDK/runtime.

The documented test system uses PBX 16r1.



== More Information ==

=== Problem Details ===

WakeUp manages wake-up calls from myApps or an IP phone. All interfaces use the same wake-ups stored in the PBX. The PBX calls the user at the configured time, even when the user app is closed.

{| class="wikitable"
! App !! Purpose
|-
| '''WakeUp''' || Create, edit and delete your own wake-ups.
|-
| '''WakeUp Admin''' || Check service status and configure the available alarm sounds.
|-
| '''WakeUp Moderator''' || Search for users or extensions and manage their wake-ups.
|}

Telephone access uses a '''Voicemail object''' with an XML menu. The XML and voice prompts are stored in the '''Files App'''.

=== System Requirements ===

* An operational innovaphone PBX, Application Platform and Files App.
* Administrator access to the Application Platform, Settings and PBX Admin UI.
* A WakeUp package matching the platform architecture: <code>x86_64</code>, <code>arm64</code> or <code>arm</code>.
* A free internal number for the Voicemail menu.
* HTTPS connectivity and trusted certificates between the PBX and Application Platform.

=== Download ===

[[index.php?title=Media:WakeUp App - Installation and Configuration 1037 RLS.zip|Download the WakeUp package (build 1037 RLS)]]

Download and extract the ZIP before installation. It contains the application files for the available platform architectures, the five telephone language folders, optional alarm sounds and documentation. Keep its folder structure unchanged.

== Installation ==

Follow these steps in order.
Examples use host <code>apps.example.com</code>, PBX domain <code>customer.example.com</code> and instance names <code>wakeup</code> and <code>files</code>. Replace them with your system's values.

=== 1. Install the WakeUp service ===

These instructions use the supplied release package; App Store availability is not required.

<ol start="1">
<li>Open the '''Application Platform Manager''' enable developer mode and choose the App upload button near the Appstore.</li>
<li>Enter App ID '''<code>wakeup</code>''' and title '''WakeUp'''. The App ID is always <code>wakeup</code> in lowercase.</li>
<li>Leave '''Disable verification of app ID''' unchecked.</li>
<li>From the package folder matching your platform architecture, upload <code>innovaphone-wakeup</code> and <code>innovaphone-wakeup.png</code>. Do not rename the files.</li>
<li>Open the installed service and add an instance:</li>
</ol>

{| class="wikitable"
! Field !! Value
|-
| Name || <code>wakeup</code>, or your chosen instance name
|-
| Domain || Your PBX domain
|-
| Password || A strong, unique password
|-
| Webserver path || Normally <code>customer.example.com/wakeup</code>
|-
| Database settings || Keep the platform-generated values
|}

<ol start="6">
<li>Save, start the instance and note its generated App URL.</li>
</ol>[[File:WakeUp App - Installation and Configuration 01.png|667x667px|WakeUp instance settings]]

''WakeUp instance settings''

=== 2. Add the apps in Settings ===

<ol start="1">
<li>Close and reopen '''Settings''' to refresh the plugins.</li>
<li>Open '''Settings → WakeUp''' and select '''Add an App'''.</li>
<li>Create '''WakeUp''' first. Enter a display name, a unique SIP name and the user templates that should receive it.</li>
<li>Create '''WakeUp Admin''' for technical administrators.</li>
<li>Create '''WakeUp Moderator''' for trusted users who may manage other users' wake-ups.</li>
<li>Open WakeUp Admin and confirm that a PBX connection is shown.</li>
</ol>

The Settings plugin configures the App Objects and their required access. The primary WakeUp object provides the PBX connection, so create it even if you mainly use Moderator.

Only assign Admin and Moderator to the appropriate users or templates.


[[Image:WakeUp App - Installation and Configuration 02.png|Available WakeUp apps in Settings]]

''Available WakeUp apps in Settings''

[[Image:WakeUp App - Installation and Configuration 03.png|App creation and template assignment]]

''App creation and template assignment''

=== XML Voicemail Configuration ===

==== 3. Choose the telephone language ====

Choose the language '''before uploading the files''' and configuring the Voicemail URL.

{| class="wikitable"
! Spoken language !! Folder in the package
|-
| English || <code>files-app/wakeup-en</code>
|-
| Italian || <code>files-app/wakeup-it</code>
|-
| German || <code>files-app/wakeup-de</code>
|-
| French || <code>files-app/wakeup-fr</code>
|-
| Spanish || <code>files-app/wakeup-es</code>
|}

The XML flow is the same; the audio files provide the selected language. The graphical apps follow the myApps language independently.

The following steps use '''English'''. For another language, replace <code>wakeup-en</code> with the matching folder name.

==== 4. Upload the files and edit config.xml ====

<ol start="1">
<li>In the '''Files App''', prepare an account/share that the PBX can use to read the files. Keep its username and password for the next step.</li>
<li>Using WebDAV, copy the complete <code>wakeup-en</code> folder from the package into <code>root</code>.</li>
<li>Check the layout:</li>
</ol>

<pre>
root/
└── wakeup-en/
├── config.xml
├── wakeup.xml
├── audio-test.xml
└── audio/
└── ... .g711a voice files
</pre>

<ol start="4">
<li>Open '''<code>config.xml</code>''' in a text editor. Find <code>INSTALLATION SETTING</code> and replace only the URL on this line:</li>
</ol>

<syntaxhighlight lang="html5">
<assign out="$api-base" value="https://apps.example.com/customer.example.com/wakeup/wakeup-ivr"/>
</syntaxhighlight>

<ol start="5">
<li>Use your WakeUp instance's webserver address followed by <code>/wakeup-ivr</code>, then save the file back to Files.</li>
</ol>

'''Do not edit <code>wakeup.xml</code>.''' Keep <code>config.xml</code> next to it. Do not add a trailing slash, password, token or query parameters to the API URL. Preserve filenames and the lowercase <code>audio</code> folder.


[[Image:WakeUp App - Installation and Configuration 04.png|English telephone package in Files]]

''English telephone package in Files''


[[Image:WakeUp App - Installation and Configuration 05.png|WakeUp API address in config.xml]]

''WakeUp API address in config.xml''

==== 5. Configure the Voicemail number ====

<ol start="1">
<li>In the PBX configuration, create an object of type '''Voicemail'''.</li>
<li>Configure:</li>
</ol>

{| class="wikitable"
! Setting !! Value
|-
| Long Name || <code>WakeUp Voicemail</code>
|-
| Name || A unique SIP name, for example <code>wakeup-voicemail</code>
|-
| Number || A free internal number chosen for this installation
|-
| Node / PBX || The PBX serving the users
|-
| Max Calls || The required simultaneous menu calls, within PBX capacity
|-
| User / Password || The Files credentials from step 4
|}

<ol start="3">
<li>Set the '''Script URL''', replacing the example host, domain and Files instance:</li>
</ol>

<pre>
https://apps.example.com/customer.example.com/files/root/wakeup-en/wakeup.xml?$_pbxcoder=g711a
</pre>

<ol start="4">
<li>Save and call the assigned number from a known PBX extension. You should hear the welcome message and menu.</li>
</ol>

The Files credentials are '''not''' the WakeUp instance password. No HTTP Client authentication entry is needed for the WakeUp API. Do not add <code>$_wakeup_api</code> or credentials to the Script URL.


[[Image:WakeUp App - Installation and Configuration 06.png|Voicemail General settings]]

''Voicemail General settings''

[[Image:WakeUp App - Installation and Configuration 07.png|Voicemail script and Files access]]

''Voicemail script and Files access''

'''To change the spoken language later:''' upload the other complete language folder, set its <code>config.xml</code> to the same API URL, and change the folder name in the Script URL. For separate access numbers in several languages, create one Voicemail object per language.

=== Alarm Sounds (Optional) ===

Without extra configuration, WakeUp uses the PBX default source. To offer other sounds, create a PBX '''Waiting Queue''' for each sound and publish it from WakeUp Admin.

===== Configure a Waiting Queue =====

<ol start="1">
<li>Upload the audio to Files or another WebDAV location accessible to the PBX. Optional samples are included in <code>files-app/Alarm/audio</code>.</li>
<li>Create a '''Waiting Queue''' with a unique SIP name, for example <code>alarm-gentle</code>.</li>
<li>Configure the audio URL in '''both announcement fields''' and enable repeating playback so the sound continues during the wake-up call.</li>
<li>Save and test the queue directly before adding it to WakeUp.</li>
</ol>

For a supplied G.711 A-law sample in Files, use this URL pattern:

<pre>
https://apps.example.com/customer.example.com/files/root/Alarm/audio/alarm-gentle.$coder?coder=g711a&repeat=true&fileskey=<FILES_KEY>
</pre>

Replace <code><FILES_KEY></code> with your Files share access key. Preserve the uppercase <code>Alarm</code> folder. Treat the key as a credential and hide it in public screenshots.


[[Image:WakeUp App - Installation and Configuration 08.png|Waiting Queue announcements]]

''Waiting Queue announcements''

===== Make the sound available to users =====

<ol start="1">
<li>Open '''WakeUp Admin → Selectable alarm sources'''.</li>
<li>Click '''Add source''' and enter a label, the exact Waiting Queue '''SIP name''', and an optional description.</li>
<li>Select the default source for new wake-ups.</li>
<li>Click '''Save alarm sources'''. WakeUp checks the queue before making it available.</li>
</ol>

Use the <code>?</code> button for a short setup reminder. Changing the default or removing a catalog entry does not change existing wake-ups.


[[Image:WakeUp App - Installation and Configuration 09.png|WakeUp Admin and alarm sources]]

''WakeUp Admin and alarm sources''

== Operation ==

==== WakeUp ====

Click '''Add wake-up''', choose the time, sound, retry count and optional daily repetition, then save. Use '''Edit''' or '''Delete''' to manage an entry. Type the time or adjust it using the clock dial.

Times use the '''PBX local clock''', not the phone or browser time zone. A green service indicator confirms connectivity; test an actual wake-up call before putting the service into use.


[[Image:WakeUp App - Installation and Configuration 10.png|WakeUp schedule]]

''WakeUp schedule''

[[Image:WakeUp App - Installation and Configuration 11.png|WakeUp alarm editor]]

''WakeUp alarm editor''

==== WakeUp Moderator ====

Search by name, extension or SIP name. Users with wake-ups are highlighted. Filters show all users, those with wake-ups, or those without. Select a user to create, edit or delete their wake-ups.

The introductory tour explains the controls. It can be hidden and reopened from <code>?</code>.


[[Image:WakeUp App - Installation and Configuration 12.png|WakeUp Moderator]]

''WakeUp Moderator''

=== Telephone menu ===

Call the configured Voicemail number from your extension.

{| class="wikitable"
! Key !! Action
|-
| <code>1</code> || Hear the configured wake-ups
|-
| <code>2</code> || Create another wake-up
|-
| <code>3</code> || Change a wake-up
|-
| <code>4</code> || Delete a wake-up
|-
| <code>9</code> || Repeat the menu
|-
| <code>0</code> || End the call
|}

* Enter times as four digits in 24-hour format: <code>0730</code> means 07:30. No <code>#</code> is needed for the time.
* When asked to select a wake-up, enter its announced index followed by <code>#</code>. Press <code>*</code> to cancel.
* After an operation, press <code>1</code> to return to the menu or <code>0</code> to finish.
* New telephone wake-ups are one-time entries with no retries and use the default sound configured in WakeUp Admin. Changing a time preserves the other settings.

=== Test Before Use ===

<ol start="1">
<li>Create a wake-up a few minutes ahead in WakeUp. Check that Moderator shows the same entry.</li>
<li>Call the Voicemail menu, listen to the entry, change its time and check the result in the app.</li>
<li>Create and delete a second entry by telephone. Check that returning to the menu and pressing <code>0</code> work.</li>
<li>Let a wake-up run: confirm the PBX calls the correct extension and the selected sound is heard.</li>
<li>Test retries, daily repetition and simultaneous callers if these will be used.</li>
</ol>

Limit Admin and Moderator access to authorized users. The IVR API has '''no HTTP authentication''': anyone who can reach it may attempt wake-up operations. Restrict the <code>/wakeup-ivr</code> route to the PBX or trusted networks without blocking normal myApps access. Validation alone is not access control.

=== Known Problems ===

{| class="wikitable"
! Problem !! What to check
|-
| App upload fails || Use App ID <code>wakeup</code> in lowercase and the binary for your platform architecture.
|-
| No PBX connection or app login fails || Check the running instance and primary WakeUp App Object. Reopen Settings → WakeUp and check/save the affected object and its access settings.
|-
| No voice prompts || Check Files credentials, Script URL, complete audio folder and <code>g711a</code> parameter. Temporarily replace <code>wakeup.xml</code> with <code>audio-test.xml</code> in the Script URL to test audio, then restore it.
|-
| “Service temporarily unavailable” || Check that config.xml is beside wakeup.xml, its API URL is correct, and WakeUp Admin shows a PBX connection.
|-
| Opening the API base URL shows 404 || The API base is not a web page. Test through the telephone menu and check the last IVR result in WakeUp Admin.
|-
| Caller is not recognized || Call with a visible internal number that belongs to a PBX user.
|-
| A sound source is rejected or silent || Use the exact Waiting Queue SIP name, not its number or label. Test the queue and both announcements directly.
|-
| Wake-up is saved but no call arrives || Check the PBX clock, user reachability and PBX call trace.
|}

For telephone diagnostics, temporarily append <code>&$_trace=255</code> to the Script URL. Record the failed call's time and collect the Voicemail/PBX trace and WakeUp service log. Remove tracing afterwards and redact credentials before sharing logs.

=== Updating ===

<ol start="1">
<li>Back up the current package, Files content and PBX configuration.</li>
<li>Update the service with the new binary for your architecture, preserving the instance settings.</li>
<li>Update the language folder's XML and audio together, but '''preserve your configured <code>config.xml</code>''' unless the release requires a configuration change.</li>
<li>Reopen the apps, check the build in WakeUp Admin and repeat the test above.</li>
</ol>

== Related Articles ==

* [[Reference16r1:Concept App Platform|innovaphone Application Platform]]
* [[Reference12r2:PBX/Objects/Edit Wakeup|PBX native wake-up settings]]

File:WakeUp App - Installation and Configuration 01.2.png

2026-09-09T09:26:45Z

Daz:

instance information

File:WakeUp App - Installation and Configuration 01.png

2026-09-09T09:24:44Z

Daz:

screenshot containing app upload

Howto:WakeUp App - Installation and Configuration

2026-09-09T08:33:48Z

Daz:

= This is a draft article =
== Applies To ==

This information applies to:

* innovaphone PBX 14r1 and later.
* WakeUp package build 1037 RLS, built with the 15r1 SDK/runtime.

The documented test system uses PBX 16r1.



== More Information ==

=== Problem Details ===

WakeUp manages wake-up calls from myApps or an IP phone. All interfaces use the same wake-ups stored in the PBX. The PBX calls the user at the configured time, even when the user app is closed.

{| class="wikitable"
! App !! Purpose
|-
| '''WakeUp''' || Create, edit and delete your own wake-ups.
|-
| '''WakeUp Admin''' || Check service status and configure the available alarm sounds.
|-
| '''WakeUp Moderator''' || Search for users or extensions and manage their wake-ups.
|}

Telephone access uses a '''Voicemail object''' with an XML menu. The XML and voice prompts are stored in the '''Files App'''.

=== System Requirements ===

* An operational innovaphone PBX, Application Platform and Files App.
* Administrator access to the Application Platform, Settings and PBX Admin UI.
* A WakeUp package matching the platform architecture: <code>x86_64</code>, <code>arm64</code> or <code>arm</code>.
* A free internal number for the Voicemail menu.
* HTTPS connectivity and trusted certificates between the PBX and Application Platform.

=== Download ===

[[Media:WakeUp App - Installation and Configuration 1037 RLS.zip|Download the WakeUp package (build 1037 RLS)]]

Download and extract the ZIP before installation. It contains the application files for the available platform architectures, the five telephone language folders, optional alarm sounds and documentation. Keep its folder structure unchanged.

== Installation ==

Follow these steps in order.
Examples use host <code>apps.example.com</code>, PBX domain <code>customer.example.com</code> and instance names <code>wakeup</code> and <code>files</code>. Replace them with your system's values.

=== 1. Install the WakeUp service ===

These instructions use the supplied release package; App Store availability is not required.

<ol start="1">
<li>Open the '''Application Platform Manager''' enable developer mode and choose the App upload button near the Appstore.</li>
<li>Enter App ID '''<code>wakeup</code>''' and title '''WakeUp'''. The App ID is always <code>wakeup</code> in lowercase.</li>
<li>Leave '''Disable verification of app ID''' unchecked.</li>
<li>From the package folder matching your platform architecture, upload <code>innovaphone-wakeup</code> and <code>innovaphone-wakeup.png</code>. Do not rename the files.</li>
<li>Open the installed service and add an instance:</li>
</ol>

{| class="wikitable"
! Field !! Value
|-
| Name || <code>wakeup</code>, or your chosen instance name
|-
| Domain || Your PBX domain
|-
| Password || A strong, unique password
|-
| Webserver path || Normally <code>customer.example.com/wakeup</code>
|-
| Database settings || Keep the platform-generated values
|}

<ol start="6">
<li>Save, start the instance and note its generated App URL.</li>
</ol>


[[Image:WakeUp App - Installation and Configuration 01.png|WakeUp instance settings]]

''WakeUp instance settings''

=== 2. Add the apps in Settings ===

<ol start="1">
<li>Close and reopen '''Settings''' to refresh the plugins.</li>
<li>Open '''Settings → WakeUp''' and select '''Add an App'''.</li>
<li>Create '''WakeUp''' first. Enter a display name, a unique SIP name and the user templates that should receive it.</li>
<li>Create '''WakeUp Admin''' for technical administrators.</li>
<li>Create '''WakeUp Moderator''' for trusted users who may manage other users' wake-ups.</li>
<li>Open WakeUp Admin and confirm that a PBX connection is shown.</li>
</ol>

The Settings plugin configures the App Objects and their required access. The primary WakeUp object provides the PBX connection, so create it even if you mainly use Moderator.

Only assign Admin and Moderator to the appropriate users or templates.


[[Image:WakeUp App - Installation and Configuration 02.png|Available WakeUp apps in Settings]]

''Available WakeUp apps in Settings''

[[Image:WakeUp App - Installation and Configuration 03.png|App creation and template assignment]]

''App creation and template assignment''

=== XML Voicemail Configuration ===

==== 3. Choose the telephone language ====

Choose the language '''before uploading the files''' and configuring the Voicemail URL.

{| class="wikitable"
! Spoken language !! Folder in the package
|-
| English || <code>files-app/wakeup-en</code>
|-
| Italian || <code>files-app/wakeup-it</code>
|-
| German || <code>files-app/wakeup-de</code>
|-
| French || <code>files-app/wakeup-fr</code>
|-
| Spanish || <code>files-app/wakeup-es</code>
|}

The XML flow is the same; the audio files provide the selected language. The graphical apps follow the myApps language independently.

The following steps use '''English'''. For another language, replace <code>wakeup-en</code> with the matching folder name.

==== 4. Upload the files and edit config.xml ====

<ol start="1">
<li>In the '''Files App''', prepare an account/share that the PBX can use to read the files. Keep its username and password for the next step.</li>
<li>Using WebDAV, copy the complete <code>wakeup-en</code> folder from the package into <code>root</code>.</li>
<li>Check the layout:</li>
</ol>

<pre>
root/
└── wakeup-en/
├── config.xml
├── wakeup.xml
├── audio-test.xml
└── audio/
└── ... .g711a voice files
</pre>

<ol start="4">
<li>Open '''<code>config.xml</code>''' in a text editor. Find <code>INSTALLATION SETTING</code> and replace only the URL on this line:</li>
</ol>

<syntaxhighlight lang="html5">
<assign out="$api-base" value="https://apps.example.com/customer.example.com/wakeup/wakeup-ivr"/>
</syntaxhighlight>

<ol start="5">
<li>Use your WakeUp instance's webserver address followed by <code>/wakeup-ivr</code>, then save the file back to Files.</li>
</ol>

'''Do not edit <code>wakeup.xml</code>.''' Keep <code>config.xml</code> next to it. Do not add a trailing slash, password, token or query parameters to the API URL. Preserve filenames and the lowercase <code>audio</code> folder.


[[Image:WakeUp App - Installation and Configuration 04.png|English telephone package in Files]]

''English telephone package in Files''


[[Image:WakeUp App - Installation and Configuration 05.png|WakeUp API address in config.xml]]

''WakeUp API address in config.xml''

==== 5. Configure the Voicemail number ====

<ol start="1">
<li>In the PBX configuration, create an object of type '''Voicemail'''.</li>
<li>Configure:</li>
</ol>

{| class="wikitable"
! Setting !! Value
|-
| Long Name || <code>WakeUp Voicemail</code>
|-
| Name || A unique SIP name, for example <code>wakeup-voicemail</code>
|-
| Number || A free internal number chosen for this installation
|-
| Node / PBX || The PBX serving the users
|-
| Max Calls || The required simultaneous menu calls, within PBX capacity
|-
| User / Password || The Files credentials from step 4
|}

<ol start="3">
<li>Set the '''Script URL''', replacing the example host, domain and Files instance:</li>
</ol>

<pre>
https://apps.example.com/customer.example.com/files/root/wakeup-en/wakeup.xml?$_pbxcoder=g711a
</pre>

<ol start="4">
<li>Save and call the assigned number from a known PBX extension. You should hear the welcome message and menu.</li>
</ol>

The Files credentials are '''not''' the WakeUp instance password. No HTTP Client authentication entry is needed for the WakeUp API. Do not add <code>$_wakeup_api</code> or credentials to the Script URL.


[[Image:WakeUp App - Installation and Configuration 06.png|Voicemail General settings]]

''Voicemail General settings''

[[Image:WakeUp App - Installation and Configuration 07.png|Voicemail script and Files access]]

''Voicemail script and Files access''

'''To change the spoken language later:''' upload the other complete language folder, set its <code>config.xml</code> to the same API URL, and change the folder name in the Script URL. For separate access numbers in several languages, create one Voicemail object per language.

=== Alarm Sounds (Optional) ===

Without extra configuration, WakeUp uses the PBX default source. To offer other sounds, create a PBX '''Waiting Queue''' for each sound and publish it from WakeUp Admin.

===== Configure a Waiting Queue =====

<ol start="1">
<li>Upload the audio to Files or another WebDAV location accessible to the PBX. Optional samples are included in <code>files-app/Alarm/audio</code>.</li>
<li>Create a '''Waiting Queue''' with a unique SIP name, for example <code>alarm-gentle</code>.</li>
<li>Configure the audio URL in '''both announcement fields''' and enable repeating playback so the sound continues during the wake-up call.</li>
<li>Save and test the queue directly before adding it to WakeUp.</li>
</ol>

For a supplied G.711 A-law sample in Files, use this URL pattern:

<pre>
https://apps.example.com/customer.example.com/files/root/Alarm/audio/alarm-gentle.$coder?coder=g711a&repeat=true&fileskey=<FILES_KEY>
</pre>

Replace <code><FILES_KEY></code> with your Files share access key. Preserve the uppercase <code>Alarm</code> folder. Treat the key as a credential and hide it in public screenshots.


[[Image:WakeUp App - Installation and Configuration 08.png|Waiting Queue announcements]]

''Waiting Queue announcements''

===== Make the sound available to users =====

<ol start="1">
<li>Open '''WakeUp Admin → Selectable alarm sources'''.</li>
<li>Click '''Add source''' and enter a label, the exact Waiting Queue '''SIP name''', and an optional description.</li>
<li>Select the default source for new wake-ups.</li>
<li>Click '''Save alarm sources'''. WakeUp checks the queue before making it available.</li>
</ol>

Use the <code>?</code> button for a short setup reminder. Changing the default or removing a catalog entry does not change existing wake-ups.


[[Image:WakeUp App - Installation and Configuration 09.png|WakeUp Admin and alarm sources]]

''WakeUp Admin and alarm sources''

== Operation ==

==== WakeUp ====

Click '''Add wake-up''', choose the time, sound, retry count and optional daily repetition, then save. Use '''Edit''' or '''Delete''' to manage an entry. Type the time or adjust it using the clock dial.

Times use the '''PBX local clock''', not the phone or browser time zone. A green service indicator confirms connectivity; test an actual wake-up call before putting the service into use.


[[Image:WakeUp App - Installation and Configuration 10.png|WakeUp schedule]]

''WakeUp schedule''

[[Image:WakeUp App - Installation and Configuration 11.png|WakeUp alarm editor]]

''WakeUp alarm editor''

==== WakeUp Moderator ====

Search by name, extension or SIP name. Users with wake-ups are highlighted. Filters show all users, those with wake-ups, or those without. Select a user to create, edit or delete their wake-ups.

The introductory tour explains the controls. It can be hidden and reopened from <code>?</code>.


[[Image:WakeUp App - Installation and Configuration 12.png|WakeUp Moderator]]

''WakeUp Moderator''

=== Telephone menu ===

Call the configured Voicemail number from your extension.

{| class="wikitable"
! Key !! Action
|-
| <code>1</code> || Hear the configured wake-ups
|-
| <code>2</code> || Create another wake-up
|-
| <code>3</code> || Change a wake-up
|-
| <code>4</code> || Delete a wake-up
|-
| <code>9</code> || Repeat the menu
|-
| <code>0</code> || End the call
|}

* Enter times as four digits in 24-hour format: <code>0730</code> means 07:30. No <code>#</code> is needed for the time.
* When asked to select a wake-up, enter its announced index followed by <code>#</code>. Press <code>*</code> to cancel.
* After an operation, press <code>1</code> to return to the menu or <code>0</code> to finish.
* New telephone wake-ups are one-time entries with no retries and use the default sound configured in WakeUp Admin. Changing a time preserves the other settings.

=== Test Before Use ===

<ol start="1">
<li>Create a wake-up a few minutes ahead in WakeUp. Check that Moderator shows the same entry.</li>
<li>Call the Voicemail menu, listen to the entry, change its time and check the result in the app.</li>
<li>Create and delete a second entry by telephone. Check that returning to the menu and pressing <code>0</code> work.</li>
<li>Let a wake-up run: confirm the PBX calls the correct extension and the selected sound is heard.</li>
<li>Test retries, daily repetition and simultaneous callers if these will be used.</li>
</ol>

Limit Admin and Moderator access to authorized users. The IVR API has '''no HTTP authentication''': anyone who can reach it may attempt wake-up operations. Restrict the <code>/wakeup-ivr</code> route to the PBX or trusted networks without blocking normal myApps access. Validation alone is not access control.

=== Known Problems ===

{| class="wikitable"
! Problem !! What to check
|-
| App upload fails || Use App ID <code>wakeup</code> in lowercase and the binary for your platform architecture.
|-
| No PBX connection or app login fails || Check the running instance and primary WakeUp App Object. Reopen Settings → WakeUp and check/save the affected object and its access settings.
|-
| No voice prompts || Check Files credentials, Script URL, complete audio folder and <code>g711a</code> parameter. Temporarily replace <code>wakeup.xml</code> with <code>audio-test.xml</code> in the Script URL to test audio, then restore it.
|-
| “Service temporarily unavailable” || Check that config.xml is beside wakeup.xml, its API URL is correct, and WakeUp Admin shows a PBX connection.
|-
| Opening the API base URL shows 404 || The API base is not a web page. Test through the telephone menu and check the last IVR result in WakeUp Admin.
|-
| Caller is not recognized || Call with a visible internal number that belongs to a PBX user.
|-
| A sound source is rejected or silent || Use the exact Waiting Queue SIP name, not its number or label. Test the queue and both announcements directly.
|-
| Wake-up is saved but no call arrives || Check the PBX clock, user reachability and PBX call trace.
|}

For telephone diagnostics, temporarily append <code>&$_trace=255</code> to the Script URL. Record the failed call's time and collect the Voicemail/PBX trace and WakeUp service log. Remove tracing afterwards and redact credentials before sharing logs.

=== Updating ===

<ol start="1">
<li>Back up the current package, Files content and PBX configuration.</li>
<li>Update the service with the new binary for your architecture, preserving the instance settings.</li>
<li>Update the language folder's XML and audio together, but '''preserve your configured <code>config.xml</code>''' unless the release requires a configuration change.</li>
<li>Reopen the apps, check the build in WakeUp Admin and repeat the test above.</li>
</ol>

== Related Articles ==

* [[Reference16r1:Concept App Platform|innovaphone Application Platform]]
* [[Reference12r2:PBX/Objects/Edit Wakeup|PBX native wake-up settings]]

Howto:WakeUp App - Installation and Configuration

2026-09-09T08:31:45Z

Daz: Created page with " = This is a draft article = == Applies To == This information applies to: * innovaphone PBX 14r1 and later. * WakeUp package build 1037 RLS, built with the 15r1 SDK/runtime. The documented test system uses PBX 16r1.  == More Information == === Problem Details === WakeUp manages wake-up calls from myApps or an IP phone. All interfa..."

= This is a draft article =
== Applies To ==

This information applies to:

* innovaphone PBX 14r1 and later.
* WakeUp package build 1037 RLS, built with the 15r1 SDK/runtime.

The documented test system uses PBX 16r1.



== More Information ==

=== Problem Details ===

WakeUp manages wake-up calls from myApps or an IP phone. All interfaces use the same wake-ups stored in the PBX. The PBX calls the user at the configured time, even when the user app is closed.

{| class="wikitable"
! App !! Purpose
|-
| '''WakeUp''' || Create, edit and delete your own wake-ups.
|-
| '''WakeUp Admin''' || Check service status and configure the available alarm sounds.
|-
| '''WakeUp Moderator''' || Search for users or extensions and manage their wake-ups.
|}

Telephone access uses a '''Voicemail object''' with an XML menu. The XML and voice prompts are stored in the '''Files App'''.

=== System Requirements ===

* An operational innovaphone PBX, Application Platform and Files App.
* Administrator access to the Application Platform, Settings and PBX Admin UI.
* A WakeUp package matching the platform architecture: <code>x86_64</code>, <code>arm64</code> or <code>arm</code>.
* A free internal number for the Voicemail menu.
* HTTPS connectivity and trusted certificates between the PBX and Application Platform.

=== Download ===

[[Media:WakeUp App - Installation and Configuration 1037 RLS.zip|Download the WakeUp package (build 1037 RLS)]]

Download and extract the ZIP before installation. It contains the application files for the available platform architectures, the five telephone language folders, optional alarm sounds and documentation. Keep its folder structure unchanged.

== Installation ==

Follow these steps in order.
Examples use host <code>apps.example.com</code>, PBX domain <code>customer.example.com</code> and instance names <code>wakeup</code> and <code>files</code>. Replace them with your system's values.

=== 1. Install the WakeUp service ===

These instructions use the supplied release package; App Store availability is not required.

<ol start="1">
<li>Open the '''Application Platform Manager''' enable developer mode and choose the App upload button near the Appstore.</li>
<li>Enter App ID '''<code>wakeup</code>''' and title '''WakeUp'''. The App ID is always <code>wakeup</code> in lowercase.</li>
<li>Leave '''Disable verification of app ID''' unchecked.</li>
<li>From the package folder matching your platform architecture, upload <code>innovaphone-wakeup</code> and <code>innovaphone-wakeup.png</code>. Do not rename the files.</li>
<li>Open the installed service and add an instance:</li>
</ol>

{| class="wikitable"
! Field !! Value
|-
| Name || <code>wakeup</code>, or your chosen instance name
|-
| Domain || Your PBX domain
|-
| Password || A strong, unique password
|-
| Webserver path || Normally <code>customer.example.com/wakeup</code>
|-
| Database settings || Keep the platform-generated values
|}

<ol start="6">
<li>Save, start the instance and note its generated App URL.</li>
</ol>


[[Image:WakeUp App - Installation and Configuration 01.png|WakeUp instance settings]]

''WakeUp instance settings''

=== 2. Add the apps in Settings ===

<ol start="1">
<li>Close and reopen '''Settings''' to refresh the plugins.</li>
<li>Open '''Settings → WakeUp''' and select '''Add an App'''.</li>
<li>Create '''WakeUp''' first. Enter a display name, a unique SIP name and the user templates that should receive it.</li>
<li>Create '''WakeUp Admin''' for technical administrators.</li>
<li>Create '''WakeUp Moderator''' for trusted users who may manage other users' wake-ups.</li>
<li>Open WakeUp Admin and confirm that a PBX connection is shown.</li>
</ol>

The Settings plugin configures the App Objects and their required access. The primary WakeUp object provides the PBX connection, so create it even if you mainly use Moderator.

Only assign Admin and Moderator to the appropriate users or templates.


[[Image:WakeUp App - Installation and Configuration 02.png|Available WakeUp apps in Settings]]

''Available WakeUp apps in Settings''

[[Image:WakeUp App - Installation and Configuration 03.png|App creation and template assignment]]

''App creation and template assignment''

=== XML Voicemail Configuration ===

==== 3. Choose the telephone language ====

Choose the language '''before uploading the files''' and configuring the Voicemail URL.

{| class="wikitable"
! Spoken language !! Folder in the package
|-
| English || <code>files-app/wakeup-en</code>
|-
| Italian || <code>files-app/wakeup-it</code>
|-
| German || <code>files-app/wakeup-de</code>
|-
| French || <code>files-app/wakeup-fr</code>
|-
| Spanish || <code>files-app/wakeup-es</code>
|}

The XML flow is the same; the audio files provide the selected language. The graphical apps follow the myApps language independently.

The following steps use '''English'''. For another language, replace <code>wakeup-en</code> with the matching folder name.

==== 4. Upload the files and edit config.xml ====

<ol start="1">
<li>In the '''Files App''', prepare an account/share that the PBX can use to read the files. Keep its username and password for the next step.</li>
<li>Using WebDAV, copy the complete <code>wakeup-en</code> folder from the package into <code>root</code>.</li>
<li>Check the layout:</li>
</ol>

<pre>
root/
└── wakeup-en/
├── config.xml
├── wakeup.xml
├── audio-test.xml
└── audio/
└── ... .g711a voice files
</pre>

<ol start="4">
<li>Open '''<code>config.xml</code>''' in a text editor. Find <code>INSTALLATION SETTING</code> and replace only the URL on this line:</li>
</ol>

<syntaxhighlight lang="html5">
<assign out="$api-base" value="https://apps.example.com/customer.example.com/wakeup/wakeup-ivr"/>
</syntaxhighlight>

<ol start="5">
<li>Use your WakeUp instance's webserver address followed by <code>/wakeup-ivr</code>, then save the file back to Files.</li>
</ol>

'''Do not edit <code>wakeup.xml</code>.''' Keep <code>config.xml</code> next to it. Do not add a trailing slash, password, token or query parameters to the API URL. Preserve filenames and the lowercase <code>audio</code> folder.


[[Image:WakeUp App - Installation and Configuration 04.png|English telephone package in Files]]

''English telephone package in Files''


[[Image:WakeUp App - Installation and Configuration 05.png|WakeUp API address in config.xml]]

''WakeUp API address in config.xml''

==== 5. Configure the Voicemail number ====

<ol start="1">
<li>In the PBX configuration, create an object of type '''Voicemail'''.</li>
<li>Configure:</li>
</ol>

{| class="wikitable"
! Setting !! Value
|-
| Long Name || <code>WakeUp Voicemail</code>
|-
| Name || A unique SIP name, for example <code>wakeup-voicemail</code>
|-
| Number || A free internal number chosen for this installation
|-
| Node / PBX || The PBX serving the users
|-
| Max Calls || The required simultaneous menu calls, within PBX capacity
|-
| User / Password || The Files credentials from step 4
|}

<ol start="3">
<li>Set the '''Script URL''', replacing the example host, domain and Files instance:</li>
</ol>

<pre>
https://apps.example.com/customer.example.com/files/root/wakeup-en/wakeup.xml?$_pbxcoder=g711a
</pre>

<ol start="4">
<li>Save and call the assigned number from a known PBX extension. You should hear the welcome message and menu.</li>
</ol>

The Files credentials are '''not''' the WakeUp instance password. No HTTP Client authentication entry is needed for the WakeUp API. Do not add <code>$_wakeup_api</code> or credentials to the Script URL.


[[Image:WakeUp App - Installation and Configuration 06.png|Voicemail General settings]]

''Voicemail General settings''

[[Image:WakeUp App - Installation and Configuration 07.png|Voicemail script and Files access]]

''Voicemail script and Files access''

'''To change the spoken language later:''' upload the other complete language folder, set its <code>config.xml</code> to the same API URL, and change the folder name in the Script URL. For separate access numbers in several languages, create one Voicemail object per language.

=== Alarm Sounds (Optional) ===

Without extra configuration, WakeUp uses the PBX default source. To offer other sounds, create a PBX '''Waiting Queue''' for each sound and publish it from WakeUp Admin.

===== Configure a Waiting Queue =====

<ol start="1">
<li>Upload the audio to Files or another WebDAV location accessible to the PBX. Optional samples are included in <code>files-app/Alarm/audio</code>.</li>
<li>Create a '''Waiting Queue''' with a unique SIP name, for example <code>alarm-gentle</code>.</li>
<li>Configure the audio URL in '''both announcement fields''' and enable repeating playback so the sound continues during the wake-up call.</li>
<li>Save and test the queue directly before adding it to WakeUp.</li>
</ol>

For a supplied G.711 A-law sample in Files, use this URL pattern:

<pre>
https://apps.example.com/customer.example.com/files/root/Alarm/audio/alarm-gentle.$coder?coder=g711a&repeat=true&fileskey=<FILES_KEY>
</pre>

Replace <code><FILES_KEY></code> with your Files share access key. Preserve the uppercase <code>Alarm</code> folder. Treat the key as a credential and hide it in public screenshots.


[[Image:WakeUp App - Installation and Configuration 08.png|Waiting Queue announcements]]

''Waiting Queue announcements''

===== Make the sound available to users =====

<ol start="1">
<li>Open '''WakeUp Admin → Selectable alarm sources'''.</li>
<li>Click '''Add source''' and enter a label, the exact Waiting Queue '''SIP name''', and an optional description.</li>
<li>Select the default source for new wake-ups.</li>
<li>Click '''Save alarm sources'''. WakeUp checks the queue before making it available.</li>
</ol>

Use the <code>?</code> button for a short setup reminder. Changing the default or removing a catalog entry does not change existing wake-ups.


[[Image:WakeUp App - Installation and Configuration 09.png|WakeUp Admin and alarm sources]]

''WakeUp Admin and alarm sources''

== Operation ==

==== WakeUp ====

Click '''Add wake-up''', choose the time, sound, retry count and optional daily repetition, then save. Use '''Edit''' or '''Delete''' to manage an entry. Type the time or adjust it using the clock dial.

Times use the '''PBX local clock''', not the phone or browser time zone. A green service indicator confirms connectivity; test an actual wake-up call before putting the service into use.


[[Image:WakeUp App - Installation and Configuration 10.png|WakeUp schedule]]

''WakeUp schedule''

[[Image:WakeUp App - Installation and Configuration 11.png|WakeUp alarm editor]]

''WakeUp alarm editor''

==== WakeUp Moderator ====

Search by name, extension or SIP name. Users with wake-ups are highlighted. Filters show all users, those with wake-ups, or those without. Select a user to create, edit or delete their wake-ups.

The introductory tour explains the controls. It can be hidden and reopened from <code>?</code>.


[[Image:WakeUp App - Installation and Configuration 12.png|WakeUp Moderator]]

''WakeUp Moderator''

=== Telephone menu ===

Call the configured Voicemail number from your extension.

{| class="wikitable"
! Key !! Action
|-
| <code>1</code> || Hear the configured wake-ups
|-
| <code>2</code> || Create another wake-up
|-
| <code>3</code> || Change a wake-up
|-
| <code>4</code> || Delete a wake-up
|-
| <code>9</code> || Repeat the menu
|-
| <code>0</code> || End the call
|}

* Enter times as four digits in 24-hour format: <code>0730</code> means 07:30. No <code>#</code> is needed for the time.
* When asked to select a wake-up, enter its announced index followed by <code>#</code>. Press <code>*</code> to cancel.
* After an operation, press <code>1</code> to return to the menu or <code>0</code> to finish.
* New telephone wake-ups are one-time entries with no retries and use the default sound configured in WakeUp Admin. Changing a time preserves the other settings.

=== Test Before Use ===

<ol start="1">
<li>Create a wake-up a few minutes ahead in WakeUp. Check that Moderator shows the same entry.</li>
<li>Call the Voicemail menu, listen to the entry, change its time and check the result in the app.</li>
<li>Create and delete a second entry by telephone. Check that returning to the menu and pressing <code>0</code> work.</li>
<li>Let a wake-up run: confirm the PBX calls the correct extension and the selected sound is heard.</li>
<li>Test retries, daily repetition and simultaneous callers if these will be used.</li>
</ol>

Limit Admin and Moderator access to authorized users. The IVR API has '''no HTTP authentication''': anyone who can reach it may attempt wake-up operations. Restrict the <code>/wakeup-ivr</code> route to the PBX or trusted networks without blocking normal myApps access. Validation alone is not access control.

=== Known Problems ===

{| class="wikitable"
! Problem !! What to check
|-
| App upload fails || Use App ID <code>wakeup</code> in lowercase and the binary for your platform architecture.
|-
| No PBX connection or app login fails || Check the running instance and primary WakeUp App Object. Reopen Settings → WakeUp and check/save the affected object and its access settings.
|-
| No voice prompts || Check Files credentials, Script URL, complete audio folder and <code>g711a</code> parameter. Temporarily replace <code>wakeup.xml</code> with <code>audio-test.xml</code> in the Script URL to test audio, then restore it.
|-
| “Service temporarily unavailable” || Check that config.xml is beside wakeup.xml, its API URL is correct, and WakeUp Admin shows a PBX connection.
|-
| Opening the API base URL shows 404 || The API base is not a web page. Test through the telephone menu and check the last IVR result in WakeUp Admin.
|-
| Caller is not recognized || Call with a visible internal number that belongs to a PBX user.
|-
| A sound source is rejected or silent || Use the exact Waiting Queue SIP name, not its number or label. Test the queue and both announcements directly.
|-
| Wake-up is saved but no call arrives || Check the PBX clock, user reachability and PBX call trace.
|}

For telephone diagnostics, temporarily append <code>&$_trace=255</code> to the Script URL. Record the failed call's time and collect the Voicemail/PBX trace and WakeUp service log. Remove tracing afterwards and redact credentials before sharing logs.

=== Updating ===

<ol start="1">
<li>Back up the current package, Files content and PBX configuration.</li>
<li>Update the service with the new binary for your architecture, preserving the instance settings.</li>
<li>Update the language folder's XML and audio together, but '''preserve your configured <code>config.xml</code>''' unless the release requires a configuration change.</li>
<li>Reopen the apps, check the build in WakeUp Admin and repeat the test above.</li>
</ol>

== Related Articles ==

* [[Reference16r1:Concept App Platform|innovaphone Application Platform]]
* [[Reference12r2:PBX/Objects/Edit Wakeup|PBX native wake-up settings]]

[[Category:Howto|{{WakeUP App - Installation and Configuration}}]]

File:WakeUp App - Installation and Configuration 1037 RLS.zip

2026-09-08T15:14:59Z

Daz:

Reference16r1:Concept App Service Connector for Whatsapp

2026-05-27T14:13:28Z

Daz: spelling error

== Applies To ==

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

== Requirements ==

<ul><li> innovaphone PBX
</li><li> innovaphone AppPlatform
</li><li> innovaphone myApps
</li><li> Messages App service and Connect app
</li><li> A Facebook account
</li><li> At least one valid phone number (MSN) required for the registration with the WhatsApp Business platform. This number cannot be associated with the free version of whatsapp already.
</li></ul>

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

== Concept ==

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

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

== How it works ==

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

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


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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Once completed, a success message will be displayed. 

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

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

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

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

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

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

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

== Troubleshooting ==

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

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

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

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

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

== Related Articles ==

Dati tecnici IP1130

2026-03-18T13:15:31Z

Daz:

{{datasheet_header|innovaphone IP1130|Media gateway ISDN-PRI con 30 canali}}
<div class="datasheets-mehrspaltig">
[[Image:IP1130.png]]
===Firmware===
Il gateway funziona dalla Versione 11r2sr10 o successive

{{Template:Leistungsmerkmale IT neu - Gehäuse}}

Peso: 1050 g
===Interfacce===
1 x interfaccia flusso primario (PRI): utilizzo in collegamenti E1 o T1, RJ-45 (modular Jack 8P8C), in modalità TE o NT

Precisione dell'orologio 5 ppm

{{Template:Leistungsmerkmale IT neu - Schnittstellen}}

===Hardware===
800 MHz CPU, 0.25 GB RAM, 64 MB Flash

{{Leistungsmerkmale_IT_neu_-_Hardware_PoE_3}}

{{Leistungsmerkmale_IT_neu_-_Hardware_Umgebung}}

Processore di segnale digitale (DSP) fino a 30 canali

{{Template:Leistungsmerkmale_IT_neu_-_Softconferencing|{{SCNF511}}}}

15 canali per innovaphone Faxserver con T.38 o tramite G.711. In caso di G.711 sono richiesti 2 canali DSP per ciascuna trasmissione fax.

{{Template:Leistungsmerkmale IT - Sprach Coder GW}}

{{Gateway_Firmware_Technische_Daten_IT|myapps=false}}

{{Template:Leistungsmerkmale_IT_-_Lizenzen_Gateways}}

{{Template:CE-Decl_Gateways|Conformità|vedi cheda informativa separata}}
===Numero d'ordine: 01-01130-001===
</div>
{{Template:Datasheet_footer|IT}}
[[Category:Dati tecnici Gateways IT‏‎|{{PAGENAME}}]]