Call Recording. 02 Mar TM and copyright Imagicle spa

Transcription

1 Call Recording 02 Mar 2018 TM and copyright Imagicle spa

2 Table of Contents Administration Guide...1/78 Description and Architecture...1/78 Configuration Task List...7/78 Secure Call Recording...8/78 Product Configuration...13/78 Product Administration...19/78 High Availability...20/78 License Activation...24/78 Troubleshooting...25/78 PBX Configuration...29/78 Product Integration API...43/78 Overview...43/78 Get Recording...44/78 Download Recording...47/78 Start Recording...49/78 Stop Recording...53/78 User Guides...57/78 Call Recording User Guides...57/78 Usage on the IP Phone...58/78 Usage Trough the Web Interface...59/78 Call Recording Gadget for Jabber Desktop...61/78 FAQ and Solutions...62/78 Configure Cisco ECC Curri to use HTTPS...62/78 Unable to retrieve recordings...68/78 Unable to retrieve recordings (new installation)...70/78 How to Regenerate Imagicle Call Recording Certificate...72/78 Playing an audio message (announcement) when receiving a call which will be recorded...73/78 Cannot play or download call recordings after the Imagicle server joined a Windows domain...74/78 Configure Cisco XML Service in HTTPS...75/78 Video...77/78 Product overview...77/78 Using Call Recording Jabber Gadget...78/78

3 Administration Guide Description and Architecture Overview Imagicle Call Recording is Imagicle's solution for centralized call recording for Cisco UC platforms. Dedicated to any company that needs to record calls either for critical services with legal requirements, for operator training or just to keep track of important calls. It offers two recording modes: Always On, where every call is automatically recorded with no user intervention On Demand, letting the user decide when to start conversation recording trough a softkey on the IP Phone Imagicle Call Recording can also record calls received on mobile phones (Single Number Reach). Recorded calls are encrypted by the AES-256 bit algorithm and stored locally on the IAS server, where they can be searched and retrieved through the web interface. They can also be automatically saved on a NAS location. Technical details Supported voice codec: G.711 ulaw/alaw, G.729A Audio File format: MP3 Recordings Encryption: AES-256 bit Recordings disk occupancy: 16 MB/hour Architecture The Cisco "Media Forking" technology "Media forking" is the mechanism provided by Cisco UCM to enable call recording on enabled Cisco devices (IP phones and voice gateways). Basically, when a conversation is established on a recording enabled device, the device can send the received and transmitted audio streams to a SIP application, in order to record them. In details, two simultaneous SIP calls are placed by CallManager to the recorder SIP trunk: the first carries the voice of the local party (recording user), the second carries the voice of the remote party (PSTN phone or other extension). The voice recorder answers such calls and collects the two audio streams, mixes them together and finally stores the recording into a single audio file. Depending on the Cisco device that forks the audio, two different recording technologies can be used: Built-In Bridge (phone based) recording Network (gateway based) recording The two recording technologies are detailed in the next paragraphs. Built-In Bridge recording (Cisco UCM) Gateway based recording (Cisco UCM) Always-On (automatic) YES YES (UCM 10.x and higher) On-Demand (selective) YES (UCM 9.x and higher) - Not Available - Administration Guide 1/78 Administration Guide

4 The recording calls carry the audio streams using the same voice codec of the conversation being recorded. If such codec is not supported by Imagicle Call Recording, UCM transcoding resources are needed by the recorder SIP trunk to allow recording. If the codec is not supported and transcoding resources are not available, the recording fails. The current version of Imagicle Call Recording supports the following voice codecs: G.711 alaw/ulaw, G.729A. How to notify the parties that the call is being recorded When recording starts, no announcement is played by Imagicle Call Recording. A tone can be played periodically in background by UCM to notify the talking parties their conversation is being recorded (see the PBX configuration chapter to see how to enable such tone). For inbound calls, if you need to play a recording announcement to the caller, before starting the conversation, we recommend to Imagicle Queue Manager Enterprise. Alternatively, it is also possible to use Cisco UCCX/UCCE (license required) or the Cisco native queuing (available for free on UCM 9.0 and higher versions). Built-in Bridge (phone based) recording This technology leverages the built-in bridge: a voice-processing component included in almost all Cisco IP phones and soft phones. In particular, it allows the "media forking" mechanism described above. The Built-In Bridge technology can be used both for Always On and On Demand recording. Using the Always-On (automatic) recording mode, when the IP phone line enabled for call recording establishes a conversation, two SIP calls are automatically placed by the CUCM to the Call Recording application through a standard SIP Trunk. Each call carries a one-way RTP audio stream by one of the involved parties. Both RTP streams are originated by the IP phone, leveraging the phone built in bridge. Similarly, if the phone is configured for On-Demand recording ("selective recording"), the user can start recording the established call, at any time, simply pressing the programmed "Record" softkey or button on his/her IP Phone. Depending on the phone model and UCM version, also the "Stop Record" recording softkey is available on the phone (otherwise the recording stops when the conversation is ended). Built-In Bridge recording requires CUCM rel. 8.x or higher for Always On and 9.x or higher for On Demand. Administration Guide 2/78 Description and Architecture

5 Cisco IP Phones must be third generation (69xx, 79xx, 89xx, 99xx or later) including the DX series. See the latest available list of supported phone models on the official web site: Network (gateway based) recording The Cisco Network-Based Recording leverages the Cisco Voice Gateway capabilities to fork media, sending the audio streams to the Call Recording SIP application. This technology can be used only for Always On recording. When the IP phone configured for call recording establishes a conversation, the UCM places two simultaneous SIP calls to the Call Recording server, using a standard SIP Trunk. Each call carries a one-way RTP audio stream by one of the involved parties. Differently from the built-in bridge technology, in this case both RTP streams originate from the VG/CUBE device. This mode requires the use of CUCM rel. 10.x or higher and Cisco Voice Gateway ISR-Gen2 Gateways (29xx-39xx), IOS 15.3(3)M or higher, which can be configured in Voice Gateway or CUBE mode. See for details. Design considerations Choosing the recording technology The two mentioned recording technologies can also be combined together, in the same environment, to better fit your call flow scenario. See the PBX configuration chapter or the Cisco documentation to understand how to combine them. In facts, if both the technologies are enabled on CUCM, the PBX chooses call by call for the specific conversation the best technology to record it. Imagicle Call Recording manages both of them without any configuration change. However, when designing you recording environment consider that: Only built-in bridge recording allows to record internal on-net calls (between two extensions) that do not traverse any voice gateway or CUBE device. Administration Guide 3/78 Description and Architecture

6 Only network recording allows to record incoming calls answered by remote devices (mobile or PSTN phones) when using the Single Number Reach feature of UCM (Remote Device profile). Telephony and network requirements Transcoding resources: if you need to record conversations established with codecs other than G.711 and G.729A, you need to provide enough hardware transcoding resources to the Imagicle Call Recording SIP trunk (specifying a suitable Media Resource Group List). Otherwise, ensure to disable unsupported codec following the instructions in PBX configuration page. Bandwidth considerations: as described above, the media forking technology involves two one-way audio calls (and audio streams) to the call recording server. Therefore, additional bandwidth is required in upload from the recording device (telephone or voice gateway) to the Imagicle call recording server. This is important if you plan to manage a multi-site scenario with a centralized recording server. The upload bandwidth requirement depends on the adopted codec but is roughly twice the bandwidth of a regular call, that is: G.711: about 175 Kbps for each conversation being recorded. G.729: about 62 Kbps for each conversation being recorded. Supported phone models: see the Cisco documentation for the latest available list of supported models, and their capabilities. Supported voice gateways (for network recording technology only): UCM 10.0 or higher Voice gateways or CUBE meeting the requirements documented by Cisco. If you plan to export recordings to a remote storage, additional bandwidth is required for the file transfer between the Imagicle call recording server and the remote network folder. Such bandwidth actually depends on the volume of recorded traffic (maximum 20MB/hour for each recording licensed channel). High-Availability deployments involving multiple Imagicle servers require enough bandwidth between each Imagicle node in order to synchronize the audio recording files. Such bandwidth actually depends on the volume of recorded traffic (maximum 20MB/hour for each recording licensed channel). Storage requirements Disk space needed to store the call recordings depends on: The number of agents The number of calls per hour Average call duration how log you want to store the recorded calls Imagicle provides an Excel worksheet which allows you calculate the needed disk space. Dial-In mode In addition to the two Cisco technologies mentioned above, a third recording technique (hereafter named "Dial-In") is possible with Imagicle Call Recording. This is an "On-Demand" recording mode that can be used for devices that do not support the built-in bridge and network recording (analog phones, 3rd party SIP phones, etc). Basically, this mode involves a 3-parties conference call engaged by the operator that includes both the remote party and the recording application. How it works 1. The operator establishes a conversation with the remote party (incoming or outgoing call). 2. The operator initiates a conference with the recorder, placing an invitation call to recorder (calling the pilot number associated to the recorder, for instance 8500). The remote party is automatically put on hold. 3. The recorder answers the call and plays a beep (recording tone confirmation). 4. The operator completes the conference between the remote party, the call recorder and the operator himself. The recorder will silently record all the conversation. Administration Guide 4/78 Description and Architecture

7 5. The operator hangs up the call and the conference. Limitations This recording mode is initiated manually, therefore this is not suitable for "always-on" scenarios that require the automatic, transparent recording. The remote party number is not available, therefore it will be blank in the recordings list, in the recording filenames, etc. The call direction cannot be determined, therefore it will appear blank in the recordings list. Technical considerations The recording phone and the conference bridge must be able to establish the call with the Call Recording service, using one of the supported codecs (G.711, G.729A). The recording phone must be able to do at least 3-parties audio conferences. The required bandwidth to/from the recorder is the same of a regular phone call. Free-Seating Imagicle Call Recording supports the "free seating" scenario: nomadic users can work on different desks/locations using the Extension Mobility feature of Call Manager. To enable call recording in such scenario you only need to: Assign to the Application Suite user the DN of the Extension Mobility Profile Configure the device profile as described in the PBX configuration document page to enable call recording on the phone line. Recording Jabber Calls Jabber calls cannot be recorded on-demand. If you need to record Jabber conversations, the suggested configuration is to set a short retention time (e.g. 4 hours), allowing the users to pin (preserve) important recordings. Preserving can be done through through the Call Recording gadget interface. Data processing and Storage When a recording completes, the service both stores some data in the application suite database (recording index) and in the local file system (MP3 audio file). The main processing steps are: Recording of 2 audio streams â Mix and MP3 compression â AES Encryption â DB Indexing The encrypted recordings are saved into a subfolder of the installation folder, in particular:...\stonevoiceas\apps\recorder\records Files are further subfolder by year, month and date: Administration Guide 5/78 Description and Architecture

