Skip to main content
  • Products
    • Overview
    • Features
    • Screen Capture
    • Agent evaluation / score cards
    • Speech Analytics
    • Recording Announcement
    • Videos
    • Online demo
    • Quote
    • Download
  • Solutions
    • Businesses
    • Contact centers
    • Financial institutions
    • Healthcare
    • MiFID II compliance
    • Telecom service providers
    • Traders
  • Compatibility
    • AudioCodes
    • Avaya
    • BroadSoft
    • Cisco
    • Genband
    • IPC
    • Metaswitch
    • Oracle AcmePacket
    • SIPREC recording
    • Sonus
  • Documentation
    • User Guide
    • Administration Guide
    • Developer Guide
    • MiaRec v.3 (old) documentation
    • Resource library
    • Videos
  • Support
    • Submit a request
    • Check your existing requests
    • TeamViewer QuickSupport
  • Blog
  • Company
    • About MiaRec
    • Contact us
    • Our clients
    • Become a partner
    • News
    • Careers
    • Events

Table of Content

  • Administration Guide
    • Hardware requirements
      • Overview
      • All-in-one server
      • Decoupled architecture
      • Decoupled with GEO-redundancy
      • Disk space requirements
    • Installation
      • Ansible-based installation on Linux
        • Overview
        • 1. Prepare controller host
        • 2. Prepare target hosts
        • 3. Configure deployment
        • 4. Run playbooks
        • 5. Verify MiaRec operation
      • VMWare OVA template-based installation
      • Deploying MiaRec on Amazon AWS (up to 2,000 users)
        • 1. Network architecture
        • 2. Create VPC
        • 3. Create EC2 instances
        • 4. Configure Elastic IP address
        • 5. Install MiaRec software on EC2 instance
        • 6. Configure Route 53 DNS Failover for web traffic
        • 7. Configure DNS SRV for SIPREC traffic
        • 8. Configure SIPREC recording
        • 9. Configure automatic file relocation to Amazon S3
        • 10. Configure MiaRec replication
        • 11. Configure HTTPS for web server
        • 12. Configure CloudWatch monitoring
        • 13. Disaster recovery plan
      • Installation on Windows
        • Install MiaRec software
    • Update
      • Ansible-based update on Linux
      • Migrate from manual to Ansible-based setup
    • Post-installation tasks
      • Firewall configuration
      • Enable HTTPS for MiaRec Web portal
        • Setup free SSL certificate for MiaRec using Let's Encrypt (Ubuntu 14.04)
        • Setup free SSL certificate for MiaRec using Let's Encrypt (Centos 6/7)
        • Setup SSL certificate for MiaRec Web portal on Centos
    • Phone system integration
      • Avaya Aura call recording
        • Avaya TSAPI DMCC recording
          • 1. Introduction
          • 2. Configure Avaya Communication Manager
          • 3. Configure Avaya Application Enablement Services
          • 4. Configure MiaRec Call Recording System
          • 5. Verification and Troubleshooting
          • 6. Additional references
        • Avaya TSAPI passive recording
          • 1. Introduction
          • 2. Network Configuration
          • 3. Configure Avaya Communication Manager
          • 4. Configure Avaya Application Enablement Services
          • 5. Configure MiaRec Call Recording System
          • 6. Verification
          • 7. Additional references
      • Avaya SBCE SIPREC call recording
        • 01. How it works
        • 02. Access Avaya SBCE web interface
        • 03. Add Server Configuration Profile
        • 04. Add Routing Profile for Recording Server
        • 05. Define Application Rules
        • 06. Define Media Rules
        • 07. Configure UCID
        • 08. Define End Point Policy Group
        • 09. Define Session Policies
        • 10. Define Session Flows
        • 11. Define Server Flows
        • 12. Configure MiaRec SIPREC recordging interface
      • Broadsoft call recording
        • Broadsoft SIPREC recording
      • Cisco CUBE SIPREC call recording
        • Cisco CUBE SIPREC configuration
        • MiaRec SIPREC configuration
      • Cisco UCM call recording
        • Cisco active recording (Built-in-Bridge)
          • Overview
          • Cisco phones supporting Built-in-Bridge feature
          • Configure CUCM
            • Create SIP profile for recorder
            • Create SIP Trunk Security Profile
            • Create a SIP Trunk that points to the recorder
            • Create a recording profile
            • Create a route pattern/group for the recorder
              • Single server configuration
              • Multiple servers configuration
            • Enable Built-in-Bridge for all phones (optional)
            • Codecs configuration
          • Configure phones
            • Enable Built-in-Bridge on per-phone basis
            • Enable recording for a line appearance
          • Configure MiaRec
          • Configure firewall
          • Optional configuration
            • Configure tones for recording (optional)
            • [Howto] Configure SIP/TLS for SIP Trunk (optional)
        • Cisco phone services
      • Cisco UCM recording announcement
        • Overview
        • Installation guide
          • Player - Configuration
          • CUCM - SIP profile
          • CUCM - SIP Trunk Security Profile
          • CUCM - SIP Trunk
          • CUCM - Route pattern
          • CUCM - Built-in-Bridge (system level)
          • CUCM - TAPI user
          • Controller - Cisco TAPI TSP driver
          • Controller - Verify TAPI configuration
          • Controller - Configuration
      • Metaswitch call recording
        • Metaswitch SIPREC configuration
        • MiaRec configuration for Metaswitch call recording
        • Ignore Metaswitch internal redirect numbers
        • Automatic user provisioning
        • High availability configuration
          • SIPREC auto-failover configuration
            • Configure SIPREC auto-failover for a CFS-Perimeta-MiaRec connection
            • Configure SIPREC auto-failover for a direct CFS-MiaRec connection
        • Softkey integration with Polycom VVX (Metaswitch platform)
        • User authentication using Metaswitch CommPortal
      • Soft key integration with phones
        • Overview - Soft keys on IP phones
        • Configure MiaRec phone services
        • Integration with Cisco SPA and 3PCC series phones
        • Integration with Mitel/Aastra phones
        • Integration with Polycom VVX series phones
        • Integration with Yealink phones
        • Softkey integration with Cisco 7900, 7800 and 8800 series phones
          • Overview
          • Create MiaRec IP Phone Service
          • Subscribe each phone to MiaRec phone service
    • User management
      • Understanding user roles and permissions
      • Roles
      • Groups
      • Users
      • Associating calls with users
      • Configuring LDAP integration
      • Multi-tenancy
        • Enable multi-tenancy in MiaRec
        • Understanding multi-tenancy
        • Add tenant
    • Storage management
      • Audio file encryption
        • File encryption overview
        • Configuration check-list
        • Create new encryption key
        • Import encryption key
        • Export encryption key
        • Grant access to encryption key
        • Enable file encryption
        • Export of the encrypted files
      • Audio settings
      • Backup and restore
        • Backup call recordings
        • Restore call recordings
      • Location for audio files
        • File name format
        • Time formatting inside file name
      • Replication
        • MiaRec multi-master asynchronous replication
        • Use cases for replication
        • Configuring target server (recipient)
        • Configuring replication server (sender)
      • Retention policy
    • Customization
      • Calls list layout
      • Timezone settings
      • Translate MiaRec to other language
    • Maintenance
      • Troubleshooting
        • Log files
        • MiaRec recorder trace
      • Increase/expand an EXT4 filesystem in RHEL 6 / CentOS 6
      • Increase/expand an XFS filesystem in RHEL 7 / CentOS 7
      • License
      • Performance Monitoring
    • Speech Analytics
      • How it works - Speech Analytics
      • Set up Google Cloud Speech API
      • Create Google Cloud Storage bucket
      • MiaRec configuration
    • MiaRec Architecture
    • Screen Recording
      • How it works
      • Configure licensing
      • Configure storage
      • Configure screen recording settings
      • Generate secure token
        • A single-tenant configuration - generate token
        • A multi-tenant configuration - generate token
      • Install client application
      • Authorize new workstations
      • Configure users for screen recording
      • Verify screen recording
      • Troubleshooting
        • Troubleshooting on client side
        • Troubleshooting on server side
      • Deploy Screen Capture Client with Windows Group Policy
        • Create a Transform (MST) file
        • Put the MSI and MST files in a file share
        • Create a new GPO
    • Security
      • PCI scanners and false positives
      • Security hardening for Apache web server
    • High availability
      • Overview
      • High availability for BroadWorks SIPREC recording
      • High availability for Cisco Built-in-bridge recording
