This document describes the configuration steps needed to setup the Recorder on the Cisco Meeting Server (CMS) Call Bridge (CB).
The Recorder is available from release 1.9 of the Acano server. The Recorder provides the capabilility of recording meetings and saving the recordings on a Network File System (NFS) document storage.
There are no specific requirements for this document.
The information in this document is based on these software and hardware versions:
1. CMS 1.9 or above
2. Postman from Google Chrome
3. CMS Application Program Interface (API)
The information in this document was created from the devices in a specific lab environment. All of the devices used in here started with cleared (default) configurations. If your network is live, make sure that you understand the potential impact of any command.
1. The Recorder behaves like an Extensible Messaging and Presence Protocol (XMPP) client, so the XMPP server needs to be enabled on the server that hosts the Call Bridge.
1. The Recorder should be hosted on an Acano server that is remote to the server that hosts the CB as shown in this figure:
2. Redundant deployment of the Recorder is also supported. If redundancy is setup, the recordings are load balanced between all recording devices (servers). This means that every CB will use every Recorder available, as this figure shows:
3. The same applies in the opposite, when there are multiple CBs. All the CBs will use the Recorder availabe to them, as this figure shows:
The Recorder can also be hosted on the same server as the CB, but this should only be used for testing or very small deployments, see the figure. The drawback here is that you may only be able to make 1 -2 simulteneous recordings:
Part 1: On the Recorder server:
a. Configure the Recorder to listen on the interface(s) of your choice with this command:
recorder listen <interface[:port] whitelist>
b. If the recorder is on the local CB, the interface must be the set to “loopback”, so use this command:
recorder listen lo:8443
c. If it’s to listen on a specific interface, let’s say “a”, then use this:
recorder listen a:8443
NOTE: If you configure the recorder on a node of clustered CB, the interface should be the local listening interface of the node on which the recorder is being configured.
d. Set the certificate file to be used by the recorder. You can use a certificate that already exists and private key file used by the CB, for example.
recorder certs <keyfile> <certificatefile>
e. Add the CB certificate to the Recorder trust store using the command:
recorder trust <crt-bundle>
The crt-bundle should contain the certificate used by the CB, if different. If in a cluster, this must contain the certificates of every CB in the cluster.
f. Specify the hostname or IP address of the NFS, and the directory on the NFS to Store the recordings:
recorder nfs <hostname/IP>:<directory>
NOTE: The Recorder does not authenticate to the NFS but it’s important that the Recorder Server has read/write access to the NFS directory.
g. Enable the Recorder, with the use of the command:
Part 2: On the CB:
Create an API user on the CB, this is required for further configurations using the API function:
Create the user with these steps:
a. Connect via Secure Shell (SSH) or console to the CB with the use of the admin credentials.
b. User add <username> api, then press the Return key and enter the password followed by the Return Key.
url=https://<IP Address of recorder>:8443 (if the recorder is not on the local CB)
Note: dtmfProfile, callProfile and callLegProfileare particularly important for SIP endpoints that join a cospace conference. They allow the Endpoint to be able to start/stop the recording of a call to/from the cospace.
As from CMA 1.9.3 and CMS 2.0.1, the DTMF tones are not required now there is the button that's added to the client when the recorder is present on or known to the callbridge to which the client is connected. The record button has been added to WebRTC from CMS 2.3 as well.
4. Create a callProfile:
a. Send an empty POST with https://<Callbridge_IP>:445/api/v1/callProfiles
b. Send a GET with the same URL in (a), copy the callProfile ID, without the quotes to Notepad
c. Set the recordingMode on the callProfile by sending a PUT with https://<Callbridge_IP>:445/api/v1/callProfiles/<call profile ID> and add the in BODY before you execute the PUT.
recordingMode=Manual (if you want callers to start recording using DTMF entries)
recordingMode=Automatic (if recording should start automatically when calls are launched)
NOTE: If you use POSTER from firefox, you have to click on “content to send” then select "body from parameters"
before sending the PUT/POST, this way it's compiled in the code(s) that the CB can understand.
5. Add call Profile to the System Profiles:
The callProfile defines whether calls can be recordings and if they can be done with or without user intervention.