8 The filename of each recording include some useful information, in particular: The (sequential) Record Id A 14 digits timestamp (yyyymmddhhmmss) The recording username (as configured in IAS) The recording extension The remote party number The call direction (IN/OUT) Hint: please contact the Imagicle support service if you need to move recordings to another folder or disk unit Disk Occupancy The disk occupancy of each recording is about 16 MB per hour. Consider that when sizing the server disk, the overall occupancy should be calculated accordingly with the estimated traffic figure and planned data retention. Following some examples of occupancy figures, for different recording scenarios. Recording Scenario Help Desk (8x6) Emergency service (24x7) Teleselling (8x6) Simultaneous conversations (agents) Daily recording time per agent (hours) Data Retention (months) Necessary disk space (GB) Administration Guide 6/78 Description and Architecture

9 Configuration Task List Warning: you must install and configure the Application Suite before being able to configure the single applications. Call Recording can be easily configured through the following steps. Install the Application Suite Setup package Configure the Application Suite general parameters (IP telephony parameters, Dialling plan, SMTP) Create the users list with the extensions of the lines you want to be able to record Configure the PBX Configure the IP phones for recording If you have a valid license, activate it now using the License page. If you do not have it yet, the application will run in evaluation mode for 30 days Through the Manage Service Page check that the Call Recording Service is running Configure the system settings and desired data retention. Administration Guide 7/78 Configuration Task List

10 Secure Call Recording Effective Summer 2017, Imagicle Call Recording can record Encrypted calls, i.e. calls which are placed with Secure SIP (SIP/TLS) for the signalling and SRTP for the audio stream. Before trying to record Secure calls, make sure Imagicle Call Recording is fully configured to record Non-Secure calls with clear RTP. Mixed mode must be enabled on your Unified CallManager, and you must be able to effectively place and receive secure calls to and from the agents' phones. Secure calls recording supports forking (Cisco Built-in-Bridge technology), Dial-in (direct call) and Network based (gateway) recording. CuCM Configuration for Secure Call Recording To be able to record secure calls, you need to: 1. Load the Imagicle Call Recording certificate on CuCM, categorized as CallManager-trust 2. Create a SIP Trunk Security Profile which references the Imagicle Certificate 3. Create a SIP trunk which points to the Imagicle Application Suite machine, port 5071, and uses the SIP Trunk Security Profile Loading the Imagicle Call Recording Certificate on CallManager When Imagicle Call Recording service starts, it creates a security certificate which is valid for the IAS server on which it was generated. It must be downloaded from the web interface, and loaded onto CuCM. To get the Imagicle Call Recording certificate: Login to the IAS web interface as Administrator Click on Recording, then Global Settings Expand the "Secure Recording" section Click on the Download button to download the Imagicle Call Recording certificate and save it to your PC. The file extension is.pem. To load the certificate on CuCM: Log on CuCM as Administrator Select OS Administration From the menu, choose Security, Certificate Management Press the "Upload Certificate / Certificate chain" button As certificate purpose, choose "Callmanager-trust" Enter a description, then select the Call Recording Certificate from your PC and upload it Press "Close" to go back to the certificate list. Administration Guide 8/78 Secure Call Recording

11 Press "Find" to list the certificates. Locate the Imagicle certificate you just uploaded. Take note of the certificate Common Name for later use. By default, the certificate Common Name will match the computer name of the machine on which it was generated. Warning: Changing the Computer Name will invalidate the certificate. If you change the IAS server computer name, you need to regenerate the Call Recording certificate. Warning: The Call Recording certificate will last 5 years from the day it was generated, which is the day the product was installed. If you make Application Suite generate a new certificate, it will last 5 years from the day it was generated. Creating a SIP Trunk Security Profile with Encryption From the Cisco Unified CM Administration menu, select System, Security, Sip Trunk Security Profile. Add a new item with the following properties: Incoming Transport Type: TLS Outgoing Transport Type: TLS Incoming port: 5071 Accept Out of Dialog Refer: enabled Accept Unsolicited Notification: enabled X.509 Subject Name: enter the Imagicle Call Recording Certificate Common Name you noted before. Administration Guide 9/78 Secure Call Recording

12 Please mind the certificate name. Do not enter the certificate description. Do not enter the full Subject Name. Enter the Common Name. If you are unsure, select System, Security, Certificate, and press the Find button. Locate the Imagicle certificate. The Common Name is displayed in the Subject Name column, just after CN= Creating a SIP Trunk for Secure Recording A Secure Sip Trunk is a standard SIP trunk with the following properties: A descriptive name, such as CallRecording_SIP_Trunk_Encrypted SRTP Allowed enabled Run On All Active Unified CM Nodes enabled Administration Guide 10/78 Secure Call Recording

13 Destination Address: the IP Address of the Imagicle Application Suite server Destination Port: 5071 SIP Trunk Security Profile: reference the one you just created Route Pattern to the SIP Trunk The route pattern must:create a new Route Pattern pointing to the the Imagicle Call Recording Sip Trunk for secure calls. Make sure you did not select the Call Recording Sip Trunk for standard calls. The pattern should match the Pilot number in the Recording profile you are going to create. Call Recording Profile for Encrypted Calls Create a new Call Recording Profile for encrypted calls. Assign a Pilot number of your choice, and a suitable CSS. The CSS must allow the phones to reach the Route pattern you just created. Administration Guide 11/78 Secure Call Recording

14 IP Phone Configuration The IP Phone configuration to record secure calls is similar to the non-secure call recording. Just select the Call Recording Profile for Encrypted Calls. Please refer to non-secure calls configuration page of this guide. Troubleshooting Secure Calls Before testing any other recording technology, try to record a Dial-In call. Choose two phones supporting Encrypted calls, say 101 and 102. Place a call from 101 to 102 and check that a lock appears on the display, meaning that the conversation is encrypted On Imagicle Application Suite, create a user with Primary Extension 101 and the permission to use Call Recording, which is the default Place a call from 101 to a number matching the Secure Call Recording Route pattern You should hear a beep, or, in case of permission mismatch, a message informing that the calling number is not entitled for voice recording. If the call does not seem to reach the Call Recording application, most probably there is a problem with the certificate. Ensure you referenced the correct certificate Common Name. How to detect a certificate problem If you suspect a certificate problem, you can check the detailed error in the Call Recording voip stack log file. To enable detailed voip logging: Edit the this file: <installation dir>\stonevoiceas\apps\recorder\settings\recorder.opal.config.xml Add the following line: <?xml version="1.0" encoding="utf-8"?> <configuration> <preference key="logging.level" value="4" /> </configuration> Restart Imagicle Call Recording service Once the logs are enabled: Try to record a new call, for example dialing the Call Recording pilot number Using your favorite editor, open the log file: <installation dir>\var\log\recorder.service\recorder.opal_<current date>.log Look for a line similar to: Accept: error in state=sslv3 read client key exchange A This means that the TLS certificate exchange failed. Please review the above steps. Administration Guide 12/78 Secure Call Recording

15 Product Configuration Users Configuration Every IP Phone enabled for recording must be associated to a user in the application suite. User properties In addition to the mandatory fields (username and password) the user enabled for recording should be configured with the following properties: Primary extension number (mandatory): this field is mandatory and must be unique. The system identifies the owner of the recording basing on the extension number Recording Numeric user ID (optional): this must be a unique numeric number associated to the user, can be set equal to the extension number. This field is reserved for future use. Recording Group Name (optional): if set, this field defines the recording group the user belong to, for instance "Help Desk" or "Traders". This field can be used later to filter/search recordings Send notifications / Attach recording file to notifications (optional). This flag allows notifications for the user, if enabled globally by the administrator (see below) Important: Call Recording does not support overlapping dial plans. Two or more users enabled for recording cannot have the same primary extension number. User Access Levels Use the "User permissions" page to change the access level for a specific user or to set the default access level for all users. Three access levels are available for the Call Recording application: Simple user: this is the default access level for all application suite users. This profile is enabled to: Record new conversations See, search, play and download only his/her recordings Preserve recordings for longer storage Add/edit notes attached to the recordings Group Supervisor: compared to the simple user, a user with this profile can also: see, play and download all recordings of his/her recording group Administrator: In addition to a supervisor access level, a user with this profile can also: see, play and download any recording of any user change any service setting start/stop the service Moreover, following hierarchical rules apply: A user cannot delete a recording preserved by an higher level user A user cannot delete or rewrite a note written by an higher level user See the configuration chapter to see how to assign the access level to Call Recording users. Service Settings The service settings (Global Settings) section is available only to administrative profiles (menu item Global Settings). Recording Filters When using the Always-On recording mode, you may need to record only some kind of calls/traffic. For instance, an help desk Administration Guide 13/78 Product Configuration

16 operator may need to record only incoming calls from the PSTN, not the conversations with other colleagues. This section allows to define flexible recording filters to decide which type of calls to record or discard. Such filters apply to all recording enabled users. The available options for call filtering are: Call Direction: setting this option you can decide to record only incoming/outgoing calls (from the IP phone point of view) or both of them. Traffic Type: setting this option you can decide to record only internal or external (to/from PSTN) calls. Calls are considered internal if the remote party is included in the application suite users list or if the remote party number matches the Internal number patterns defined in the application suite "Numbering Plans Parameters" section. Black List: this option allows to define a list of remote party numbers/patterns that you don't want to record. You can specify multiple numbers/patterns, one for each row. For instance, you can use this option to avoid to record the operator calls towards voic systems or conversations with VIP people who cannot be recorded. See the hint on the web page for the available wildcards you can use to build patterns. Some sample patterns: 7100: avoid to record all calls to the Voic pilot : avoid to record all conversations from/to numbers 3-digits long, starting with '73'. 8! : avoid to record all conversations to any number (of any length) starting with '8'. Hint: include the recorder pilot number (that is the Recording Profile DN configured on CUCM) in the remote party Black-list, to avoid to record calls placed to the recorder itself. Permissions Use this section to decide which access levels can delete or download recordings. Available options are: Nobody: useful to prevent accidental deletions, even by service administrators. Administrators Group Supervisors Simple users For deletion, if you select "Nobody - Irreversible choice", even administators won't be able to delete the recordings, and nobody will ever be able to change the setting. Data Management Storage (encrypted) Use this page to configure the retention policy of saved recordings and optionally enable an export job for backup purposes. Retention Policy The service can be configured to automatically delete older recordings in order to free disk space or to comply with legal or internal requirements. When the automatic deletion is enabled, users can select single recordings to be preserved, accordingly with the system settings. This section allows to configure the lifetime of recordings, that is, how long to keep the recordings on the system before they are definitely deleted both form the local disk and from the internal service database. Please, consider that deleted recordings cannot be restored anymore. They won't be available for play,download and export operations, therefore, be careful when managing this group of options. Administration Guide 14/78 Product Configuration

