Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


...



Html
<div id="fb-root"></div>
<script>(function(d, s, id) {
  var js, fjs = d.getElementsByTagName(s)[0];
  if (d.getElementById(id)) return;
  js = d.createElement(s); js.id = id;
  js.src = 'https://connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.11';
  fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));</script>

...

Html
 <div class="lang-box-pdf">
	<div>
		<div class="google-lang">
			<div id="google_translate_element">
			</div>
			<script type="text/javascript">
					function googleTranslateElementInit() {
						new google.translate.TranslateElement({pageLanguage: 'en', includedLanguages: 'de,es,fr,it,nl', autoDisplay: false}, 'google_translate_element');
						}
			</script>
			<script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>
		</div>
		
		<div class="pdf-button">
			<a href="https://confluence.wildix.com/spaces/flyingpdf/pdfpageexport.action?pageId=29918192" alt="Convert to .pdf" title="Convert to .pdf"><img src="https://confluence.wildix.com/download/attachments/14549012/pdf-button-download-wildix-documentation.png"></a>
		</div>
	</div>
</div>


Info

Hotel Manager is a part of Wildix WebAPI library. This document explains how to configure and to use Hotel Manager extension.

Created: December 2018

Updated: March 2021

Permalink: https://confluence.wildix.com/x/8IPIAQ

Table of Contents

Introduction

...