Home › Administration Guide › Phone system integration › Metaswitch call recording ›
 

Softkey integration with Polycom VVX (Metaswitch platform)

MiaRec integrates with Polycom VVX series phones to provide on-demand and pause/resume recording control via softkey.

Supported models:

  • Polycom VVX 300, 400, 500, 600, 1500 Series

How it works

A phone loads a custom Endpoint Pack Extension from Metaswitch SIP Provisioning Server.

MiaRec Phone Services

During an active call call, a custom labeled softkey is shown on phone's screen. The following screenshot shows "MiaRec" softkey. it is possible to change the key's name.

MiaRec Phone Service on Polycom VVX phone

When user presses this key, an XML application is loaded by phone from the MiaRec recording server. User will see "Record/No Record" and/or "Pause/Resume" buttons, depending on the configured permissions.

MiaRec Phone Service on Polycom VVX phone

Configuration guide

Step 1. Download MiaRec's Endpoint Pack Extension (EPE)

Download one of the following extensions that matches to a version of your existing Endpoint Pack (EP) for Polycom VVX phones:

  • MiaRec EPE for Polycom EP v.44
  • MiaRec EPE for Polycom EP v.45
  • MiaRec EPE for Polycom EP v.47

Note 1: If your Polycom Endpoint Pack version is not listed here, then you can follow the procedure in Amending the Base Version of a Pack Extension article in Metaswitch Community site, or contact MiaRec Support for assistance.