17 You can choose one of the retention presets or you can define a customized policy basing on your needs. The available options are: Keep all recording: no automatic deletion: recording are never deleted automatically (only manual deletion is possible). Selecting this option, the recording preserve feature is disabled for all users. 12 months: delete automatically all recordings older than 12 months, except the ones explicitly preserved by users. 48 months: delete automatically all recordings older than 48 months, except the ones explicitly preserved by users. Delete after 4 hours, except preserved by users: this setting is ideal to discard all recordings not explicitly marked by users. This is useful if the phone is configured for Always-On recording but only a few conversations have to be recorded (and maintained). Customize: you can define you own retention policy, for the specified amount of days/months/years. You can also enable the preserve feature to users, specifying the additional lifetime of recordings selected for preservation. Deletion of older recordings, if enabled, is performed by the service at regular intervals (minutes). Data Export (Unencrypted) Recordings saved in the application suite server (as encrypted files) can also be exported to a remote storage in MP3, unencrypted file format. This export job can be useful for backup scopes or to realize further processing inside the organization (for instance loading them into a centralized document repository). The destination storage must be a network folder shared by Microsoft Sharing protocol (SMB) and accessible by a network path, for instance: \\nas-backup\voicerecordings. Such path represent the base folder for data export. Further subfolders will be automatically created by the system in a hierarchical date schema year\month\day (one folder per day). For instance, referring the path mentioned above, recordings started on April 21st, 2016 will be exported to: \\nas-backup\voicerecordings\2016\04\21. Administration Guide 15/78 Product Configuration

18 Inside each folder the service will place : All recordings files (started in such date), in plain MP3 format. The destination filename includes: The unique (sequential) RecordID A timestamp yyyymmddd_hhmmss The recording user (username) The call direction (IN/OUT/DIALIN) The recorded extension number The remote party number The group name (if any) A CSV text file (UTF-8 encoding) containing all the relevant data of the exported recordings. This file can be easily opened with a spreadsheet application or used for indexing purposes by third party systems. The CSV fields include: Recording agent name Recorded extension number Remote party number, Start time Call duration Group Name The destination folder must be accessible for writing to a local or domain user. The service will use the credentials of such user to create files and folders on the destination folder. The export job runs at regular time intervals (about 1 minute). Exported files are never deleted by Imagicle Call Recording on the remote storage. The customer is in charge of the retention policies for such files. Configuration Administration Guide 16/78 Product Configuration

19 In this form enter: The network path of the destination folder. For instance: \\nas-backup\voicerecordings The username used to access the destination folder. This can be either a domain user (for instance IMAGICLE\backupuser) or a local user defined in the remote machine. This user must be enabled for writing in the specified folder. The password of the user specified above. Note: you cannot specify a local path as export destination folder, only network paths are admitted. This is because local paths would be problematic for high-availability configurations. Use the 'Test access' button to verify if the destination folder is accessible to the service with provided credentials: if successful, a small test file will be created on the destination folder. Only new recordings will be exported to the specified path. In the case the remote storage is temporarily unavailable or unreachable (for example because of a network outage), the missing recordings will be automatically exported as soon as it comes back available. Notifications notifications Users may receive an notification whenever their calls have been recorded. You choose which users receive the by ticking the "Send notifications" flag in the users profile properties, Call Recording section. If you also enable "Attach recording file to notifications", an unencrypted copy of the recorded message will be attached to the message, in plain.mp3 format. On the notifications setting page, you can set the size limit for the attachment. If the limit is overcome, the is sent anyway. The minimum size limit is 1 MByte. Unchecking the flag, no limit will be applied. You can also set the notification sender name. You can set other SMTP properties through Admin, System Parameters, SMTP parameters. How to edit the notification template To change the body contents for all the users, locate this folder: <installation dir>\stonevoiceas\apps\recorder\locale\xx\ Where XX is the language code for the users language. Eg. en, it, fr.. Administration Guide 17/78 Product Configuration

20 Copy User.Notification.Template.txt as User.Notification.Template.txt.user. Edit User.Notification.Template.txt.user. The template can be customized with the following tags, which will be replaced with the actual data when the is sent: [RecordingID] - Recording unique identifier [Username] - Recording owner's user name [UserExtension] - Recording owner's extension number [UserFirstName] - Recording owner's first name [UserLastName] - Recording owner's last name [UserNumericUserID] - Recording owner's numeric identifier [RemotePhoneNumber] - Recording's remote phone number [RecordingStartDate] - The date the recording started [RecordingStartTime] - The moment the recording started (hh:mm:ss) [RecordingDuration] - The recording duration (hh:mm:ss) [RecordingGroupName] - Recording owner's group name [PBXCallID] - Recording identifier assigned by PBX [CallDirection] - The call direction [RecordingPilotNumber] - The recorder pilot number [AttachmentFileSize] - The size of sent attachment in KBytes (0 when no attachment has been sent) [MaxAttachmentSize] - The maximum size allowed for attachment (in MBytes) To change the template for the users who belong to a specific department, follow the same procedure in this folder: StonevoiceAS\Settings\Departments\<department>\MailNotificationTemplates\CallRecording Where <department> must match the content of the Department field in the user profile. Administration Guide 18/78 Product Configuration

21 Product Administration Service Management Use this section to start and stop the Call Recording service. The Call Recording service automatically runs when Windows starts, use this option only if suggested by Imagicle Support team. Backup & Restore Backup and restore of Imagicle Call Recording configuration can be made through the Backup&Restore tool as for the other applications. See "The Backup and Restore Tool" in the Application Suite configuration section of this guide. Backup of the encrypted conversations will only be made if the "Include historical data" checkbox is flagged on the Backup&Restore tool interface. Administration Guide 19/78 Product Administration

22 High Availability High Availability model Imagicle Call Recording supports the high availability configuration of the Application suite, implementing an Hot-Standby redundancy model. Incoming calls are normally handled by the primary server, backup nodes are involved only when the primary server is not available. All recordings are regularly synchronized between different nodes regardless the node that actually did the recording. This means you can access the WEB interface of any node to play/download a recording (recordings take a few minutes to be synchronized). In a cluster configuration of the Application Suite server, only one server can play the primary role for Call Recording, the other nodes play the backup role. All nodes must be licensed for Call recording accordingly with the role the play (regular or backup nodes). Backup nodes can be added later, they will be synchronized with the primary node contents as soon as they join the Imagicle cluster. After creating an application suite clusters (using the High Availability web wizard), additional configurations are required on the CUCM, details explained below. Data maintenance jobs Each licensed Call Recording node is enabled to run the data maintenance jobs, in particular: Purge of older recordings Export to a network folder Normally such jobs (if enabled) run on the primary node; if the primary node is unavailable, the backup nodes automatically take in charge of these jobs. PBX Configuration The only configuration change required on CUCM is limited to the routing of media forking calls in order to enable the failover policy. Following the configuration details, supposing a configuration with two Imagicle servers (primary-backup) and supposing the configuration for the first node (primary) has already be done. 1) If you are adding a backup node ensure no Route pattern is pointing to the primary Call Recording SIP Trunk. Delete the Route pattern or make it temporarily pointing to another device. 2) Define a second SIP Trunk with the same settings of primary one, except following ones: Name: Imagicle_CallRecording_Backup_SIP_Trunk SIP information - Destination Address: <IP address of the second Imagicle server (backup node)> 3) Create a Route Group with following parameters: Route Group Name: RG_Imagicle_CallRecording Distribution Algorithm: Top-Down Selected devices: Imagicle_CallRecording_Primary_SIP_Trunk Imagicle_CallRecording_Backup_SIP_Trunk Administration Guide 20/78 High Availability

23 4) Create a Route List with following parameters: Name: RL_Imagicle_CallRecording CUCM Group: choose your preferred UCM group (for load balancing scopes) Enable this Route List: enabled Run On All Unified CM Nodes: enabled Selected Groups: RG_Imagicle_CallRecording (the one defined above). Do not apply any transformation to calling and called parties. Administration Guide 21/78 High Availability

24 5) Create a Route Pattern setting the Recording Profile Number as pattern (for instance 8500) and pointing to the Route List defined above. Failover policy The route failover is triggered only in these cases: The SIP trunk to primary node is down. The primary node does not answer the incoming calls in the configured timeout (sudden death of server/application). Incoming calls are rejected by the primary node with a SIP Response 5XX, because of a blocking application error. The following error conditions, instead, do not trigger a route failover: Recording user is unknown/unauthorized Administration Guide 22/78 High Availability

25 License exhausted or invalid. Further considerations Since the saved recordings are replicated on all Imagicle servers, ensure there is enough available bandwidth between the Imagicle servers to allow data synchronization. For the Call Recording application the estimated maximum bandwidth is about 20 MB/hour (peak hours) for each licensed channel. For instance, during the peak hours, a 30 channels licensed Call Recording may need transfer up to 600 MB (per hour) to the backup Call Recording node. Administration Guide 23/78 High Availability

26 License Activation Imagicle Call Recording is licensed per channel, regardless the number of enabled users. The number of enabled channels controls the number of conversations that can be simultaneously recorded, on each server. All features (including the G.729 codec) are available without need of further licenses. Evaluation During the 30 days free evaluation period you'll be able to record only 1 conversation per time. How to activate the license To activate the license, follow the standard procedure you can find in the General configuration section. Administration Guide 24/78 License Activation