To be able to access Hotel Manager you need Wildix Collaboration license or UC-Business user profile (more information on Per User licensing: https://manualswww.wildix.com/licensing/).

Features available with Hotel Manager:

...

Now you can add rooms in WMS -> Users in the same way as you add users. For more information on adding users, please consult WMS Start Guide - Adding users manually.

When adding a room, specify user type - "Room", in this way you will be able to differentiate hotel rooms from normal PBX users and License type to Basic:


Note

By default "users" Dialplan is assigned to each room, however you can create a separate Dialplan for managing calls placed from hotel rooms in WMS -> Dialplan and assign this Dialplan to each room in the field "Dialplan"

Here is an example of WMS → WMS -> Users configuration, where four hotel rooms are present, located on two floors:

...

To access the Hotel Manager interface, you can use our online demo available at at https://wwwwebapi.wildix.com/v2/hotelManager/index.html (the new version, available starting from WMS 5.02.20201015.2)/ https://webapi.wildix.com/v1/hotelManager/ (the old version).

Warning

If you are using our online demo or if you have uploaded Hotel Manager on your server, you need to add the domain to the whitelist in WMS Settings → PBX → Securitywildix.com (for the old version) and webapi.wildix.com to the whitelist in WMS Settings -> PBX -> Security; see documentation: Domain Whitelist (Allow Origin).

If you are having issues with accessing Hotel Manager, read the WebAPI document - Access WebAPI Demo.

...

Info

You can also use Hotel Manager in the following ways:

  • use Hotel Manager on your web server accessible via HTTP/HTTPS - download the JavaScript library from the Wildix website and the dedicated server: the new version (starting from WMS 5.02.20201015.2)/ the old version and then upload the Hotel Manager folder on your server
  • upload Hotel Manager on your Wildix PBX - follow the instructions published in WebAPI documentAccess WebAPI Demo 

To access the Hotel Manager page, select the PBX user to use for access to the Hotel Manager interface (receptionist), and make sure that:

  • Collaboration web page is open at the same time as the Hotel Manager for that user on the same PC in the same browser
  • This user is of "admin" type (otherwise you will not be able to update the guest's name upon check-in):


  • hotel Hotel rooms are added to the roster of your user; you can add rooms to your roster from Collaboration → Other → -> Other -> Edit Colleagues (read Collaboration guide - Colleagues (roster) for more information) or in WMS → Users → -> Users -> select a user and click Edit preferences, then scroll down to Roster (read WMS Start Guide - User preferences for more information):


Now you are ready to access Hotel Manager interface. Go to https://wwwwebapi.wildix.com/v1/hotelManager/ or https://webapi.wildix.com/v2/hotelManager/ and click "Settings" icon ("Wheels" icon in the upper right corner) to enter your PBX credentials:

Credentials for the version 1:

  • Host: URL of your Wildix PBX, example: elenacloud.wildixin.com 
  • Extension: extension of user* to access Hotel Manager
  • Password: your Web password for access to Collaborationyour Web password for access to Collaboration
  • Click Tick icon to access

Credentials for the version 2:

  • Host: URL of your Wildix PBX
  • OAuth 2.0 Application ID: ID for authentication, it is generated in WMS Settings -> PBX -> Integrations -> OAuth 2.0 applications, more details in WebAPI Admin Documentation
  • Redirect URI is hardcoded
  • Click Tick icon to access


You should be able to view rooms subdivided by their "Group" field ("Floor 1" and "Floor 2" in our case):

...

Check-in and Check-out

  1. Press "Check-in" icon from the interface to check-in a guest


  2. On the next step you can enter the guest's name


  3. Guest's name is updated both on Hotel Manager interface, in WMS interface, on the display of a WP4X0 series installed in the room

After you press " Check-out" icon, the guest information is updated in Hotel Manager interface, in WMS, on the phone's display--the guest is removed from the room.

...

For the correct processing of wake-up calls you need to configure a new Dialplan procedure in WMS → WMS -> Dialplan.

Create a new procedure and name it "alarmclock": 

  • Called number: X.
    • Dial the phone  -> wake-up call is placed to the room 
    • Set - Caller nameFailed Alarm Clock-${EXTEN} →  -> in case wake-up call failed (e.g. no answer / reject), caller name is changed to "Failed Alarm Clock-<room number>"
    • Dial the phone - 324 (receptionist extension number)  → -> receptionist will receive a call in case of failed alarm clock and as caller name the following information will be displayed "Failed Alarm Clock-1001" (where 1001 is the room number)
  • Called number: alarm
    • Play sound - select the ring tone or upload a new one (this sound is played to the guest after they answer a wake-up call)

By default, Dialplan procedure "alarmclock" is used for managing wake up calls, if present on the PBX. In case you want to use some other Dialplan procedure to manage wake up calls, you have to specify it in Hotel Manager Settings - "Dialplan" field (click the "Wheels" icon in the upper right corner):

Warning

Current limitation: please note that in case you change the Dialplan procedure used to manage wake up calls, the change will not be applied automatically right away, you can force it, by exampby rebooting the PBX by example. 



Info

Guests can set up wake up calls directly from the room: dial Feature code 773 and follow the audio instructions. In case a guest places a wake-up call request from the room, the information will be updated on the Hotel Manager web interface automatically.

...

For the correct charging of call costs, it is necessary to upload pricelists in WMS → Trunks → WMS -> Trunks -> Pricelists. To download a pricelist template and for the information on how to upload pricelists on the PBX, please refer to the WMS Start Guide - Pricelists:

After you have uploaded a pricelist, do not forget to associate the trunk used for outgoing calls with the priceslist in WMS -> Trunks.

After you have uploaded a pricelist and associated the trunk with it, authorized users can view the call costs in CDR-View:

...

PBX differentiates national calls from foreign calls based on International Prefix in WMS → Dialplan → General -> Dialplan -> General settingsCountry code in trunk settings is used for number normalization (number is not normalized if country code is empty). It is recommended to create a separate ACL group for hotel rooms, as explained in the chapter Add rooms. In this way you will be able to restrict calls to certain destinations. For more information on recommended ACL restrictions and call class management, please carefully read the document ACL rules and Call classes management.

...

If you would like to block outgoing calls from vacant hotel rooms, you need to create a new Dialplan procedure in WMS → WMS -> Dialplan.

In this Dialplan procedure the variable "${DB(allowcalls/${CALLERID(num)})}" is applied, where "allowcalls/EXT" reflects the state of the room according to the Database (DB) value:

...

Enable PIN bypass for ACL restricted calls

This feature may often be applied to phones located in hotel common areas or in conference rooms. Here is an example:

  1. User dials a number that is restricted on this phone (for example, international phone number)

  2. User is prompted for the PIN since the call is not allowed from this phone normally

  3. User enters the PIN and if allowed based upon the entered PIN, the system routes the call to the restricted destination

...