RingCentral
The DuVoice DV2000 provides hospitaility features to RingCentral hosted VOIP service. The features include a link to the property management system (PMS) to push the guest names into the RingCentral guest room extension profile, allow housekeeping to use the guest room telephone to report room clean/dirt status to the PMS, guest wakeup calls and guest voice mail. The DV2000 connects to the RingCentral system using a combination of standard SIP extensions and through a RingCentral App developed by DuVoice. New or existing guest VOIP or analog telephones can be used in the application. The features will meet and/or exceed any existing on premise based PBX solution.
Features
- Forward guest extension to DV2000 for guest voicemail
- Auto login ti guest mailbox with no password
- Wakeup calls set by guest or staff
- Extension or telephone (DID) number based
- First and last name change in RingCentral
- Room Clean/Dirt Status from guest room telephone
- Set DND or wakeups from PMS
- Guest room telephone restrict/un-restrict using roles
Requirements
- DuVoice 8.0.33 or above.
- One RingCentral Extension per room
- One RingCentral user extension DV2000 port
- Call Queue for DV2000
- DuVoice RingCentral App added through Super User account
Network Considerations
- Two NIC connections are recommened (not required) to separate the VOIP and PMS data links. Two NICs are provided on a DuVoice Nano appliance.
- The DV2000 sends the message light (SIP Notify) directly to the guest room telephone which requires the guest telephone IP address be stored in the DV2000. Several telephones can be configured to send the IP address to the DV2000. If not the telephones have to have fixed IP addresses.
Creating the User Extensions for the DV2000 ports
The DV2000 requires one user extension per port.
*These settings for each extension must be provided to the DuVoice tech to enter into the DV2000 configuration:
Setting up the Call Queue
Setting Up Guest Extensions
RingCentral JWT credential
- Create a virtual User
- On the Ring Central Admin Portal Home Screen
- Select Add User
- Under User Type select Video Pro User
- Add email (Note: this needs to be a unique email a tech can log into and to finish setup)
- Enter First Name: DV2000 Last Name: Hospitality
- Site: Select the organization (If more than one, group with hotel room users)
- Select Next
- Setup Option: Send Invite
- Edit Role: Select Super User
- Using the email that was sent select the Set Up Account button
- Enter a password (this email and password will be used for creating credentials below)
- Log into the DuVoice Hospitality Account
- On the Ring Central Admin Portal Home Screen
- Log in using the new credentials for the DuVoice Hospitality user
- On right select Developer Portal
- If needed required use the same credentials for the DuVoice Hospitality user
- On the Welcome screen select SKIP
- On upper right your will see DuVoice with a drop down arrow and select Credentials
- Select Create JWT
- For the Label enter DuVoice Hospitality
- For the Environment select Production
- For Apps Permitted select: Only specific apps of my choice
- Enter Client ID #: qagg5jl_Q-WgoN3ieVdP3Q
- Then select Add App
- You should see:
- App Name : DV2000 Hospitality
- Provider: DuVoice Corporation
- Leave Expiration Date blank
- Select Create JWT (lower right)
- Copy the JWT onto the clipboard
- Use the JWT Credential in the DV2000 configuration.
DV2000 Programming
Telephony
Lines
PBX Configuration
Note: Proxy server port number despite showing as 5096 within Ringcentral configuration needed to be set to 5090 within DuVoice configuration for registration to occur.
Options
Call Routing
Mailboxes
General
MWI address
PBX Link
Profile
** More details on LINK-PBX configuration: https://support.duvoice.com/vs8/pbxlinks/ringcentral
Troubleshooting
Name Updates
When testing with a checked-in guest, the RC API getting 200 OK.
However, when a guest was checked-out, the RC API was responding with a 400 Bad Request.
To fix this issue:
- Opened DuVoice DV2000 Manager.
- Clicked on 'System'.
- Then clicked on 'tenant'.
- Then double-clicked the corresponding tenant.
- Then clicked on the 'name translations tab'
- By default under the 'vacant' table the 'first' and 'last' use the wild cards for the first and last name corresponding to the mailbox.
- Updated it so that the 'first' field was 'Room' and the 'last' field was the wildcard for roomid.
Example below:
MWI Consideration
Since Dialogic HMP can only be bound to one interface, the interface it is bound to must have internet access to RingCentral as well as direct network access to the phones so it can send MWI updates via SIP Notify.
Not Enough Rings for Wake-Up Calls
If Wake-up calls are only ringing once or twice. (Not to be confused with attempt count). Then there are a few settings within RingCentral that will need to be verified for the guest extensions.
Within the guest extension configuration under 'Screening, Greeting, & Hold Music' all of these must be unchecked:
- User Greeting
- Call Screening
- Connecting Message
- Hold Music
Example screenshot:
Ring No Answer Integration
If a forwarded call has more than the DID or Extension information within the SIP Header, specifically the 'from' and 'to' fields, the DuVoice system will be unable to route the call to the correct mailbox.
In our test case, we were recieving the name of the guest within the room and the extension, rather than just the extension (or DID).
Here is a example of working SIP RNA integration:
To fix our issue, there was a setting within the DuVoice Call Queue inside of RingCentral.
- Call Handling & Members
- Under 'Display Settings'
- Call information displayed:
- Box 1: Phone Number
- Box 2: None
Example screenshot:
Guest Mailbox Design
While this could be flexible and still work, these options worked best during testing.
Mailbox fields
- RoomID = Room Number.
- Mailbox = Guest's extension number.
- Extension = Guest's DID number.
- MWI0 = Guest's DID number (this is so IPPHONECFG can autofill the IP address to the DID for the MWI address).
Call Routing
Enabled extension search for called and caller ID.
- Open DV2000 Manager
- Click on 'telephony' drop down menu.
- Click on 'call routing'
- Click insert.
- Set 'enabled' to checked, 'input source' to 'caller id', 'action to take' to 'extension search'.
- Click insert.
- Set 'enabled' to checked, 'input source' to 'called id', 'action to take' to 'extension search'.
- Click 'apply' and 'save'.
PMS integration
Use RoomID to avoid requiring a translation table.
- Open DV2000 Manager
- Click on the 'features' drop down menu.
- Click on 'hospitality'.
- Click on the applicable PMS link.
- Click on the 'PMS tab'.
- Under the 'Room lookup method' field, select 'match room ID'.
- Click 'ok'.