27 Troubleshooting How to use the troubleshooting guide This page describes basic troubleshooting techniques and most frequent issues you may face during the application setup and usage. The first part describes the basic tests to be made after you completed the configuration task list. Those test can reveal issues in the configuration and can help you to identify them. The second part is a list of common issues and their causes. Look for the symptom and follow the tips. To know how to configure the product, please refer to the relevant pages in this guide. Please understand that the problem may be related to complex PBX and network configurations, and that is not possible to list all them all. This guide must be considered as a tool to guess the origin of the issue. 1. Post installation basic tests A very quick test can be made directly from the phone enabled for recording. This test will help you to understand if the Imagicle Application suite is properly configured. Place a call from the phone line enabled for recording to recorder pilot number (that is the directory number configured in the Recording Profile of CUCM, for instance 8500). The call should be answered by Imagicle Call Recording, and one of the following voice prompts should be played: Beep: the phone is enabled on IAS for recording calls, the test call is recorded using the "dial-in" mode. Unknown number: the calling number is not present in the application suite users list (remember that each phone enabled for recording must be associated to a valid application suite user). Unauthorized number: the calling number is assigned to a application suite user that is not enabled to record. You nee to adjust the user permissions accordingly. Instead, if the call fails, please proceed with the regular troubleshooting procedure, described below. Attention: if the built-in bridge or network recording mechanism works properly, the diagnostic call to the recorder may be recorded as well. Therefore, if you are still running with evaluation licenses (only 1 channel enabled), a "license exceeded" event in the Application Suite monitoring section could be raised. RTMT useful alarms On Cisco UCM 10 and higher versions, when the Cisco call recording mechanism fails, a specific alarm is raised by UCM, so that the administrator can be alerted by the Cisco UCM monitoring tools. The status of such alarms is available in the "Alert Central" section of Real Time Monitoring Tool, tab "Voice/Video". See the Cisco documentation for the list of the possible alarms and their meaning. Administration Guide 25/78 Troubleshooting

28 2. Common Issues Conversations not being recorded It is important to understand if the media forking SIP calls are coming to Imagicle Call Recording or not. You can get a Wireshark capture on the Imagicle server or, alternatively, you can go through these simple steps: 1. Ensure the Imagicle Call Recording service is running (check the "Manage Service" administrative page). 2. Place a call from/to the phone enable for recording, make the call gets connected. Press the Record softkey if the On-Demand mode has been configured. 3. Wait some seconds and hang up the call. 4. Look at the events history in the Monitoring section of the application suite. If a Call Recording event has been raised, this means the media forking calls reached the Imagicle Call Recording SIP service but the recording failed. NOTE: The description of the event, if any, should help you in understanding the reason of the problem. Alternatively you can also get a Wireshark capture on the Imagicle server and check for two SIP incoming calls to the recording profile DN, UDP port Depending on the outcome of this test, two different diagnostics procedure must be taken. Media forking calls not placed to Imagicle Call Recording In this case, go through this checklist: 1. Ensure the Recording Profile CSS includes the partition of the Route Pattern configured for Imagicle Call Recording. If you assigned to Recording Profile the same CSS of the line being recorded, you can do the test described above in the "Diagnostic Voice Prompts" section, it will help you to understand if the Call Recording SIP trunk is reachable or not. 2. Ensure the phones are properly configured on CUCM, as suggested in the PBX configuration section, in particular, verify the Built-In bridge is enabled on the device. Administration Guide 26/78 Troubleshooting

29 Media forking calls properly placed to Imagicle Call Recording In the case the media forking calls comes to the Imagicle Call Recording, but the call has not been recorded, one (or more) of the following reasons may apply: 1. The phone number recording for recording is not assigned to any IAS user. 2. The calling number is assigned to a IAS user that is not enabled for Call Recording. 3. The license for Call Recording service is invalid or expired. 4. A codec mismatch occurred, the recording service was not able to answer the media forking calls. If any of these errors occurs, a specific Call Recording event is raised in the Monitoring section of the Imagicle Application Suite. Codec Mismatch The codec mismatch problem occurs if both the following conditions are true: The conversation to be recorded is established using a codec not supported by Imagicle Call Recording (G.729B, G.722, ilbc,..) On CUCM no hardware transcoding resource is available to the Imagicle Call Recording SIP Trunk. Codec mismatch makes the Call Recording failing when trying to answer the Media Forking Calls. In terms of diagnostics, when a codec mismatch occurs: A Call Recording event is raised in he Application Suite (Monitoring section). An alarm is raised on CUCM, visible by the RTMT tool. In a Wireshark capture, you can see the CUCM hangs up the Media Forking calls. A BYE is sent by CUCM with reason code 47 (Resource Unavailable). How to fix it To fix the codec mismatch problem at least one of the following actions should be taken: Disable the unsupported codecs on the involved phones and gateways/session border controllers. See the PBX configuration page of this guide for useful indications. Alternatively, assign a Media Resource Group List containing an hardware transcoding resource (able to handle the codec) to the Imagicle Call Recording SIP Trunk. Wrong remote numbers Each recordings is associated to a locale extension number (the phone being recorded) and a remote party number. Both these numbers are displayed in the recordings list: The remote numbers are adjusted accordingly with the Imagicle suite numbering plan parameters, in particular: for incoming calls the Incoming prefix, if set, is stripped out from the remote number for outgoing calls the Outgoing prefix, if set, is stripped out from the remote number Therefore, if remote numbers look wrong, check in the Numbering Plan Parameters page if the Incoming and Outgoing prefixes Administration Guide 27/78 Troubleshooting

30 are correct. If you change them, new values will apply to the new recordings only. Data Export not working Most common problems that make data export failing are: Wrong credentials for the export job: User does not have write permissions Remote network folder is unreachable or does not exists Destination has not available space. All of these reasons can be easily detected from the WEB interface using the "Test Access" button of the Data Export section (Global Settings). More over, ensure there is available room there in the remote network folder. You cannot play the recorded conversations When you click the play button to listen a recorded conversation, you get the following error: "Unable to load the audio stream, please try again". The browser cannot play the audio stream because the PC on which it is installed does not have and audio adapter, or the Windows Audio service (Audiosrv) is stopped. Add an audio adapter to the PC and start the Audio service. Note: even if you cannot hear the audio stream, you can still download it as MP3 file. Administration Guide 28/78 Troubleshooting

31 PBX Configuration CuCM configuration SIP Trunk Following configurations are needed regardless of the recording technology being used. 1. Create a new SIP Trunk Security Profile named "Imagicle Call Recording SIP Security Profile" with following settings. Incoming Transport Type: TCP + UDP Outgoing Transport Type: UDP Incoming Port: 5070 Enable Digest Authentication: disabled Enable Application Authorization: disabled Accept Unsolicited Notification: enabled Accept Replaces Header: enabled Keep all the other settings to their default value. 2. Define a new SIP Profile named "Imagicle Call Recording SIP Profile", with following settings: Timer Invite Expires: 5 Retry INVITE: 1 SIP OPTIONS PING - Enable OPTIONS Ping: Enabled SIP OPTIONS PING - Ping interval for In- service Trunks: 10 SIP OPTIONS PING - Ping interval for Out-of-service Trunks: 5 SIP OPTIONS PING - Ping Retry Timer: 500 SIP OPTIONS PING - Ping Retry Count: 3 Keep all the other settings to their default value. 3. Create a new SIP Trunk named "Imagicle Call Recording Primary SIP Trunk" with following settings: Device name: Imagicle_CallRecording_Primary_SIP_Trunk Call Classification: On-Net Media Resource Group List: if you need to record conversations using voice codec different from G.711 and G.729A, you need to assign a Media Resource Group List that includes at least one hardware transcoding resource. Run on all Active Unified CM Nodes: Enabled SIP Information - Destination Address: <Imagicle server IP address> SIP Information - Destination port: 5070 SIP Trunk Security Profile: Imagicle Call Recording SIP Security Profile (see above) SIP Profile: Imagicle Call Recording SIP Profile (see above) DTMF Signalling Method: RFC2833 â Keep all the other settings to their default value. Route Pattern Create at least a Route Pattern to route the audio streams to the Imagicle recorder SIP trunk. The pattern depends on the chosen recording technology. Cisco Media Forking and Manual Dial-In The pattern must be set accordingly with the phone number specified in the recording profile (see below) Administration Guide 29/78 PBX Configuration

32 Automated Dial-In A fixed-length pattern must be configured accordingly with the phone number prefix specified in section "Automated Recording" within "Pilot Numbers" of Imagicle Call Recording's Global Settings If needed to match both requirements, multiple Router Pattern can be created. If you plan to use a High Availability configuration with multiple servers, you need to define a Route Group and a Route List as described in the High Availability page. Configuration for Media Forking recording mode Service Parameters - Disabling unsupported codecs Imagicle Call recorder does support G729A, G711A and G711B, all the other codecs can be disabled directly from CUCM configuration. G729B can be disabled at system level for all the calls, G722 can be disabled for recorded calls only. If unsupported codecs can't be disabled, you must ensure to assign hardware transcoding resources to the Call Recording SIP Trunk (in the Media Resource Group List option). In the other case, Call recorder won't be able to record the calls that are established with an unsupported codec. In the CallManager Service Parameters page, disable these codecs, choosing the option "Enabled for All Devices Except Recording-Enabled devices" (CuCM 9.1 and higher) or "Disabled" (CUCM 8.x): G.722 ilbc isac For the same reason, in the same page, remove the G.729 Annex B (Silence Suppression) from Capabilities: Alternatively, to avoid G.729B communications only on recorded phones, you can: Define in CUCM a codec preference list that includes G.729A before G.729.B. Assign such codec preference list to a region used by phones enabled for recording. Service Parameters - Recording Tones If you want to provide the background recording tone (every 15 seconds) to the recorded parties, in the CUCM set the following Service Parameters for CallManager service (on all CallManager nodes): Clusterwide Parameters (Feature - Call recording): Play Recording Notification Tone To Observed Target: True Play Recording Notification Tone To Observed Connected Parties: True The first one enables the recording tone for the agent, the second one enables the recording tone for the remote party. Enable phones for recording Administration Guide 30/78 PBX Configuration

33 To leverage the recording capabilities of CUCM, some additional configurations are needed on CUCM. 1. Create a new Recording Profile (Device - Device Settings - Recording Profiles) with following settings: Name: Imagicle Call Recording Profile Recording CSS: A CSS able to engage the Route Pattern described above. Recording Destination Address.: The service phone number that will trigger the Route Pattern defined above (e.g. 8500) 2. If you plan to use the On Demand recording mode, create a new Softkey Template (Device -> Device Settings - Softkey Templates) that includes the "Record" softkey for the Connected status. You can also simply add such softkey to your existing Softkey Template. 3. Set the following settings to each device (IP phone/softphone) that you need enable to recording: Softkey Template: if you plan to use the On-Demand recording mode, assign the Softkey template defined above. Built-in bridge: ON Advertise G.722 codec: Disabled (or keep the default value if G.722 codec has been disabled system-wide in the CallManager Service Parameters). Administration Guide 31/78 PBX Configuration

