Installation guide

MiaRec recording announcement solution for Cisco UCM consists of multiple components:

  • Controller. The controller application monitors call events and initiates playback of greeting when the pre-configured conditions match.
  • Player. The playe application is presented as a SIP Trunk in CUCM environment. It plays back the pre-recorded greeting message into the call session.
  • Recorder. The MiaRec recorder component records calls using Built-in-Bridge interface

Cisco recording announcement architecture

This guide describes configuration of the Controller and Player components.

Player - Configuration

The configuration of MiaRec recording announcement player is stored in text INI file SipPlayer.ini.

Section [Main]

Example of configuration:

[Main]

AudioFile=call-maybe-recorded.wav

AudioFile16KHz=call-maybe-recorded-16KHz.wav
  • Set AudioFile to the pre-recorded audio file for announcement message, something like "This call may be recorded". MiaRec comes with a sample audio file. You can use the sample file or record your own. The file format: mono, 8KHz, wav uncompressed.

  • Option AudioFile16KHz is similar to AudioFile, but for calls using high quality wideband codecs (G.722). The file format: mono, 16KHz, wav uncompressed.

Section [SIP]

The recording announcement player behaves as an auto-answering machine. It listens for inbound SIP connection from Cisco UCM, answers the call, plays back the announcement message and automatically hangs up. In the latter sections you will configure SIP Trunk in CUCM for player component.

In this section, you need to configure various SIP parameters for the player.

[SIP]

PortUDP=5060
PortTCP=5060

PortRtpMin = 30000
PortRtpMax = 31999
  • Options PortUDP and PortTCP specify the listening ports for SIP interface for UDP and TCP protocols respectively. Normally, TCP is used for SIP Trunk in CUCM environment. So, you only need to use PortTCP. Other protocol may be disabled by setting its value to 0. If a firewall is enabled, then you need to add these ports to the allowed list.

  • Options PortRtpMin and PortRtpMax specify the UDP port range for RTP packets. If a firewall is enabled, then you need to add this port range to the allowed list.

CUCM - SIP profile

Use the Device > Device Settings > SIP Profile menu option in Cisco Unified Communications Manager Administration to create SIP profile for MiaRec recording announcement player.

The following figure illustrates creating a SIP profile for the recorder.

Create SIP profile for recorder

CUCM - SIP Trunk Security Profile

Use the System > Security > SIP Trunk Security Profile menu option in Cisco Unified Communications Manager Administration to create SIP Trunk Security profile for MiaRec recording announcement player.

  • Set Incoming Transport Type to TCP+UDP.
  • Set Outgoing Transport Type to TCP (this setting has to match the configuration of MiaRec). TCP is recommended.
  • Uncheck option Enable Digest Authentication
  • Set Device Security Mode parameter to Non Secure.

Create SIP Trunk Security Profile

CUCM - SIP Trunk

Use the Device > Trunk menu option in Cisco Unified Communications Manager Administration to create SIP trunk that points to the MiaRec announcement player.

  • Set Device Pool to the same pool as used for phones themselves
  • Set Calling Search Space to the CSS that contains the user phones

In SIP Information section configure:

  • Destination Address should point to ip-address or DNS name of the MiaRec announcement player
  • Destination Port should match the port on which MiaRec announcement player is listening for messages from CUCM
  • Select the previously created SIP Trunk Security Profile for the announcement player
  • Select the previously created SIP Profile for the announcement player

Create SIP Trunk

CUCM - Route pattern

Use the Call Routing > Route/Hunt > Route Pattern menu option in Cisco Unified Communications Manager Administration to create a route pattern for the MiaRec announcement player SIP trunk:

  • Route Pattern should match to the directory number associated with MiaRec announcement player. This DN is used to reach the SIP Trunk of MiaRec announcement player. The latter will automatically answer incoming calls made to this DN and playback the recording announcement player. No user is going to directly call this number manually. Make sure it does not collide with your numbering plan. This is why the example shows '7777'.

  • Set Route partition to the partition that includes the user phones.

  • In Gateway/Route List select the SIP trunk that points to the announcement player

Reoute Pattern Configuration

Verify SIP Trunk configuration

If the MiaRec announcement player is running, then you should be able to dial from your phone the configured directory number (7777 in above example). You should hear the announcement message and then the call should hanghup automatically.

In the next steps, you will configure the controller component, which will automatically route calls to this directory number based on varios criteria, like "outbound only" or "matching phone prefix", etc.

CUCM - Built-in-Bridge (system level)

Built-in-Bridge setting can be enabled on per-phone basis or on system level (default to all phones).

Access the System > Service Parameters menu option in Cisco Unified Communications Manager Administration, select your CUCM server from the Server list and Cisco CallManager from the Service list:

Service Parameter Configuration

To enable Built-in-Bridge on system level change the option Clusterwide Parameters (Device - Phone) -> Builtin Bridge Enable to On:

