Model: relation/HcsDpVmServiceREL

Voice Mail Service

This procedure adds a voice mail service, associates the service with a Cisco Unity Connection (CUC) server, and integrates it with a Cisco Unified Communications Manager (CUCM).

Prerequisites

To associate the voice mail service with a CUCM, ensure you know the SIP trunking endpoint information between the voice mail server and the CUCM.

Ensure you have a CUC server configured.

Perform these steps:

Set the hierarchy to the correct provider or reseller node.

Go to (default menus) Services > Voice Mail > Voice Mail Service.

Click the Plus icon (+) to add a voice mail service.

Fill out details for the voice mail service:

At Voice Mail Service Name, fill out a name for the voice mail service. Ensure there are no spaces in the name.
At Cisco Unity Connection Cluster, choose the name of the CUC server for the voice mail service.

Note

The CUC server must have been added at the Provider level (via Apps Management > CUC. This is also the location whether the voice mail server in a multi-tenant environment is categorized as Dedicated or Partitioned. This determines what elements are available to the voice mail server, for example, whether another tenant should be created on the voice mail server.
To integrate the voice mail service with CUCM, select the Integrate with CUCM check box. The default is disabled (unchecked).

If CUCM will manage the voice mail service, choose the CUCM to be paired with the CUC server, from the Cisco Unified CM Cluster drop-down.

Note

The CUCM must have been added and configured at the Provider level, via Apps Management > CUCM.

Complete the SIP trunk provisioning information (between the SIP trunk and the CUC server) in the following fields:
- At Cisco Unity Connection Server Address, fill out the hostname or IP address of the voice mail server.
- At Cisco Unity Connection Server Port, fill out the voice mail server port number (1 to 65535).
  
  Note
  
  Do not use port 5061, which is reserved for secure SIP.
- At Cisco Unified CM Server Address, fill out the hostname or IP address for the voice mail server to reach the CUCM.
- At Cisco Unified CM Server Port, fill out the CUCM port number.
  
  Note
  
  Do not use port 5061, which is reserved for secure SIP.
  
  Only one CUCM and one CUC can be specified here. To support redundancy and failover in a multinode configuration, the trunk information must be manually updated on the UC apps.
- At Voice Messaging Ports, fill out the number of voice messaging ports to be created for the voice mail service and associated with the appropriate Port Group on CUC 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 CUC license files. If the license files do not enable the total number of ports, you will
  
  System Message: ERROR/3 (<string>, line 88)
  
  Unexpected indentation.
  
  not be able to add the new ports.
To also integrate a Voice Mail Webex Dedicated Instance with CUCM, select the Integrate with Cisco Unified CM Webex DI check box.
- Only the Voice Mail Trunk Address dropdown is shown with entries existing and available on the selected Cisco Unified CM Cluster - which will be associated with the Route Group as a part of the Route List and Route Group provisioning.
  
  Other fields are now not required and are hidden on the form.

Click Save to add the voice mail service.

Once a shared voice mail service is created, if you have enabled Integrate with Cisco Unified CM:

In CUCM, cluster-level SIP trunk and route group is provisioned for the shared voice mail service.
In CUC, cluster-level port group appears on the PhoneSystem for the shared voice mail service.

Next Steps

Associate Voice Mail Services to Customer

Allow an admin to manage a voice mail service instance.

Model Details: relation/HcsDpVmServiceREL

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
Integrate with Cisco Unified CM Webex DI			Integrate with Cisco Unified CM Webex Dedicated Instance.	Field Name: isWebexDI Type: Boolean
Voice Mail Trunk Address			VM CUCM SIP Trunk.	Field Name: vmCucmSipTrunk Type: String MaxLength: 1024
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