34 On the phone line to be recorded: Recording Option: choose one of the following options Automatic Call Recording Enabled, for Always On mode Selective Call Recording Enabled, for On-Demand mode* Recording Profile: Imagicle Call Recording Profile Recording Media Source: Phone preferred: if you plan to use the built-in bridge recording mechanism for this phone Gateway preferred: if you plan to use the Network recording mechanism for this phone. If the Extension Mobility feature is used, you must enable for recording the line of the associated Device Profile. Note: *Selective Call Recording is available since CUCM 9.1 only for some ip phone models. See the official Cisco documentation for the list of supported phones and recording modes. Adding a recording button to Cisco IP phones 99xx/88xx series Cisco 99xx/88xx IP Phones do not use a SoftKey Template to show the "recording" key. Instead, you need to configure it in the Button Template, so it appears as a PLK (Programmable Line Key) on the left-hand side of the phone. Configuration for Automated Dial-In recording mode CTI/TAPI Device Association Automated Dial-In recording requires an IP Phone to be controlled through CTI/TAPI. Associate all the devices you want to use with Automated Dial-In to the ImagicleCTI user you created during TSP setup. XML Service To use Automated Dial-In recording, an XML service has to be configured una-tantum. Log onto the CuCM web interface. Click on Device -> Device Settings -> Phone Services. Define a new Phone Service with following parameters: Name: Imagicle Call Recording Dial-In Description: Imagicle Call Recording Dial-In On-Demand Service Service Category: XML Service Service Type: Standard IP Phone Service Service URL: Flag "Enable": set TIP: You can automatically get the right URL to be pasted, with the right IP address, directly form the Application Suite web interface. Just open the Call Recording -> Global Setting page -> Settings panel -> Service URL sub-panel Administration Guide 32/78 PBX Configuration

35 Service Button URL For each IP Phone where the Automated Dial-In recording has to be used, you need to configure a Service Button URL on that phone. You first need to subscribe the XML Service on the target IP Phone. Click Device -> Phone, select the target IP Phone. Then, in "Related Links" drop-down, choose "Subscribe/Unsubscribe Services" and click Go. In "Select a Service", choose "Imagicle Call Recording Dial-In", click "Next" and then "Subscribe". Administration Guide 33/78 PBX Configuration

36 Now, you can create the Service Button URL: go back to the target phone configuration page and, in the "Association Information" panel on the left, locate and click the "Add a new SURL": Administration Guide 34/78 PBX Configuration

37 Then, in the "Service" drop-down, choose "Imagicle Call Recording Dial-In". Edit the "Label" field as you prefer (this is the label the operator will see on phone's display). Then Save. Finally, click on "Modify Button Items" to associate a phone button to the Service Button URL. Service Parameters Administration Guide 35/78 PBX Configuration

38 To let a user record any conference call, the "Advanced Ad Hoc Conference" Service Parameter of the "Call Manager" service has to be enabled. Network Recording specific configurations (UCM 10.X and higher) The Cisco Network Based Recording (also known as Gateway Recording) is available since UCM 10.0 and has some additional requirements if compared to the Built-In Bridge phone based recording. Moreover, specific configurations are required in all the routers/cubes that relay incoming/outgoing calls, see below for the details. Hardware and Software Requirements Accordingly with Cisco documentation, network recording runs under requirements: UCM 10.0 or higher Supports both Voice gateways and Unified Border Elements (CUBE) as long as they interface with Unified CM using SIP and the Router platform supports the UC Services Interface (not supported for H323 or MGCP based calls) The word "Gateway" is used here interchangeably to refer to Voice gateways and CUBE devices The Gateway has to be directly connected to the Unified CM using a SIP trunk. No support for SIP Proxy servers ISR-G2 Gateways (29XX, 39XX Series) running release 15.3(3)M or later are supported. 15.3(3)M was released on CCO in July / 2013 ASR-100X Gateways running release XE 3.10 or later are supported. XE 3.10 was released on CCO in July / 2013 VG224 is not currently supported CUCM Configuration To enable the network recording technology, you need to go through the following configuration steps on CUCM. 1. On all SIP trunks pointing to the CUBE/VG, under "Recording information" select the option "This trunk connects to a recording-enabled gateway". 2. On all IP phone lines you want to enable for call recording, set the "Gateway Preferred" option in the Recording Media Source setting: Administration Guide 36/78 PBX Configuration

39 IOS Configuration The following IOS configuration must be applied to to each CUBE/VG enabled for network recording. uc wsapi message-exchange max-failures 100 response-timeout 1 source-address << This is the voice LAN IP address of the router probing interval negative 20 probing interval keepalive 255 provider xmf remote-url 1 << Create a similar URL for each CallManager node running the SIP trunk remote-url 2 << Create a similar URL for each CallManager node running the SIP t Then, check the registration is successfully invoking the command: show wsapi registration all The following command, instead, allows debugging the call forking when call recording should be triggered: show call media-forking Moreover, ensure that the internal HTTP server of the Cisco router is enabled, by the IOS command: ip http server Recording remote destinations Network recording permits the recording of incoming calls answered by remote (off-cluster) devices. This allows to handle some particular scenarios, including: Single Number Reach: the user can answer his office incoming calls from his/her mobile (GSM) phone. On-call duty for critical services. Incoming calls transferred to another CUCM cluster. Incoming calls transferred to off-net destinations (remote call-centres, IVR,etc.). This section describes how to configure CUCM to record this kind of calls. Single Number Reach users Recording phone calls of users that are already enabled on CUCM for single number reach (Mobile Connect) is simple. You just need to: 1) Configure CUCM for Network Recording, as described above. 2) In the Remote Destination Profile, select the associated DN and enable it for recording like it was a regular phone line: Administration Guide 37/78 PBX Configuration

40 DN properties: Other remote destinations If you need to record calls answered by remote destinations that are not associated to a user for Single Number Reach, further configuration settings must be done on CUCM. Just as an example, suppose you have an operator pool working in a Hunt Group (or QME agent group), normally being recorded. Suppose the Hunt Group escalates the call to a remote branch (calling a landline PSTN number) in the case no operators are available. In order to record the calls forwarded to the remote branch, you basically need to create a dummy-user with an "ad-hoc" extension enabled for the Single Number Reach and associated to the remote destination you need to record. If you want to record such forwarded calls, you need to go through the following configuration steps. 1) Define a new end-user (even a generic dummy user, like rec.user1) enabling the checkbox "Enable Mobility": Administration Guide 38/78 PBX Configuration

41 2) Create a new DN, just for recording purpose. This DN will trigger the outgoing call to the remote destination. In the example above, this is the DN will be put in the last position of the Hunt Group, for escalation scopes. Hereafter, for our example, let's assume this DN is ) Create a new Remote Destination Profile (Device => Device Settings => Remote Destination Profile) with following properties: Name and description: whatever you want, for instance: "RDP Employee Mobile Phone" UserID: the end-user created at the previous step (rec.user1) CSS: a valid CSS enabled to place calls to the remote destination Device Pool: a convenient device pool. This device pool should contain at least a transcoding resource if the outgoing call leg is established with an unsupported codec. Save the Remote Destination Profile: Administration Guide 39/78 PBX Configuration

42 4) Add a new DN associated to the Remote Destination Profile, then insert the DN and partition created at the step 2. 5) Go back to the Remote Destination Profile, then click on "Add a New Remote Destination" Administration Guide 40/78 PBX Configuration

43 6) Insert the remote destination number (the mobile remote branch number in the example above), including the off-net prefix, if required. Also, enable the Single Number reach checkbox and make the remote phone immediately rings as soon as the DN rings: 6) Save the remote destination, associate it to the DN defined above (82501) and save again: 6) Go back to the Remote Destination Profile, select the associated DN (82501) and enable it for the network recording: Administration Guide 41/78 PBX Configuration

44 Save and apply the new settings. 7) Configure in the Imagicle Application Suite a (real or dummy) user with the DN defined above (82501) as primary extension number and enable it for Call Recording application. 8) Test the mechanism: place a call to the DN defined above (82501), the remote phone should ring after a few seconds. As soon as the call in answered by the remote phone, the media forking should be triggered automatically and the conversation should be recorded by Imagicle Call Recording. 9) Test the real scenario you need to handle (the hunt group escalation in the example above). Administration Guide 42/78 PBX Configuration

45 Product Integration API Overview This section describes the REST API that can be used to integrate Call Recording and third party systems. Basic Authentication The REST API identifies its user with HTTP Basic Authentication. That is, if a function requires authentication, then it requires the Authorization HTTP header, which must be as follows: Authorization: Basic <userpasswordbase64> where <userpasswordbase64> is the base64 encoding of <user>:<password>. For instance, suppose you need to call a function with user="myuser" and password="mypassword". You need to base64-encode the string "myuser:mypassword", which is "bxl1c2vyom15cgfzc3dvcmq=", obtaining the following HTTP header: Authorization: Basic bxl1c2vyom15cgfzc3dvcmq= Administration Guide 43/78 Product Integration API

46 Get Recording Retrieve metadata information for a (completed) recording. Resource URL GET fw/apps/recorder/webapi/recordings/{id} Resource Information Request Content-Type: application/json Response Content-Type: application/json Requires authentication: Yes Minimum authorization level: Call Recording Base Access (lv. 2) URL Parameters Name Type Required Description Default Example id GUID required The id of the recording null 75A90276-E47E-4e9e-B463-E3C743D5FF3A Request body None Response 200 OK Response body The response body is an application/json object with the following model: Name Type Description id string The identifier of the recording referencenumber string A unique, friendly, identifier generated by Imagicle Call Recording of the recording pbxcallid starttime duration string DateTime ISO-8601 Number provided by the PBX to identify recordings which belong to the same conversation Date and time when the recording begun Duration ISO-8601 Duration of the recording direction Direction Direction of the recorded call localpartynumber string The telephone number of the IP phone recording the call remotepartynumber string The telephone number remote party owner User The user who recorded the call preservinguser User The user who preserved the call (if any) note Note User's defined note for the recording size long Size in bytes of the recording hash Hash Hash that uniquely identify the recording Direction Value Descritpion Administration Guide 44/78 Get Recording

