Model: relation/HcsDpVmServiceREL

Voice Mail Service

Before You Begin

To associate Voice Mail Service with a Cisco Unified Communications Manager (Unified CM), you must know the SIP trunking endpoint information between the Voice Mail Server and the Unified CM.

A Cisco Unity Connection server must be configured before performing this procedure. For more information, see "Set Up Cisco Unity Connection" in the VOSS-4-UC Core Feature Guide.

Procedure

Make sure that the hierarchy path is set to the correct provider or reseller node.

Choose Services > Voice Mail > Voice Mail Service.

Click Add to add a Voice Mail Service.

Enter a Voice Mail Service Name if desired. Do not add spaces in the name.

From the Cisco Unity Connection Cluster drop-down, choose the name of the server for the voice mail service.

Note: The Cisco Unity Connection server must be previously defined under the Provider level at Device Management > CUCs. This is also the location whether the Voice Mail server in a multitenant environment is categorized as Dedicated or Partitioned. This determines what elements are available to the Voice Mail Server, whether another tenant should be created on the Voice Mail Server, and so on.

To integrate the Voice Mail Service with Unified CM, select the Integrate with Cisco Unified CM check box. Default = unchecked.

If Cisco Unified CM manages the Voice Mail Service, choose the Cisco Unified Communications Manager to be paired with the Cisco Unity Connection Server from the Cisco Unified CM Cluster drop-down menu.

Note: The Unified CM must be previously defined under the Provider level at Device Management > CUCMs.

Complete the SIP trunk provisioning information (between the SIP trunk and the Cisco Unity Connection server) in the following fields:

Enter the hostname or IP address of the Voice Mail Server in the Cisco Unity Connection Server Address field.
Enter the Voice Mail Server port number (1 to 65535) in the Cisco Unity Connection Server Port field.

Note: Do not specify port 5061, which is reserved for secure SIP.
Enter the hostname or IP address for the Voice Mail Server to reach the Unified CM in the Cisco Unified CM Server Address field.
Enter the Cisco Unified Communications port number in the Cisco Unified CM Server Port field.

Note: Do not specify port 5061, which is reserved for secure SIP.

Note: Only one Unified CM and one Cisco Unity Connection can be specified here. To support redundancy and failover in a multinode configuration, the trunk information must be manually updated on the UC apps.

In the Voice Messaging Ports field, enter the number of voice messaging ports to be created for the voice mail service and associated with the appropriate Port Group on Cisco Unity Connection when the voice mail service is associated to a customer.

Valid values are 1 - 250. Default = 3. This field is mandatory.

Note: The number of voice messaging ports that you add cannot bring the total number of voice messaging ports for all port groups to more than the maximum number of voice messaging ports that are enabled by the Cisco Unity Connection license files. If the license files do not enable the total number of ports, you will not be able to add the new ports.

Click Save to add the Voice Mail Service you defined.

When a shared Voice Mail Service is created and the Integrate with Cisco Unified CM check box is selected, the following occurs:

In Unified CM: Cluster-level SIP Trunk and Route Group is provisioned for the shared voice mail service.
In Cisco Unity Connect: Cluster-level Port Group appears on the PhoneSystem for the shared voice mail service.

What to Do Next

Perform Associate Voice Mail Services to Customer.

Allow an admin to manage a voice mail service instance.

Model Details

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title

Description

Details

Voice Mail Service Name *

The name for the voice mail service.

Field Name: name
Type: String
MaxLength: 20
Pattern: ^(\S)+$

Voice Mail Cluster *

Field Name: cucClusterName
Type: String
Target: device/hcmf/CUCxn
Target attr: bkCUCxnCluster_name
MaxLength: 1024
Format: uri

Voice Mail Server Device

Field Name: cuc
Type: String
Target: data/UnityConnection
Target attr: host
MaxLength: 1024
Format: uri

Voice Mail Service Mode

Indicates whether the voice mail service is dedicated or partitioned. Default: Dedicated

Field Name: cucSvcMode
Type: String
Default: Dedicated
MaxLength: 1024
Choices: ["Dedicated", "Partitioned"]

Integrate with CUCM

Enable if there is a CUCM associated with the Voice Mail Cluster for this voice mail service.

Field Name: isCucmPresent
Type: Boolean

CUCM Cluster

The CUCM cluster that is associated with this voice mail service.

Field Name: cucmClusterName
Type: String
Target: device/hcmf/CUCM
Target attr: bkCUCMCluster_name
MaxLength: 1024
Format: uri

CUCM Device

The CUCM device associated with this voice mail service.

Field Name: cucm
Type: String
Target: data/CallManager
Target attr: host
MaxLength: 1024
Format: uri

Voice Mail Trunk Address *

The hostname or IP address of the voice mail service.

Field Name: vmServiceAddr
Type: String
MaxLength: 1024

Voice Mail Trunk Port *

The port of the voice mail service (1-65535).

Field Name: vmServicePort
Type: String
MaxLength: 1024
Pattern: ^(?:6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{1,3}|[1-9])$

Remote Trunk Address *

The remote hostname or IP address for the voice mail service trunk.

Field Name: cucmServiceAddr
Type: String
MaxLength: 1024

Remote Trunk Port *

The remote port for voice mail service trunk (1-65535).

Field Name: cucmServicePort
Type: String
MaxLength: 1024
Pattern: ^(?:6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{1,3}|[1-9])$

Voice Messaging Ports *

Number of voice messaging ports to create on voice mail service (1-250). Voice messaging ports can be configured up to the maximum allowed configuration for the voice mail server. Default: 3

Field Name: numberOfPorts
Type: String
Default: 3
MaxLength: 1024
Pattern: ^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|250)$

Shadow

Field Name: shadow.[n]
Type: Array
Cardinality: [0..1]

Name *

Field Name: shadow.[n].name
Type: String
MaxLength: 1024