Clusterwide Builtin Bridge Enable

CUCM - TAPI user

You must first create the application user who is capable of monitoring and controlling phones.

Navigate in Cisco Unified CM Administration web portal to the menu User Management -> Application User and click Add New button to create new user account.

Add application user

In the list Available Devices select the devices, which state should be monitored by MiaRec announcement controller and click arrow V to move such devices to the list Controlled Devices.

In case of Extension Mobility, you can use CTI Controlled Device Profiles instead of Controlled Devices list.

Add application user

In the section Permissions Information click the Add to Access Control Group button to select permissions for application user.

Add application user

In the new pop-up window select the following required options:

  • Standard CTI Allow Control of All Devices
  • Standard CTI Allow Control of Phones supporting Connected Xfer and conf
  • Standard CTI Allow Control of Phones supporting Rollover Mode
  • Standard CTI Enabled

Other options are not required.

Add application user

Save the settings of new application user.

Controller - Cisco TAPI TSP driver

The Cisco TAPI Service Provider (TSP) is a TAPI driver that is installed on the Windows server that allows communication of line events between MiaRec recording announcement controller and the Cisco UCM.

Download the TAPI driver

The installer for the client can be obtained from the Cisco Unified CM Administration portal using the following steps:

  1. Open Cisco Unified CM Administration portal in a web browser and log in with an administrator account.

  2. Once logged in, hover over the Application menu across the top of the site, and click the Plugins link.

  3. On the Find and List Plugins page, enter "Cisco TAPI" into the search field and click Find.

  4. The plugin list will load. Click the Download link on either 32-bit or 64-bit client depending on your operating system.

Download Cisco TAPI driver

Install the TAPI driver

Open the CiscoTSP.exe installer and follow instructions on screen. You will be asked for Cisco CallManager address and application user/password as created in previous steps.

Restart operating system is required after installation of Cisco TAPI driver.

[Optional] Modify Cisco TAPI configuration

To modify Cisco TAPI driver configuration use CiscoConfig.exe utility, which is installed with TAPI driver.

Start this utility and click Configure button.

Configure Cisco TAPI driver

The following screenshots demonstrate example of configuration.

Configure Cisco TAPI driver

Configure Cisco TAPI driver

Controller - Verify TAPI configuration

To verify the TSP operation on the machine where the TSP is installed, use the Microsoft Windows Phone Dialer Application.

Windows Phone Dialer

When the program is run, a dialog box displays that asks which line and address the user wants to use to connect. If there are no lines in the Line drop down list, then a problem may exist between the TSP and the Cisco Unified Communications Manager.

If lines are available, choose one of the lines, keep the Address set to zero (0) and click OK. Enter a Number to dial, and a call should be placed to that number.

If call is successful, you know that the TSP is operational on the machine where the TSP is installed. If problems are encountered with installation and setup of Remote TSP, this test represents a good way to verify whether the TSP is operating properly and that the problem is with the configuration and setup of Remote TSP.

Enable trace in Cisco TAPI driver.

Start CiscoConfig.exe utility and click the Trace tab.

Select Trace On check box and select:

  • TSP Trace to trace the TSP internal messages.
  • CTI Trace to trace the messages sent between CTI and TSP.
  • TSPI Trace to trace the requests and events that are sent between TSP and TAPI.

Select Error to just log errors in the TSP or Detailed to log internal messages for debugging purposes.

Set up a Directory that is the path for the trace log. For example, C:\CiscoTapiLog

No. of Files: Setting this to a value greater than or equal to 1 enables rolling log files. For example, a value of 10 will cause up to 10 log files to be used in a cyclic fashion. Max lines/file: specifies the maximum number of trace statements that will be written to each log file. For example, a value of 1000 will cause up to 1000 trace statements to be written to each log file.

Cisco TAPI Trace config

After Trace is enabled in Cisco TAPI driver, start the TAPI application (for example, Windows Phone Dialer) and then examine logs.

Controller - Configuration

The configuration of MiaRec recording announcement controller is stored in text INI file.

Section [Filters]

MiaRec supports selective recording announcement using advanced filters. For example, you can activate recording announcement only for outbound calls. Or only for calls matching particular phone prefix, etc.

The following section illustrates some of examples:

##############
[Filters]
##############

; ------------------------
; Example 1
; Play recording announcement for extension 203
; ------------------------
filter1 condition = caller-number = 203 OR called-number = 203
filter1 action = play

; ------------------------
; Example 2
; Play recording announcement for all calls between 2xx and 2xx
; ------------------------
filter2 condition = caller-number LIKE '2__' AND called-number = LIKE '2__'
filter2 action = play

; ------------------------
; Example 3
; Ignore all calls, where caller extension is 3 digits
; ------------------------
filter3 condition = caller-number LIKE '___'
filter3 action = ignore

default_action = play