47 0 The direction of the recorded call was unknown 1 The recorded call was incoming 2 The recorded call was outgoing User Value Type Descritpion username firstname lastname string IAS username string The first name of the user string The last name of the user phonenumber string The primary extension of the user group department Note Value Type owner User text string The name of the recording group of the user string The name of the department of the user Descritpion User who last edited the note string The text of the note Hash Value Type Descritpion SHA256 string The SHA-256 hash of the recording Error response 400 Bad Request Id is not a valid GUID 401 Unauthorized No authentication provided or wrong user credentials 403 Forbidden The authenticated user has no sufficient privileges to access the requested recording. 404 Not Found Missing id or recording does not exist. Examples Successful request In this example we get metdata of the recording having id "75A90276-E47E-4e9e-B463-E3C743D5FF3A": GET fw/apps/recorder/webapi/recordings/75a90276-e47e-4e9e-b463-e3c743d5ff3a The response status is 200 Ok, and its body is: { Administration Guide 45/78 Get Recording

48 } "id": "75A90276-E47E-4e9e-B463-E3C743D5FF3A", "referencenumber": " ", "pbxcallid": " ", "starttime": " T14:39: :00", "duration": "PT1M31.87S", "direction": 2, "localpartynumber": "229", "remotepartynumber": "9800", "owner": { "username": "user1", "firstname": "John", "lastname": "Doe", "phonenumber": "101", "group": "Group1", "department": "Sales" }, "preservinguser": { "username": "user2", "firstname": "Jane", "lastname": "Doe", "phonenumber": "102", "group": "Group1", "department": "Sales" }, "note": { "owner": { "username": "user1", "firstname": "John", "lastname": "Doe", "phonenumber": "101", "group": "Group1", "department": "Sales" }, "text": "Ref. invoice No.1234ABC" }, "size": , "hash": { "SHA256": "1DDAE20272E67699E325C31C B770AC04BC1604C9B3B8967FEAEE1037F" } Request failure In this example we try to get metadata of a recording that doesn't exist anymore: GET fw/apps/recorder/webapi/recordings/014309c0-cc7c-4be1-b6ee-6011a67441aa The response status is 404 NotFound. Administration Guide 46/78 Get Recording

49 Download Recording Retrieves the unecrypted MP3 media for a (completed) recording. Note: an audit event of type Download Recording will be generated. Resource URL GET fw/apps/recorder/webapi/recordings/{id}/media Resource Information Request Content-Type: application/json Response Content-Type: audio/mpeg Requires authentication: Yes Minimum authorization level: Call Recording Base Access (lv. 2) URL Parameters Name Type Required Description Default Example id GUID required The id of the recording null 75A90276-E47E-4e9e-B463-E3C743D5FF3A Request body None Response 200 OK Response body The response body is a stream containing the MP3 encoded recording audio. Error response 400 Bad Request Id is not a valid GUID 401 Unauthorized No authentication provided or wrong user credentials 403 Forbidden The authenticated user has no sufficient privileges to access the requested recording. 404 Not Found Missing id or recording does not exist. Administration Guide 47/78 Download Recording

50 Examples Successful request In this example we get the unecrypted media of the recording having id "75A90276-E47E-4e9e-B463-E3C743D5FF3A": GET fw/apps/recorder/webapi/recordings/75a90276-e47e-4e9e-b463-e3c743d5ff3a/media The response status is 200 Ok, and its body contains the recording stream. Request failure In this example we try to download a recording that doesn't exist anymore: GET fw/apps/recorder/webapi/recordings/014309c0-cc7c-4be1-b6ee-6011a67441aa/media The response status is 404 NotFound. Administration Guide 48/78 Download Recording

51 Start Recording Start recording a connected call Resource URL POST fw/apps/recorder/webapi/liverecordings Resource Information Request Content-Type: application/json Response Content-Type: application/json Requires authentication: Yes Minimum authorization level: Call Recording lv.10 URL Parameters None Request body The request body is an application/json object with the following model: StartRecording Name Type Required Description Default Example devicename string directorynumber string Yes, if directorynumber is not specified Yes, if devicename is not specified The device you want to record (there must be a connected call on it). If directorynumber is specified too, the call on the device will be recorded only if it belongs to the given line The line you want to record (there must be a connected call on it). If devicename is specified too, the call on the line will be recorded only if it belongs to the given device null null "101" mode RecordingMode No The recording mode you want to use. 0 0 RecordingMode Value Description 0 Cisco Media Forking 1 Dial-In Response 201 Created The call is being recorded "SEP ABC" Response body Administration Guide 49/78 Start Recording

52 Name Type Description id string The identifier of the recording you just started Error response 400 Bad Request The request contains some errors Response body Name Type Description reason devicename string BadRequestReason Value BadRequestReason The reason why the request has been rejected The name of the device that cannot be monitored through TAPI. Present only if reason=1. Descritpion 0 The request body contains neither the device name nor the directory number 1 The line identified by given device name and/or directory number does not exist or isn't monitorable through TAPI 2 Invalid recording mode 401 Unauthorized No authentication provided or wrong user credentials 403 Forbidden The call cannot be recorded due to user authorization issues or to the restrictions set on the Imagicle Call Recording Service Response body Name Type Description reason username string ForbiddenReason Value ForbiddenReason The reason why the request has been rejected 0 Authenticated user is unauthorized The username associated to the call is not authorized to record. Present only if reason=1. Description 1 The user associated to the call is not authorized to record 2 The call direction doesn't match the filter set on the Imagicle Call Recording service 3 The call traffic type doesn't match the filter set on the Imagicle Call Recording service 4 Remote party is in the blacklist set on the Imagicle Call Recording service 409 Conflict The call cannot be recorded due to the current status of the Imagicle Call Recording service Response body Name Type Description Administration Guide 50/78 Start Recording

53 reason extension string ConflictReason Value ConflictReason The reason why the request has been rejected Directory number of the line having a connected call but no user associated (may be null if no such line has been found) Descritpion 0 The call connected on given device is on a line with no IAS user associated to it 1 There is no connected call on given device 429 Too Many Requests The request has already been received Response body Name Type Description reason TooManyRequestsReason The reason why the request has been rejected TooManyRequestsReason Value Descritpion 0 Another recording request has already been received for this call (the recording has not started yet) 1 The call is already being recorded 500 Internal Server Error An error occurred while processing the request 501 Not Implemented The call cannot be recorded due to a misconfiguration of the Imagicle Call Recording service Response body Name Type Description reason NotImplementedReason The reason why the request has been rejected NotImplementedReason Value 0 Invalid Imagicle Call Recording license Description 1 No recording pilot has been configured on the Imagicle Call Recording service 2 Configured recording pilot doesn't route calls to the Imagicle Call Recording service (if mode is DialIn), or something is not correctly configured on CUCM side (if mode is MediaForking) 503 Service Unavailable The call cannot be recorded because all licensed channels are being used Examples Successful request Administration Guide 51/78 Start Recording

54 In this example we start recording a connected call on the device "SEP ABC" using Cisco Media Forking: POST fw/apps/recorder/webapi/liverecordings Request body: { } "devicename": "SEP ABC" The response status is 201 Created, and its body is: { } "id": "6b98303a-b a-adae-19b78aca468d" Request failure In this example we try to start recording a connected call on the device "SEP ABC" for the directory number "101" using Dial-In, but the call is already being recorded: POST fw/apps/recorder/webapi/liverecordings Request body: { } "devicename": "SEP ABC", "directorynumber": "101", "mode": 1 The response status is 429 TooManyRequests, and its body is: { } "reason": 1 Administration Guide 52/78 Start Recording

55 Stop Recording Stop recording a call By recording id Stop recording the call identified by the id returned when the recording was started. Resource URL DELETE fw/apps/recorder/webapi/liverecordings/{id} Resource Information Request Content-Type: - Response Content-Type: - Requires authentication: Yes Minimum authorization level: Call Recording lv.10 URL Parameters Name Type Required Description Default Example id GUID required The id of the recording null 75A90276-E47E-4e9e-B463-E3C743D5FF3A Request body None Response 204 No Content The recording has been stopped. Error response 400 Bad Request The request contains some errors Response body Name Type Description reason devicename string BadRequestReason Value BadRequestReason The reason why the request has been rejected 0 Id is not a valid GUID The name of the device that cannot be monitored through TAPI. Present only if reason=1. Descritpion 1 Id identifies a recording on a line that isn't monitorable through TAPI Administration Guide 53/78 Stop Recording

56 401 Unauthorized No authentication provided or wrong user credentials 403 Forbidden The authenticated user has no sufficient privileges to stop a recording 409 Conflict Id doesn't identify a live recording 500 Internal Server Error An error occurred while processing the request Examples Successful request In this example we stop the recording having id "75A90276-E47E-4e9e-B463-E3C743D5FF3A": DELETE fw/apps/recorder/webapi/liverecordings/75a90276-e47e-4e9e-b463-e3c743d5ff3a The response status is 204 No Content, and the recording having the given id has been stopped. Request failure In this example we try to stop the recording having id "75A90276-E47E-4e9e-B463-E3C743D5FF3A", but the given id doesn't identify a live recording: DELETE fw/apps/recorder/webapi/liverecordings/75a90276-e47e-4e9e-b463-e3c743d5ff3a The response status is 409 Conflict. By device name and directory number Stop a recording on the line identified by the device name and/or the directory number. Resource URL DELETE fw/apps/recorder/webapi/liverecordings?devicename={devicename}&directorynumber={directorynumber} Resource Information Request Content-Type: - Response Content-Type: - Requires authentication: Yes Minimum authorization level: Call Recording lv.10 Administration Guide 54/78 Stop Recording

57 URL Parameters Name Type Required Description Default Example devicename string directorynumber string Request body None Yes, if directorynumber is not specified Yes, if devicename is not specified The device having the recording you want to stop. If directorynumber is specified too, the recording on the device will be stopped only if it belongs to the given line. If the recording you want to stop is a manually started dial-in, don't specify this parameter. Specify just the directorynumber or use the version of the function with the recording id instead. The line having the recording you want to stop. If devicename is specified too, the recording on the line will be stopped only if it belongs to the given device null null "101" "SEP ABC" Response 204 No Content The recording has been stopped. Error response 400 Bad Request The request contains some errors Response body Name Type Description reason devicename string BadRequestReason Value BadRequestReason The reason why the request has been rejected 0 No device name nor directory number specified The name of the device that cannot be monitored through TAPI. Present only if reason=1. Descritpion 1 The line identified by given device name and/or directory number has a live recording, but is not monitorable through TAPI 401 Unauthorized No authentication provided or wrong user credentials 403 Forbidden The authenticated user has no sufficient privileges to stop a recording Administration Guide 55/78 Stop Recording

