Reference13r2:Concept App Service Recordings

From innovaphone-wiki

Jump to: navigation, search
There are other versions of this article: Reference13r1 | Reference13r2 (this version)

Contents

Description

Recordings is an application running on the App platform which allows to capture the audio streams during a telephone call. The users phone can be configured to send bi-directional audio streams to the Recordings App and store them into the database.

Applies To

  • innovaphone PBX from version 13r2

Requirements

  • innovaphone PBX
  • innovaphone Application Platform
  • Firmware V13r2xx
  • Recordings App
  • Recordings App licenses
  • Device with PCAP Recording Interface:
    • innovaphone deskphones (not V13-SoftphoneApp)
    • innovaphone gateway interfaces

Apps

recordings

Image: Usrrecord.png

User version of the App allow you to:

  • Access to the user specific records
  • Access to the user specific logs
  • Filter records by name, by date
  • Play, Listen or Download the recording as a .WAV file
  • Protect against deleting or delete a recording

recordingsadmin

Image:Adminrecord.png

Admin version of the app allow you to:

  • Access to all records
  • Access to all logs
  • Set up the records auto deletion retention time in days
  • Set the PBX name
  • Set specific trace levels
  • Filter records by name, by date
  • Play, Listen or Download the recording as a .wav file
  • Protect against deleting or delete a recording

PBX Manager Plugin

With the Recordings PBX Manager Plugin an App Object can be created, edited and deleted on the PBX.


Configuration

  • Download the Recordings App via App Store.
  • Install the App on the App Platform Manager.
  • Create a instance for the Recordings App on the App Platform Manager.
  • Create a new PBX recordings APP-Object with the PBX Manager Plugin.
  • Create a new PBX recordingsadmin APP-Object with the PBX Manager Plugin.
  • Assign recordingsadmin App to authorized (admin) users, which will be allowed to open the Admin UI of the Recordings App.
  • Assign recordings App to users who will use the Recordings App.
  • Start recordingsadmin App and configure the name of the PBX in the settings via upright option
  • assign Record to (URL) to recording devices/objects in format
http://ap.domain.tld/domain.tld/recordings/Files
at deskphones or gateway interfaces.
At innovaphone deskphones, enable recording via Phone/User-X/Recording by setting Mode to transparent and Recorder to HTTP Server.

Access List

Unlike Recordings Admin App, which lists recordings of all users, Recordings App for users limits the listing of recordings to those made by the using user himself.

A possibility to extend the listing of the recordings to other extensions/users is provided by the Access List. In the Access List additional extension can be defined, which will be listed to the Users of the App. This way the Recordings App Service can be accessed via different App Objects, with different Access Lists.

This way scenarios, like sharing recordings between a team members or supervisor access to recordings of call agents are possible.
For the configuration see : Howto:V13r2 Recordings App configuration#Access_list_configuration_through_the_Recordings_Plugin

Scheduled deletion of old recordings

You can configure a time period between 1 and 11000 days (in maximum round about 30 years), after which recordings are automatically removed. You can enter 0 days here to disable the scheduled deletion

Licensing

An appropriate license App(innovaphone-recorder) must be installed on the PBX to enable Recordings App functionality for specified users.

The Recorder App License can be assigned directly to a specific User Object or via a Config Template.

The recordings for users without an assigned Recorder App License will be unrecoverably deleted if the Recordings App is restarted.

Recording on Special Interfaces

  • Trunk Interface

The Trunk Interface acts as a substitute for the users phone. For outgoing calls the call initiator is the owner of the recording and for him a license is required. With incoming calls, the first user answering the call own the recording and a license for this user is required.

  • Waiting Queue

The user answering the call is owner, a license for this user is required.

Upgrade from V13r1 to V13r2 Recordings App

Compatibility

A V13r1 Recordings App can be used in the V13r2 PBX and App Platform environment.

License Changes

With V13r2 required License Type for the Recordings App changes from a Service License (Service(innovaphone-recordings)) to an App License (App(innovaphone-recorder)). Existing Service Licenses are extended by the same number of App Licenses when the licenses are downloaded from my.innovaphone.com.

Customers with the previous innovaphone Recording 2014 solution, which are equipped with SSA, should contact the innovaphone licenses department prior to the physical upgrade on customers' location on time, to receive an adjustment in the licenses.

Make sure to reboot the pbx and the app platform after changing the licenses from Service(innovaphone-recordings) to App(innovaphone-recorder).

Recording-Object Accessrights

Make sure that the function "websocket" and the checkmark "Admin" in the section Grant access to APIs is activated in the recording object.

Database Conversion

On first start after update from V13r1 to V13r2 Recordings App, the App Service will start a database conversion procedure. Depending on the number of recordings in the database, time for conversion my take up to 30 minutes for a database with 100000 recordings.

!!! It is recommended to export the Recordings App database for backup purposes, prior updating the App. !!!

Troubleshooting

Recordings App Service

The App Service for Recordings App provides a log output on the App instance, after the Diagnostics option "App" is activated for the selected instance.

Additional Trace Level Options for the App Service are configurable via Recordings Admin App. This settings are available via additional Menu in the upper right corner of the Recordings Admin UI:

  • Recording - PCAP interface related traces, useful on issues with IP-Phone and Interface Media transmission from Endpoint to the App Service
  • Call Information - traces related to the CDR information
  • Converting - traces for conversion process from VoIP codecs to WAV
  • License - traces for on licensing issues
  • UI - traces related to the user interface of the Recordings App

The name of the Master PBX must be configured via the Recordings Admin App, otherwise a message PBX Name missing will be displayed.

PBX Configuration

  • WebSocket connection from App Object to the recordings app should show connected
  • A correct configuration of the CDR interface is required for transmission of metadata to the recordings service. In case this transmission is not successful, a recording will show a NoCDR message, instead of username

PCAP Recording Interfaces

  • Check URL for PCAP Recording provided on the IP-Phone or VoIP-Interface of a VoIP Gateway
  • A Trace with enabled HTTP-Client option should show a successful HTTP PUT Request towards URL of the Recordings Service PCAP interface (e.g. HTTPCLIENT WEBDAV_FILE_HTTP.2: PUT http://ap.company.com/company.com/recordings/Files/f9e5956e47d460010630009033302ab1-009033302ab1-11--username.pcap)

Related Articles

Known Problems

Test Mode

The App Licenses are not supported in the Test Mode at the moment, instead a Test License should be used.

Personal tools