===== Zultys =====

==== Instructions for MX Integration with DuVoice Property Management System (PMS) =====

//Bill Vlahos March 28, 2023//

=== Goals ===

Integrate with DuVoice for hotel-centric services such as Wakeup Calls, Voicemail, etc. DuVoice integration overview [[http://www.duvoice.com/solutions/pms-pbx-integration/|here]].

=== Call Flow Scenario examples ===

== Voicemail == 
  * A call comes into room extension
  * If unanswered, forward to the DuVoice system for voicemail (not in MX)
== Hotel Services ==
  * Guest check voicemail
  * Set Wake Up Call
  * Receive “call front desk” messages
  * Check in/out
== Hotel Staff Services ==
  * Housekeeping
  * Repair
  * Room clean/dirty status
  * Enable/disable room mailbox
  * Deliver welcome message

==== Orientation ====
The MX will be used for calling functions such as making and receiving calls and requesting services. The DuVoice system is the hotel management system. The MX will initiate or forward calls to the DuVoice system over a SIP trunk.

==== MX Setup ====

=== SIP Ports to DuVoice system ===
The DuVoice system supports UDP and TCP. The example below uses UDP 5060 and UDP 5080. MX will establish a SIP trunk to the DuVoice system UDP 5080.

{{:images:integration:zultys:sip-ports-to-dv-system.png?direct|}}

=== SIP Server Settings ===

SIP Transport UDP Port 5080. SIP Headers values use defaults except for Caller ID/FROM Header set to Originating party Caller ID.

=== Dial Plan ===

The Dial Plan will forward calls to the SIP trunk.

{{:images:integration:zultys:dial-plan.png?direct|}}

=== Users ===

Create Room Extensions (i.e., Users). The extension number should not match the room number to obfuscate the actual extension.

{{:images:integration:zultys:users.png?direct|}}

Room extensions (i.e., user extensions) will have a Call Handling Rule to forward calls **When I am on the phone or No answer after 24 seconds**.

{{:images:integration:zultys:call-rule-fwd-to-dv.png?direct|}}

=== Speed Dial Buttons ===

Phones can be set up with speed dial buttons for Front Desk, etc.

=== Restrictions ===

Rooms are set up so they can’t call each other via the Dial Plan or Call Handling Rules. They can only make or receive calls to hotel service extensions such as the Front Desk, Room Service, etc.

=== Devices ===

If using non-Zultys phones, create generic SIP devices. The default setting is fine. Check box **Can register unmanaged device**. Assign phone to room extension.

==== DuVoice Configuration ====

//From Shaun Sorensen at DuVoice.//

=== PBX Settings ===

DuVoice PBX configuration documentation [[vs8:vsconfig:telephony:settings:sip|here]].

{{:images:integration:zultys:dv-config-pbx.png?direct|}}

=== Lines ===

DuVoice line configuration documentation [[vs8:vsconfig:telephony:settings:lines|here]].

{{:images:integration:zultys:dv-config-lines.png?direct|}}

=== Message Waiting Indicator (MWI) ===

DuVoice will send MWI to phones directly as normally the MX controls this utilizing the MX’s voicemail system. This means that the phones will need to have static IP addresses.

=== Billing ===

Typically hotels utilize the SMDR function for billing guests. This should work fine on the MX.

=== Advanced Integrations ===

DuVoice can further integrate with phone systems using APIs. Jeff Limb has the API details.

  - Change the first and last name of the MX User account. This helps automate guest billing.
  - Restrict the phone at checkout to prevent someone from making calls, etc. when the room is not occupied. This has not been tested but it should work with the API changing user profiles.


=== Limitations === 

DuVoice can further integrate with phone systems using APIs. Zultys doesn’t currently support these administrative-type APIs, but we are considering building them in the future.

Enable DND setting.

=== Sales Process ===

These are the primary questions that the CP will need to gather and the process of requesting a DuVoice quote. We will want to have a conference call/meeting with Andy, Jon, and our Product Management staff to understand the flow for requesting a quote from DuVoice, steps for purchasing, and steps for scheduling installation, cross-marketing, etc.

  - Total Number of Rooms
  - Hotel Property name and address
  - PMS (Property Management System)
  - Does this Hotel Property require Call Accounting?

After gathering the following information, the CP will contact sales@duvoice.com or 800-888-1057 for a quote. Once the quote has been accepted, the CP can provide the quote for placing the order with one of the following Distributors (Jenne, ScanSource, Synnex, and Ingram).