58 409 Conflict There is not a call being recorded on the given device name and/or directory number There is a call being recorded, but it is a manually started dial-in and the stop has been invoked providing the device name 500 Internal Server Error An error occurred while processing the request Examples Successful request In this example we stop the recording on device "SEP ABC": DELETE fw/apps/recorder/webapi/liverecordings?devicename=sep abc The response status is 204 No Content, and the recording on the given device has been stopped. Request failure In this example we try to stop recording a connected call on the device "SEP ABC" for the directory number "101", but the call is not being recorded: DELETE fw/apps/recorder/webapi/liverecordings?devicename=sep abc&directorynumber=101 The response status is 409 Conflict. Administration Guide 56/78 Stop Recording

59 User Guides Call Recording User Guides Please download the user guide here. English User Guides 57/78 User Guides

60 Usage on the IP Phone When On Demand recording is configured on the IP Phone, you must press the Record softkey to start recording the conversation. If configured, you will hear a tone every 15 seconds that tells you that the call is being recorded. In case no recording softkey is available for your IP phone, you can still record the conversation through the Dial In recording mode. Just conference the Call Recording pilot number to start the recording. Aks for this number to your system administrator. Note: Always On recording requires no interaction from the user. User Guides 58/78 Usage on the IP Phone

61 Usage Trough the Web Interface The web interface allows the Call Recording users, Group Supervisors and Administrators to list, search and listen to the recordings. The recordings are displayed from the most recent to the oldest. The following information is available: The call direction is displayed on the left. A red upwards arrow identifies the outgoing calls, i.e. the calls placed by the monitored extension, while a blue arrow marks the incoming calls (i.e. calls from PSTN). In the date column you can see the date and time when the recording begun. The duration is expressed in hours, minutes and seconds and it refers to the portion of the call being recorded. In case of On Demand recording, this will be shorter than the total length of the call. To know the total length of the call you can use Imagicle Billing. In the extension column, you can see the primary extension of the IP phone (local party) recording the call, as defined in the IAS user's list In the user column, the first name and last name of the IAS user associated with the extension recording the call If the remote party number can be found in a Speedy Enterprise directory, the contact name is displayed in the Contact column (see below) Rec ID: this is a unique generated by Imagicle Call Recording, uniquely identifying the call. When HA is enabled, the ID is unique across the nodes of the cluster PBX Call ID: this number is provided by the PBX to identify recordings which belong to the same conversation. For example, if the user starts and stops the recording more than one time during the conversation, different recordings will appear in the list, all belonging to the same conversation and sharing the same PBX call id Note: even if the recording of a call is complete, it takes some time before it is encoded and made available for playback. Press the "refresh" button to display the newly recorded calls. To listen to a recorded call, click on it and press the play button. To download the recording as mp3 file, press the icon on the bottom left. To delete the recording, press the trash icon on the left. If you cannot delete the recording, it is a matter of permissions. Most probably your profile is not allowed to delete the recordings. If you are an Administrator for the Imagicle Call Recording application and still you cannot delete the recording, then check Global Settings -> Permissions. "Recording can be deleted by" is probably set to "nobody". You can also add a note to the recording. When a note is available for a recording, an icon is displayed on the left, close to direction. By moving the mouse pointer on the icon you'll be able to read the note, as well as the name of the user who last edited the note text. Preserving a recorded call Preserving a call is allowed if the system is configured to automatically delete the recordings after some time. In this case the call retention time can be extended by selecting the call and pressing the pin icon on the left. The amount of the call retention time is configured by the administrator in the global settings, and is displayed to the user through a tooltip. Searching for a recorded call When looking for a specific call, you can filter the available recordings by date/time and duration with the controls on the top of the page. You can also search the note by entering a portion of the text and pressing "enter". The recordings list can also be filtered by one or more columns, by entering a portion of the data you are looking for. If you enter more than one condition, only the recordings matching all the conditions are displayed. Understanding directory integration and contact name resolution If Speedy Enterprise is licensed, when the user displays the recordings a lookup is performed in Speedy external contacts directories to display the contact name. User Guides 59/78 Usage Trough the Web Interface

62 The lookup is made in the directories available to the user, which are based on Speedy permissions, user's departments an so on. For this reason, different users can see different results. User Guides 60/78 Usage Trough the Web Interface

63 Call Recording Gadget for Jabber Desktop Imagicle Call Recording gadget for Cisco Jabber allows the user to easily record and manage the call recordings. You can manage the recordings as you would do through the web interface. Note: Jabber calls cannot be recorded on-demand. User Guides 61/78 Call Recording Gadget for Jabber Desktop

64 FAQ and Solutions Configure Cisco ECC Curri to use HTTPS Applies from Application Suite Applies to: Imagicle Application Suite, rel. Summer 2017 or newer Description: This article details how to configure CuCM and IAS to use HTTPS for ECC-Curri. Curri can be used with several IAS applications: StoneLock, Speedy Lookup and/or SmartNumbers, Call Recording announcement. How-to: Requirements On CuCM, the DNS must be correctly configured to resolve IAS server(s) FQDN. When the IAS server is joined to a domain, the Active Directory will try to register the IAS computer name in the company DNS. Hence, every server should be able to resolve the IAS server name. If this is not the case, you must add a static entry in the company DNS to let the CUCM reach the IAS server using its name (fqdn). 1. Configure the External Call Control Profile for HTTPS In the Primary Web Service field of the ECC profile, enter the IAS web service URL, e.g. Notes: a. In the address remember to specify the port :443. The port number must be explicity written even if implied by the https protocol. b. In the address you must use the netbios computer name (ias.mydomain.com), not the IP address. It must be the same name specified in the Common Name of the SSL certificate (CN value) FAQ and Solutions 62/78 FAQ and Solutions

65 2. Adjust the Certificate on the IAS server The Common Name (CN) field of the certificate used by IIS must contain the machine Fully Qualified Domain Name used in the External Call Control profile URL. To ensure this, different steps has to be followed depending on whether the customer has a certificate issued by a trusted Certificate Authority (CA), trusted by the Domain Controller, or wants to use a self-signed certificate. The procedure is detailed in How to install and use a certificate on Imagicle Application Suite server to use HTTPS protocol 3. Import certificate(s) into CUCM In order to let CUCM trust the HTTPS connection, the certificate configured on IAS web server must be imported into all CUCM nodes. Note: for HA installations, you must repeat the following procedure for each IAS cluster node. a. Export the Certificate used by Application Suite web server In "Server Certificates" section of "Internet Information Services (IIS) Manager", double click on the certificate used by the binding on port 443 (see previous paragraph). Click on "Details" tab and then click on "Copy to File.." button. The Certificate Export Wizard will start, click Next. Choose "No, do not export private key". FAQ and Solutions 63/78 Configure Cisco ECC Curri to use HTTPS

66 Choose to export certificate in "DER encoded binary X.509 (CER)" format. FAQ and Solutions 64/78 Configure Cisco ECC Curri to use HTTPS

67 Then complete the wizard, it will save a.cer file. b. Load certificate(s) to CUCM The certificates must be loaded on all CUCM nodes. Since CUCM 8.5, they're expected to be automatically replicated among cluster nodes. Login into "Cisco Unified OS Administration", and go to "Security", "Certificate Management". Then click on "Upload Certificate/Certificate chain" FAQ and Solutions 65/78 Configure Cisco ECC Curri to use HTTPS

68 In the upload form, choose "CallManager-trust" as Certificate purpose, then select the.cer file and upload it. Go to "Certificate Management" of each CUCM node to check that certificate has been properly replicated. Troubleshooting: check certificates trust chain In order to let CUCM trust the HTTPS connection established with IAS web server, CUCM must also know all the certificates in IAS certificate's certification path. In "Server Certificates" section of "Internet Information Services (IIS) Manager", double click on the certificate used by the binding on port 443. Click on "Certification Path" tab: CUCM must be able to verify every certificate displayed in this panel. So, in CUCM, go to "Certificate Management" and check that appropriate entries exist with "CallManager-trust" as Certificate purpose. If not, select the missing certificate in the "Certification path" panel, export and upload it to CUCM as explained in step 3b. FAQ and Solutions 66/78 Configure Cisco ECC Curri to use HTTPS

69 FAQ and Solutions 67/78 Configure Cisco ECC Curri to use HTTPS

