Cisco Unified CM (Extensions)

This document covers the requirements, features and highlights some of the configuration of the DuVoice integration with Cisco Unified Communications Manager (CUCM). This interface will not work with Cisco Communications Manager Express.

DuVoice suggests using the Trunk configuration when using Integration to Cisco Unified Communications Manager. This document is used for older systems still using extensions.

Feature Description
Class of service Yes via Calling Search Space
Direct calls Yes
Call forward RNA/Busy integration Yes
DND Yes, DND for all devices using a DN.
Note: DN must match mailbox.
MWI Yes
Name changes Yes
* DN Changes Note: DN must match mailbox.
* Display (Internal Caller ID).
* ASCII Display (Internal Caller ID).
* Calling Search Space (COS).
* Directory Number Information
* Alerting Name
* ASCII Alerting Name.
User locale Yes. Language change of guest will change phone UI language if Cisco language installed.
  • Cisco Unified Communications - System version: 8.6.2.20000-2 or above.
  • DuVoice 5.30 or above.
  • Lan with internet access.
  • Network connection between DuVoice and Cisco.
  • Only Cisco Administration XML versions 12, 11, 8.5 and 6.0 are supported.

Cisco PBX Configuration

Create an end user account for the voicemail to login.

  • User ID
    Enter the primary number for the DuVoice system. In these examples we used the extension 2001.
  • Password
    Enter any alphanumeric value you like. This will be entered in the Password field when configuring the voicemail port.
  • PIN
    Enter anything you like, this field is not used.
  • Last name
    You must enter a something in this field.
  • First name
    Not required.
  • Telephone Number
    Enter the extension number entered for the User ID field.

Create a phone device to represent the voicemail system.

  • Calling Search Space for non partitioned PBX Default = none.
  • Calling Search Space for partitioned PBX Select a partition that will allow the DuVoice to call to rooms and extensions that are using the DuVoice system.
  • MAC Address
    Enter the same MAC address which the Dialogic HMP is licensed for. This field is entered without any colons.
  • Digest User
    Choose the end user account you created in the previous step.

Create a line device for this phone device.

  • Forward Busy Internal
    Enter the operator or front desk extension.
  • Forward Busy External
    Enter the operator or front desk extension.
  • Forward No Answer Internal
    Enter the operator or front desk extension.
  • Forward No Answer External
    Enter the operator or front desk extension.
  • Forward Unregistered Internal
    Enter the operator or front desk extension.
  • Forward Unregistered External
    Enter the operator or front desk extension.

Run System Configuration to continue configuring the system.

Line 1

  Double click SIP Line 1.
  Click SIP Configuration tab.
  Account name
  Enter the User ID created in the steps above.
  Password
  Enter the password created in the steps above.
  Realm
  Enter ccmsipline. If you have created another SIP Realm for the voicemail enter it here instead.
  Enable Register
  Check.
  These settings are the default created by the Setup Wizard. Your Dialogic IP Address will be set to the IP Address your Dialogic PowerMedia HMP software has been licensed for.
  Click Ok to save these settings.

All other lines

  All other lines should be configured with a blank entries for Account name, Password and Realm.
  Enable Register
  Uncheck.

This concludes the configuration of the PBX and the voicemail system. System Configuration should show something like the following. PBXLink

The PBXLink provides all the guest name changes. Overview

DuVoice uses the Cisco Administration XML (AXL) API for all changes. This interface provides mechanisms for inserting, retrieving, updating, and removing data from the Unified CM configuration database and is provided by Cisco.

DuVoice uses it’s internal extension directory to find matching DN’s on the CUCM. If multiple DN’s have the same number it will change the settings for each of the DN’s. The extension must be an exact match and does not support partial matches.

All changes are made to the DN’s with the exception of the DND state. In this case any device which a DN appears on will have it’s DND changed regardless if the DN is the primary appearance or not.