Note 2: If you already have another pack extension in your system, then you need to merge multiple extensions into one. Follow the procedure in Concatenating more than one Pack Extension article on Metaswitch Community site, or contact MiaRec Support for assistance.

Step 2. Install MiaRec's Endpoint Pack Extension into Metaswitch SIP provisioning server

Follow the procedure in Deploying a Pack Extension for an Endpoint Pack on SIP Provisioning Server chapter of MetaView SIP Provisioning Server Guide.

Step 3. Use the CommPortal Phone Configurator to enable MiaRec's softkey integration

Use MetaView Web to log on to the CommPortal Phone Configurator at the required level of your phone profile hierarchy:

  • Persistent Profile (if the app should be enabled/disabled for all your SIP phones)

  • Business Group or Department (to enable it for all SIP phones within a particular Business Group or Department).

Open Programmable Keys - Bottom section and assign MiaRec recording button to one of line keys (Key 1 is a good choice).

  • Select MiaRec Record Button in the Soft key action. If you do not see this option, then the Endpoint Pack Extension is not installed properly

  • Enter your MiaRec web portal address under MiaRec Server Address, like https://recorder.example.com. Use https:// (encrypted connection) and domain address (do not use IP-address because SSL certificate validation will fail). The MiaRec web server requires a valid SSL certificate (read below).

  • Choose a name for the soft key

MiaRec Phone Services

A valid SSL certificate is required for the MiaRec web portal. Follow the procedure in Enable HTTPS for MiaRec Web portal to configure SSL certificate.

Note, Polycom phones do not support wildcard SSL certificates, i.e. if your MiaRec web server uses SSL certificate for domain *.example.com, then XML application will fail to load to Polycom phone with error "SSL/TLS handshake failed". To resolve this issue, use a single-domain SSL certificate for a MiaRec web portal, for example, you can use free SSL certificate from Let's Encrypt.

Step 4. Configure MiaRec application

  1. Follow the procedure in User authentication using Metaswitch CommPortal to activate the authentication of users with CommPortal

  2. Navigate in the MiaRec web portal to Administration -> System -> Phone services. Click Edit configuration for the tenant. Make sure the phone services are enabled for this tenant and Authentication option is set to Authenticate users using the web access password

  3. Navigate in the MiaRec web portal to Administration -> User management -> Tenants -> [select tenant] -> Roles. For subscriber roles, make sure the following permissions are granted:

    • Allow for resource Phone services
    • View for resource Own call recordings
    • [optional] Trigger on-demand for resource Own call recordings. This permission is required only if subscribers need to control recording on-demand
    • [optional] Pause recording for resource Own call recordings. This permissions is required only if subscribers need to pause recording during a call (for example, for PCI compliance)
  4. Navigate in the MiaRec web portal to Administration -> User management -> Tenants -> [select tenant] -> Users. For subscribers, make sure the following settings are configured:

    • Login attribute is set to the same username as used for CommPortal authentication
    • Allow web access is enabled
    • Authenticate with is set to Metaswitch CommPortal
    • [optional] Record is set to On-demand (you can optionally choose between Keep recording and Discard recording depending on your preferences). This option is required only if subscribers need to control recording on-demand

Step 5. Verification

  1. Reboot the phone. The phone should load new configuration from SIP PS
  2. Make a test call
  3. Verify in MiaRec web portal if this call is being recorded
  4. Verify in MiaRec web portal if this call is associated with correct user profile. See Associating calls with user
  5. While call is still in progress, verify if the configured soft key is displayed on phone's screen
  6. Press the soft key and test Record/No record and Pause/Resume buttons (note, these buttons may be hidden if subscriber doesn't have appropriate permissions to control on-demand or pause recording)

Troubleshooting

Check System Log in MiaRec

Navigate in MiaRec web portal to Administration -> Maintenance -> System Log and check if there are any warnings/errors.

Use your web browser to simulate the hardware phone

Open in your web browser the same link as you configured in the Polycom configuration file, for example:

https://[YOUR-MIAREC-SERVER]/api/phone_services/polycom/calls/active_call?login=123456

You should be able to login to phone services and see the recording controls.

MiaRec Phone Services

Check Polycom phone logs

By default Polycom phone automatically uploads own log file to the provisioning system using FTP. Check that log file for any errors.

‹ Configure SIPREC auto-failover for a direct CFS-MiaRec connection up User authentication using Metaswitch CommPortal ›
  • Printer-friendly version
MiaRec, Inc. © 2020. All Rights Reserved. | Terms of Use | Privacy Statement | Cancellation Policy