Metaswitch

  • Configuring DuVoice as a Metaswitch CFS Application Server.
    • Telephony integration done with a Metaswitch CFS using a SIP Application Server.
    • Hospitality integration using the MetaSphere EAS CommPortal connection.
  • The DV2000 provides Metaswitch a suite of hospitality features including an interface to the hotel PMS system:
    • Guest information
    • Guest voice messaging
    • Wake-up call
    • Housekeeping room status reporting.
  • Subscriber name change.
  • Call Bar enable/disable based on state of room using hospitality groups.
  • DND enable/disable.
  • Support for multiple business groups.
  • Message light controls.
  • Room status /maid code live update.
  • Guest and staff personal voicemail.
  • Wake-up call scheduling and alerting.
  • Metaswitch 9.0 or above.
  • One Metaswitch SIP Extension per 150 rooms.
  • MetaSphere EAS (CommPortal).
  • A Metaswitch Level 3 SIP Trunk to DuVoice if using SIP trunking instead of SIP extensions.
  • DuVoice v7.2+

CSB

  • Create a Configured SIP Binding (CSB) that points to the DuVoice server.
    • Set Usage to Application Server.
    • Configure Use DN as appropriate for the deployment for:
      • identification
      • SIP authentication (if required)
      • Contact IP/address
      • Contact Port
      • transport
      • Remote Media Gateway Model (RMGM)
        • If an existing RMGM does not match the DuVoice requirements, create a new one.
    • Example image:

Create DuVoice Application Server entry

  • Create the Application Server using the CSB from previous step.
  • Assign a Directory Number (DN) to the Application Server
    • Use that same DN in the DuVoice configuration.
  • Set Server type to Voicemail.
  • Example image:

Assign subscriber DNs to DuVoice Application Server

  • Assign the appropriate subscriber DNs to use the DuVoice Application Server.
    • This can be configured as a direct override on individual DNs or through a persistent profile.
      • Depending on how the CFS is administered.
  • Example image:

Telephony Settings - PBX Tab

  • The DuVoice PBX Address is the DNS name of the CFS.
    • A direct IP address may also work when appropriate for the network and SIP configuration.
  • Example image:

Telephony Settings - Line Tab

  • Example image:

Telephony Settings - Options Tab

  • Configure MWI
    • Redirect SIP notify
  • Example image:

Telephony - Call Routing

  • Example image:

Mailbox Configuration - General Tab

  • Example image:

Mailbox Configuration - MWI Tab

  • Example image:

There are three different MetaSphere API interfaces that are available for hospitality guest phone call controls and name changes from the DV2000 server.

  • Network-Wide Web Services API
    • Preferred
  • MetaSphere EAS API
    • Not Preferred
  • MetaView Web Services
    • Least Preferred

Network-Wide Web Services API (Preferred)

  • This interface is the suggested method of integration.
    • This interface must be used for any Clustered CFS deployments which can be an advantage for many hosted solutions.
    • It also doesn't require any specific steps to enable the Network-Wide Web Services API.
    • It is Automatically available on any MetaView Server or MetaSphere EAS server that is running MetaView Web.
  • Requirements:
    • User account can be any MetaView Web user with the option “Can use Network-Wide Services API” enabled.
    • Create a username and password.

MetaSphere EAS API (Not Preferred)

AKA CommPortal JSON API.

  • The CommPortal JSON API is available to use if the Network-Wide API is not available or wanted.
  • This API provides the DuVoice with all features using a username and password.
  • Requirements:
    • User account making changes must be an EAS Administrator for the Business Group.
    • For hospitality phone controls.

MetaView Web Services (Least Preferred)

  • Not commonly used
    • This API is the original API supported by DuVoice
    • Requirements:
      • MetaView Web Services enabled.
      • Issues:
        • This is a “trusted” API and there is no security or authentication.
        • If you enable this interface, make sure you restrict access to it.
          • For example by using a firewall to restrict access to the TCP port it uses 8080.
  • Using DV2000 Manager:
    • Select: Site.
    • Select: Profiles.
      • Under Details:
        • Select: Metaswitch.

Network-Wide Web Services API (Preferred)

Option Setting Notes
Interface Network-Wide Web Services
Network
PBX URL <PBX-URL> Full URL of PBX. Example: http://web-server:8087/mvweb/services/ShService or https://web-server:8445/mvweb/services/ShService.
Web Services
Switch Name <Switch-Name> Name of Switch, case-sensitive.
Business Group <Business Group> Name of Business Group, case-sensitive.
Account
Username <Username> MetaView Web user with option Can use Network-Wide Web Services API enabled.
Password <Password> Password, case-sensitive.

CommPortal (Not Preferred)

DuVoice PBX-LINK (CommPortal) for Metaswitch integration can be found here.

Option Setting Notes
Interface MetaSphere EAS (CommPortal)
Network
PBX URL <PBX-URL> Full URL of PBX. Example: http://web-server:8087/mvweb/services/ShService or https://web-server:8445/mvweb/services/ShService.
Web Services
Switch Name <Switch-Name> Name of Switch, case-sensitive.
Business Group <Business Group> Name of Business Group, case-sensitive.
Account
Username <Username> MetaView Web user with option Can use Network-Wide Web Services API enabled. For CommPortal this is a subscriber phone number and must be a Business Group Administrator.
Password <Password> Password, case-sensitive.

MetaView Web Services (Least Preferred)

Option Setting Notes
Interface MetaView Web Services
Network
PBX URL <PBX-URL> Full URL of PBX. Example: http://web-server:8087/mvweb/services/ShService or https://web-server:8445/mvweb/services/ShService.
Web Services
Switch Name <Switch-Name> Name of Switch, case-sensitive.
Business Group <Business Group> Name of Business Group, case-sensitive.
Account
Username <Username> MetaView Web user with option Can use Network-Wide Web Services API enabled.
Password <Password> Password, case-sensitive.
  • After configuration, verify the complete call and MWI path:
    • Call a subscriber DN from an external number and leave a voicemail.
    • Call the same subscriber from an internal extension and leave a voicemail.
    • Confirm DuVoice maps the called number to the correct mailbox.
    • Confirm the CFS accepts the DuVoice SIP NOTIFY and the phone displays MWI.
    • Delete or listen to the message and confirm the MWI clears.
  • Last modified: 2026/09/16 11:38
  • by jh