The ability to change end user settings relies on the Telephone Number field matching that of the DuVoice extension number. The creation of End Users for room phones is not encouraged and therefore this feature is optional. PBX Configuration

  Analog Gateways
  When using analog gateways they should be configured to use the SCCP protocol in order for the DuVoice to resolve all the DN’s.
  Administration XML Installation
  The Administration XML (AXL) interface is a an application plugin which must be installed. This installation is done from the Application|Plugins and choosing Cisco AXL Toolkit.
  Calling Search Space
  The Calling Search Space (CSS) is used to restrict guests phones from making certain types of calls. Only the CSS of the matching DN’s are changed and not that of the device they may be configured for.

DuVoice Account

An application user account must be created for the DuVoice to access the Cisco. This account must be a member of axlGroup and have the Role Standard AXL API Access under the Permissions Information fields. The account user id and password may be set to anything desired. These will be used in the configuration of the DuVoice system discussed later in this document.

DuVoice Configuration (Part 2) Connector

Configuration of the Cisco interface can be found in System Configuration|Features|Connectors|Cisco.

  Server
  For the Server enter the IP address or DNS name of the Cisco Unified Communications Manager.
  User ID
  Enter the user id of the DuVoice application account created in CUCM.
  Password
  Enter the password of the DuVoice application account created in CUCM.
  TCP/IP Port
  Must be set to 8443 unless changed by the Cisco administration.
  Retries
  Enter the number of retries in case of failure.
  Interval (seconds)
  Enter the number of seconds between retries.
  Type
  Choose Call manager.

An application user account must be created for the DuVoice to access the Cisco. This account must be a member of axlGroup and have the Role Standard AXL API Access under the Permissions Information fields. The account user id and password may be set to anything desired. These will be used in the configuration of the DuVoice system discussed later in this document.

In the Idle URL field enter the web address of your the xml file used to instruct the phone to clear call history. 6.01 and Above

Create a file with the following contents and place it on a web server which Cisco phones can reach. If the site does not have a web server of their own then the Apache server on the DuVoice can be configured to supply this file by the customer.

<CiscoIPPhoneExecute>
<ExecuteItem URL="Init:CallHistory"/>
<ExecuteItem URL="Init:Services"/>
</CiscoIPPhoneExecute>

Changing a phone locale is optional and must be configured manually within the hospitality settings in System Configuration. Enter the language string which is sent to the PBX for each language. These language strings must match the userLocale settings in Cisco. Requirements

Language packs installed on the Cisco. These are available from Cisco provided the system is under a support contract.

Configuration

Settings are read for each change sent to the Cisco and a restart is not needed. The string entered for a language is unknown. We currently have no documentation on where this setting can be found in the Cisco.

Version 5

Changing a phones locale is optional and must be configured manually. This features is only useful when using digital phones in a room.

  • The locale for a phone is set each and every time we make a change to the Cisco.
  • If a room is configured for the Default language the system will read the current Default language number and attempt to use that.
  • If a matching number is not found in sysconfig.ini then no change will be made.
  • Settings are read for each change sent to the Cisco and a restart is not needed.
  • The value entered for a language number is unknown. We currently have no documentation on where this setting can be found in the Cisco.
Requirements
  • 5.30
    Language packs installed on the Cisco. These are available from Cisco provided the system is under a support contract.
Configuration
  • Open the file c:\vs\database\sysconfig.ini.
  • Locate the section for your Cisco Configuration. For the default location it should be [Default Location_CISCO_USERCONFIG].
  • For every language in the system enter the required user locale.
Example
[Default Location_CISCO_USERCONFIG]
101=US English

201=Spanish

You can quickly check if AXL is listening on the correct port by opening your browser of choice and browsing to the interface. In this example CUCM is located at the IP address 192.168.11.19 and which would be replaced with the IP address or DNS name of the local CUCM. Example URL is https://192.168.11.19:8443/axl.

Click Continue to this website (not recommended).

Enter the user id and password of the application account associated with the DuVoice.

If the user name and password are correct you will be presented with this screen.

  • Last modified: 2023/08/24 11:40
  • by jd