70 Unable to retrieve recordings Applies to Imagicle Application Suite up to 2018.Winter.1 Description When a standard "User" try to open recording web page it receives: Unable to retrieve recordings. Please try again While the Administrator user can see web page and all records without any error. Looking at "<StonevoiceAS>\var\log\w3wp\recorder.log" log file it is possible to observe this exception: Exception Type {Speedy.Core.Common.SvOperationFailedException} Message {FindContactsByPhoneNumber: exception occurred} StackTrace { at Speedy.Directory.Api.SvDirApi.ReverseLookup(ISet`1 phonenumbers, IContactInfoFinderSettings settings) at ApplicationSuite.Web.Helper.WebRequestAwareContactInfoFinder.ReverseLookup(ISet`1 phonenumbers, ContactInfoFinderSettings settings) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookup.<>c DisplayClass11_0.<Lookup>b 1(ISet`1 numberstosearch) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookup.LookupMultipleNumbers(IEnumerable`1 phonenumbers, Func`2 contactsearchfunc) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookup.Lookup(String username, IEnumerable`1 phonenumbers) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookupWithCache.<>c DisplayClass13_0.<Lookup>b 1(IEnumerable`1 cachemisses) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookupWithCache.Lookup(IEnumerable`1 phonenumbers, Func`2 createcachekey, Func`2 lookupcachemisses) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookupWithCache.Lookup(String username, IEnumerable`1 phonenumbers) at Recorder.Engine.Recordings.RecordigsWithContactsRepository.LookupContactsForMultipleCalls(PagedResult`1 recordings) at Recorder.Engine.Recordings.RecordigsWithContactsRepository.GetRecordingsBase(ISearchCriteria options, Func`2 action) at Recorder.Engine.Recordings.RecordigsWithContactsRepository.GetRecordings(ISearchCriteria options) at Recorder.WebServices.RecordingsBrowser.GetRecordingsWebMethod.Execute(String username) at ApplicationSuite.Base.Library.WCF.WebService.Execute[TReturn](IWebMethod`1 webmethod)} InnerException { Exception Type {NHibernate.QueryException} Message {An empty parameter-list generate wrong SQL; parameter name 'directories'} StackTrace { FAQ and Solutions 68/78 Unable to retrieve recordings

71 at NHibernate.Impl.AbstractQueryImpl.SetParameterList(String name, IEnumerable vals, IType type) at NHibernate.Impl.AbstractQueryImpl.SetParameterList(String name, IEnumerable vals) at ApplicationSuite.Data.NhEntities.Sas.Speedy.SvContactDao.InternalFindContacts(IEnumerable`1 directories, IEnumerable`1 phonenumbers, IEnumerable`1 phonenumberfields, Boolean findinlocalcontactsonly) at ApplicationSuite.Data.NhEntities.Sas.Speedy.SvContactDao.FindContactsInDirectoriesByPhoneNumbers(IEnumerable`1 directories, IEnumerable`1 phonenumbers, IEnumerable`1 phonenumberfields) at Speedy.Directory.Api.SvDirApi.ReverseLookup(ISet`1 phonenumbers, IContactInfoFinderSettings settings)} } }}, StatusCode Cause The user logged in the Application suite is not authorized to see any directories Solution The bug has been fixed in IAS to 2018.Winter.1. Without upgrading Application Suite, a workaround can be applied: just create a public directory or a department one available to the user. FAQ and Solutions 69/78 Unable to retrieve recordings

72 Unable to retrieve recordings (new installation) to version Application Suite Applies from Application Suite Applies to Imagicle Application Suite 2017.Summer.2 or 2017.Summer.3 - installed from scratch Description When a standard "User" try to open recording web page it receives: "Unable to retrieve recordings. Please try again" While the Administrator user can see web page and all records without any error. Looking at "<StonevoiceAS>\var\log\w3wp\recorder.log" log file it is possible to observe this exception: Exception Type {Speedy.Core.Common.SvOperationFailedException} Message {FindContactsByPhoneNumber: exception occurred} StackTrace { at Speedy.Directory.Api.SvDirApi.ReverseLookup(ISet`1 phonenumbers, IContactInfoFinderSettings settings) at ApplicationSuite.Web.Helper.WebRequestAwareContactInfoFinder.ReverseLookup(ISet`1 phonenumbers, ContactInfoFinderSettings settings) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookup.<>c DisplayClass11_0.<Lookup>b 1(ISet`1 numberstosearch) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookup.LookupMultipleNumbers(IEnumerable`1 phonenumbers, Func`2 contactsearchfunc) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookup.Lookup(String username, IEnumerable`1 phonenumbers) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookupWithCache.<>c DisplayClass13_0.<Lookup>b 1(IEnumerable`1 cachemisses) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookupWithCache.Lookup(IEnumerable`1 phonenumbers, Func`2 createcachekey, Func`2 lookupcachemisses) at Speedy.Directory.Api.ReverseLookup.ReverseContactLookupWithCache.Lookup(String username, IEnumerable`1 phonenumbers) at Recorder.Engine.Recordings.RecordigsWithContactsRepository.LookupContactsForMultipleCalls(PagedResult`1 recordings) at Recorder.Engine.Recordings.RecordigsWithContactsRepository.GetRecordingsBase(ISearchCriteria options, Func`2 action) at Recorder.Engine.Recordings.RecordigsWithContactsRepository.GetRecordings(ISearchCriteria options) at Recorder.WebServices.RecordingsBrowser.GetRecordingsWebMethod.Execute(String username) FAQ and Solutions 70/78 Unable to retrieve recordings (new installation)

73 at ApplicationSuite.Base.Library.WCF.WebService.Execute[TReturn](IWebMethod`1 webmethod)} InnerException { Exception Type {NHibernate.QueryException} Message {An empty parameter-list generate wrong SQL; parameter name 'directories'} StackTrace { at NHibernate.Impl.AbstractQueryImpl.SetParameterList(String name, IEnumerable vals, IType type) at NHibernate.Impl.AbstractQueryImpl.SetParameterList(String name, IEnumerable vals) at ApplicationSuite.Data.NhEntities.Sas.Speedy.SvContactDao.InternalFindContacts(IEnumerable`1 directories, IEnumerable`1 phonenumbers, IEnumerable`1 phonenumberfields, Boolean findinlocalcontactsonly) at ApplicationSuite.Data.NhEntities.Sas.Speedy.SvContactDao.FindContactsInDirectoriesByPhoneNumbers(IEnumerable`1 directories, IEnumerable`1 phonenumbers, IEnumerable`1 phonenumberfields) at Speedy.Directory.Api.SvDirApi.ReverseLookup(ISet`1 phonenumbers, IContactInfoFinderSettings settings)} } }}, StatusCode Cause The configuration file <StonevoiceAS>\Apps\Speedy\Settings\Speedy.Configuration.Global.config.xml contains wrong pre-defined values, instead an empty config. Solution 1. Edit file "<StonevoiceAS>\Apps\Speedy\Settings\Speedy.Configuration.Global.config.xml" and remove the following preference keys: "directory.internalsdefaultdirname" "directory.localdirectoryspecialdepartment" "directory.excludethisusernamefromlocaldirectories" 2. Edit file "<StonevoiceAS>\Apps\Speedy\Server\System\Speedy.ini" and delete the following keys from section [Settings]: internalsdefaultdirname LocalDirectorySpecialDepartment ExcludeThisUsernameFromLocalDirectories 3. Update directories content, following these steps: Login to the IAS web portal as administrator and go to Speedy, Manage Service web page Locate the "Internal contacts settings" section and change the radio button value. Click Save. This will start the local contacts update procedure, that may take some seconds.. Reload the page until the radio button becomes enabled (the local contacts update completed) Change again the radio button value, back to the original value. Click Save. FAQ and Solutions 71/78 Unable to retrieve recordings (new installation)

74 How to Regenerate Imagicle Call Recording Certificate Applies from Application Suite to version Application Suite 201x (any version) Applies to: Imagicle Application Suite 2017 Summer Edition and newer. Description: The Call Recording security certificate must be loaded on CuCM to be able to record encrypted calls. The certificate may become invalid, preventing the recording of encrypted calls, when: It expires (5 years after deployment). You change the Computer Name of the Imagicle Server. Solution: The following procedure forces Imagicle Call Recording to create a new self-signed certificate for the machine it is installed on, including the current Computer Name. The procedure requires you to restart Imagicle Call Recording service, and should be executed when no calls are being recorder. 1. Log onto the IAS server as Administrator 2. Locate the following folder: <install-dir>\apps\applicationsuite\certificates 3. Delete these files: imagicle-certificate.pem, imagicle-privatekey.pem 4. Log into the IAS web interface as Administrator 5. Go to "Call Recording", "Manage service" and restart Imagicle Call Recording service 6. Click on "Global Settings", select "Secure Recording" and download the new certificate 7. Load the new certificate on CuCM as described in the Administration Guide 8. Update the Security Profile with the new certificate CN (Common Name) FAQ and Solutions 72/78 How to Regenerate Imagicle Call Recording Certificate

75 Playing an audio message (announcement) when receiving a call which will be recorded Applies to: Imagicle Call Recording Imagicle Application Suite or later CUCM 10.0 and later Description: This procedure allows CuCm to play an announcement when receiving a call using CURRI (ECC) technology. The announcement will be played before the call rings. How-to: Upload the voice prompt to the CUCM web interface (Media resources -> Announcements) Modify the URL in the Ecc profile, passing the name of the announcement you created as parameter, like this: Where "prompt_name" is the name of the voice prompt you just uploaded. Apply the ECC profile on the line (directory) More information about ECC configuration: FAQ and Solutions Playing an audio 73/78message (announcement) when receiving a call which will be recorded

76 Cannot play or download call recordings after the Imagicle server joined a Windows domain Applies to IAS for Cisco UC rel Winter.1 ( ) Description After the Imagicle server joined a Windows domain, the call recordings are properly stored but cannot be played, downloaded or exported. When you click on a recording, usually a tab with the playback controls appears, in this case you obtain an error for all the available recordings. The problem affects installations using the default call recording self-signed certificate (builtin by Imagicle), it is not affecting installations using a trusted certificate installed by the customer. In order to verify that you are running into this issue, run certlm.msc from Imagicle server, under Certificates - Local Computer -> Personal -> Certificates right click on Imagicle Call Recording, All tasks -> Manage private keys, if this operation results in an error message "No private keys are available" this means that you are running into this issue. Cause When the Imagicle server joins the Windows domain, some restrictions to the existing self-signed certificates may be applied by the Windows domain policies. In particular, the call recording service may be not longer able to extract the private key of the sel-signed certificate, necessary to decrypt the stored recordings. Solution There are two different ways to resolve this issue: 1. Install a new trusted certificate 2. Re-install the default self-signed certificate Notice that solution 1 enables to play, download and export the new recordings. Previous recordings encrypted and stored with the default certificate can be retrieved only into another Imagicle Application Suite server, out of the Windows domain, restoring a backup of the Imagicle Application Suite. Solution 1 (Install a new trusted certificate) 1. If you want to use a trusted certificate, install the trusted certificate in the Imagicle Server (in the "Personal" folder of the Windows certificate snap-in). 2. In the Call Recording web admin pages, select Global Settings --> Data Management, then in the Certificate option select the certificate just installed. 3. Make a new recording and ensure you can play and download it. Solution 2 (Re-install default self signed certificate) 1. Run certlm.msc, under Certificates - Local Computer -> Personal -> Certificates right click on Imagicle Call Recording and delete the certificate. 2. Open powershell with administrative privileges and move to <IAS_INSTALLATION_FOLDER>\System\SSL 3. Run the command.\imagiclecallrecordingcert.ps1 and verify that no errors are given as output 4. In the Call Recording web admin pages, select Global Settings --> Data Management, then in the Certificate option verify that the selected certificate is Imagicle Call Recording 5. Make a new recording and ensure you can play and download it. FAQ and Solutions Cannot play or download 74/78 call recordings after the Imagicle server joined a Windows domain

77 Configure Cisco XML Service in HTTPS Applies to: Imagicle Application Suite, all versions Description: This article details how to configure a Cisco XML to use HTTPS toward IAS. This can be used for different IAS application: StoneLock, Speedy Lookup and/or SmartNumbers, Call Recording announcement. How-to: Export the certificate from the Application suite server Follow procedure explained in Configure Cisco ECC Curri in HTTPS Import the certificate into CUCM Follow the same steps explained in Configure Cisco ECC Curri in HTTPS but choose "Phone-trust" as Certificate purpose. Configure XML service FAQ and Solutions 75/78 Configure Cisco XML Service in HTTPS

78 Note to use the FQDN (and not the IP or other) of the IAS host as defined in its certificate in the "Service URL". After this configuration you can test -for example- the Stonelock service making a call from a locked phone and checking that ECC is working like shown in "Phone Lock" "Call History" page in the Application Suite: FAQ and Solutions 76/78 Configure Cisco XML Service in HTTPS