Model: relation/HcsDpVmServiceREL

Voice Mail Service

Tip

Use the Action search to navigate Automate

Add voicemail service

This procedure adds a voicemail service, associates the service with a Cisco Unity Connection (CUC) server, and integrates it with a Cisco Unified Communications Manager (UCM) and/or Cisco Webex DI (Dedicated Instance).

Prerequisites

To associate the voice mail service with a UCM, ensure you know the SIP trunking endpoint information between the voice mail server and the UCM.
A CUC server must be configured.

Perform these steps:

Log in as provider or reseller administrator.
Set the hierarchy to the correct provider or reseller node.

Note

The voicemail service is always added above the customer level, so either at provider level or reseller level, and is associated to the customer.
Go to Voice Mail Service.
Click the Plus icon (+) to add a voice mail service.

On the New Record page, fill out details for the new voicemail service:

Field	Description
Voice Mail Service Name	The voicemail service name. Ensure there are no spaces in the name.
Cisco Unity Connection Cluster	Mandatory. The name of the CUC server for the voicemail service. Note The CUC server must have been added at the Provider level. This is also where the voicemail server in a multi-tenant environment is categorized as Dedicated or Partitioned, which defines the elements available to the voicemail server, for example, whether another tenant should be created on the voicemail server.
Integrate with Cisco Unified CM	Defines whether to integrate the voicemail service with UCM (UCM will manage the voicemail service). The default is False (unchecked). When choosing Integrate with Cisco Unified CM, the Cisco Unified CM Cluster drop-down displays.
Cisco Unified CM Cluster	The UCM cluster associated with the voicemail service. This drop-down displays only if you've selected Integrate with Cisco Unified CM. From this drop-down, select the UCM to be paired with the CUC server. Note The UCM must have been added and configured at the Provider level (via the CUCM page).
Integrate with Cisco Unified CM Webex DI	Defines whether to integrate a voicemail Webex Dedicated Instance with UCM. When choosing Integrate with Cisco Unified CM Webex DI, the rest of the fields on this form are hidden, and the the Voice Mail Trunk Address drop-down displays. In a UCM Webex DI environment, the routing rules in the Automate provisioning workflow uses the calling search space (CSS) for Webex DI to allow for adding multiple voicemail services for Webex DI.

Field	Description
Voice Mail Trunk Address	This drop-down displays only if you've selected the Integrate with Cisco Unified CM Webex DI checkbox. The drop-down displays available existing entries on the selected UCM cluster, which will be associated with the Route Group as a part of the Route List and Route Group provisioning.
Cisco Unity Connection Server Address	The hostname or IP address of the voicemail server. This field is hidden on the form if you've selected Integrate with Cisco Unified CM Webex DI. This field value is part of the SIP trunk provisioning information (between the SIP trunk and the CUC server).
Cisco Unity Connection Server Port	The voicemail server port number (1 to 65535). Note Do not use port 5061, which is reserved for secure SIP. This field is hidden on the form if you've selected Integrate with Cisco Unified CM Webex DI. This field value is part of the SIP trunk provisioning information (between the SIP trunk and the CUC server).
Cisco Unified CM Server Address	The hostname or IP address for the voicemail server to reach the UCM. This field is hidden on the form if you've selected Integrate with Cisco Unified CM Webex DI. This field value is part of the SIP trunk provisioning information (between the SIP trunk and the CUC server).
Cisco Unified CM Server Port	The UCM port number. Note Do not use port 5061, which is reserved for secure SIP. Only one UCM 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. This field is hidden on the form if you've selected Integrate with Cisco Unified CM Webex DI. This field value is part of the SIP trunk provisioning information (between the SIP trunk and the CUC server).

Field

Description

Voice Messaging Ports

Mandatory. Fill out the number of voice messaging ports to be created for the voicemail service and associated with the appropriate Port Group on CUC when the voicemail service is associated to a customer.

Valid values are 1 - 250. The default = 3.

Note

The number of voice messaging ports you add can't 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 don't enable the total number of ports, you won't be able to add the new ports.

This field is hidden on the form if you've selected Integrate with Cisco Unified CM Webex DI.

This field value is part of the SIP trunk provisioning information (between the SIP trunk and the CUC server).

Save your changes to add the new voicemail service.

Once a shared voicemail service is created, if you have enabled Integrate with Cisco Unified CM:
- In UCM, cluster-level SIP trunk and route group is provisioned for the shared voicemail 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

Delete voicemail service

Log in to the Automate Admin Portal as Provider administrator.
Go to Voice Mail Service.
From the list of voicemail services, select the checkbox for the voicemail service you want to remove.
Click Delete, then click Yes to confirm.

Once the transaction completes, the voicemail service is removed from the list.

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: data/HCSHcmfCUCxnDAT 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
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 Cluster															The CUCM cluster that is associated with this voice mail service.																				Field Name: cucmClusterName Type: String Target: data/HCSHcmfCUCMDAT 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