.. _create-voice-mail-service:

Voice mail services 
-------------------------

.. _21.4-PB3|EKB-17166:
.. _24.2-PB1|EKB-21856:


.. tip:: 

   :ref:`use-action-search-to-navigate-automate`


Add 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 (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**:

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

    .. note:: 

       The voice mail 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 voice mail service: 

    .. tabularcolumns:: |p{5cm}|p{10cm}| 

    +-------------------------------------------+-------------------------------------------------------------+
    | Field                                     | Description                                                 |
    +===========================================+=============================================================+
    | Voice Mail Service Name                   | The voice mail service name. Ensure there are no spaces in  |
    |                                           | the name.                                                   |
    +-------------------------------------------+-------------------------------------------------------------+
    | Cisco Unity Connection Cluster            | Mandatory. The name of the CUC server for the voice mail    |
    |                                           | service.                                                    |
    |                                           |                                                             |
    |                                           | .. note::                                                   |
    |                                           |                                                             |
    |                                           |    * The CUC server must have been added at the Provider    |
    |                                           |      level.                                                 |
    |                                           |    * This is also where the voice mail server in a          |
    |                                           |      multi-tenant environment is categorized as *Dedicated* |
    |                                           |      or *Partitioned*, which defines the elements available |
    |                                           |      to the voice mail server, for example, whether         |
    |                                           |      another tenant should be created on the voice mail     |
    |                                           |      server.                                                |
    +-------------------------------------------+-------------------------------------------------------------+
    | Integrate with Cisco Unified CM           | Defines whether to integrate the voice mail service with    |
    |                                           | UCM (UCM will manage the voice mail 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 voice mail 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 voice mail 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                   |
    |                                           | voice mail services for Webex DI.                           |  
    +-------------------------------------------+-------------------------------------------------------------+


    .. tabularcolumns:: |p{5cm}|p{10cm}| 

    +-------------------------------------------+-------------------------------------------------------------+
    | 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 voice mail 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 voice mail 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 voice mail 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).     |
    +-------------------------------------------+-------------------------------------------------------------+


    .. tabularcolumns:: |p{5cm}|p{10cm}| 

    +-------------------------------------------+-------------------------------------------------------------+
    | Field                                     | Description                                                 |
    +===========================================+=============================================================+
    | Voice Messaging Ports                     | Mandatory. 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. 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 voice mail service. 

   Once a shared voice mail 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 voice mail service.
   * In CUC, cluster-level port group appears on the PhoneSystem for the shared voice mail service.



.. rubric:: Next steps

* :ref:`assoc-voice-mail-services-to-customer`



.. _delete-voice-mail-service:

Delete voice mail service
..............................


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

   Once the transaction completes, the voice mail service is removed from the list. 