Howto13r2:RecordingsApp: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
Line 31: Line 31:
[[Image:Recordings-howto4 1.png]]
[[Image:Recordings-howto4 1.png]]


=Setting up Devices=
=Setting up the Devices Plugin=
==Configuring the PBX==
==Part 1 - Configuring the PBX==
===CDR===
===Part 1.1 - CDR Checkbox===
*To fully function, you need to activate the CDR option in the PBX.
**To do that, you need to select the '''PBX - Config''' tab
***Here you need to check the '''"Generate CDRs"''' checkbox.


[[Image:Recordings-howto14.png]]
[[Image:Recordings-howto5 1.png]]


Here you need to configure your PBX and your phones. We're going to start with the PBX.
===Part 1.2 - Configuring CDR===
*In this step you are going to setup the CDR tab in the PBX
**Those settings you can find under '''Gateway - CDR1'''.
***The following settings need to be made:
****''Type:'' HTTP
****''Adress:'' here you need to either set the IP Adress of your application platform, or the name of it which is resolved from your DNS Server.
****''Method:'' External (POST)
****''Path:'' Here you need to put a case-sensitive URL: '''"/domain/recordings/cdr"'''.


After selecting your PBX on the Devices-tab, you need to navigate to the PBX tab. Under general, you need to activate '''"Generate CDRs"'''.
[[Image:Recordings-howto6-1.png]]


[[Image:Recordings-howto15.png]]
===Part 1.3 - Checking the object===
*It could happen that '''Websocket''' and '''Admin''' isn't ticked in '''"Objects"'''.
**To check this, you need to navigate to '''PBX - Objects'''
**Here you select the '''Recordings''' object and select the first '''App''' tab.
**Both checkboxes should be ticked.


After that, the CDR need to get configured. For this you're going to select the '''"Gateway"''' tab, and the subtab '''"CDR1"'''.
[[Image:Recordings-howto7-1.png]]


The following configuration is needed:
==Part 2 - Configuring the Phones==
===Part 2.1 - Setting up the URL===
*To actually record the calls, the phones need to be set up correctly.
**Select a phone and go to the '''"Phone"''' tab.
**Down below, you again need to put a case-sensitive URL into the field, which follows the following rule:
***'''http://app-platform/domain/recordings/Files'''


''Type:'' HTTP
[[Image:Recordings-howto8-1.png]]
''Adress:'' here you need to either set the IP Adress of your application platform, or the name of it which is resolved from your DNS Server.
''Method:'' External (POST)
''Path:'' Now you need the mentioned case-sensitive URL which looks like: '''"/domain/recordings/cdr"'''. If you are not careful, the app is not going to work.


[[Image:Recordings-howto16.png]]
===Part 2.2 - Setting up the Recording-Tab===
===Checking the object===
*To fully function, the following changes need to be made in the '''Recording-Tab'''
 
**''Mode:'' Transparent: This means that the call will be recorded instantly.
Also, it could happen that '''Websocket''' isn't ticked in '''"Objects"'''.
**''Recorder:'' HTTP Server
 
You need to navigate to the '''"PBX"''' tab and the subtab '''"Objects"'''.
Click on the '''"Recordings"''' object to configure it.
Check the first '''"App"''' tab if '''"Websocket"''' is activated. If not, activate it.
 
[[Image:Recordings-howto16 Websocket.png]]
 
==Configuring the Phones==
 
After that, you need to configure the phones. For this, select a phone and go to the '''"Phone"''' tab.
 
Way down below, you can spot the URL field which needs to be the following: '''http://app-platform/domain/recordings/Files'''
 
[[Image:Recordings-howto18.png]]
 
You also need to setup the '''"Recording"''' tab which is found on the left.
 
''Mode:'' Transparent: This means that the call will be recorded instantly.
''Recorder:'' HTTP Server


[[Image:Recordings-howto19.png]]
[[Image:Recordings-howto19.png]]

Revision as of 13:20, 30 September 2021

Setting up the Instance

  • In this Step you're going to Setup the Instance of the Recordings App
    • For this you need to download the app in the AP Manager Plugin.
    • After installing the latest version, you need to add a new instance.
    • You need to fill all the important information in the newly opened window.
    • After setting up the instance and starting it, it should look like the following:

Recordings-howto1 1.png

Configuration in the PBX Manager Plugin

Part 1 - Adding objects through the Recordings AP

  • First you're going to add 2 new objects for the Recordings App to function.
    • Here you need to add one object for "User" and one for "Admin".
    • You have three fields to fill out.
      • Name: Here youre going to name the App
      • SIP: Here you need to name the SIP
      • TYPE: Here you can choose what type this object is going to have.

Recordings-howto3 1.png

At the end, it should look like this:

Recordings-howto2 1.png

Part 2 - Configuring Templates

  • For the app to work, you need to give out permissions and licences for the templates.
    • Select the user template and give him the app permission and the licence.
    • Select the admin template and give him the admin-app permission and also the licence.
    • Now users with either template can use the appropiate apps.

Recordings-howto4 1.png

Setting up the Devices Plugin

Part 1 - Configuring the PBX

Part 1.1 - CDR Checkbox

  • To fully function, you need to activate the CDR option in the PBX.
    • To do that, you need to select the PBX - Config tab
      • Here you need to check the "Generate CDRs" checkbox.

Recordings-howto5 1.png

Part 1.2 - Configuring CDR

  • In this step you are going to setup the CDR tab in the PBX
    • Those settings you can find under Gateway - CDR1.
      • The following settings need to be made:
        • Type: HTTP
        • Adress: here you need to either set the IP Adress of your application platform, or the name of it which is resolved from your DNS Server.
        • Method: External (POST)
        • Path: Here you need to put a case-sensitive URL: "/domain/recordings/cdr".

Recordings-howto6-1.png

Part 1.3 - Checking the object

  • It could happen that Websocket and Admin isn't ticked in "Objects".
    • To check this, you need to navigate to PBX - Objects
    • Here you select the Recordings object and select the first App tab.
    • Both checkboxes should be ticked.

Recordings-howto7-1.png

Part 2 - Configuring the Phones

Part 2.1 - Setting up the URL

  • To actually record the calls, the phones need to be set up correctly.

Recordings-howto8-1.png

Part 2.2 - Setting up the Recording-Tab

  • To fully function, the following changes need to be made in the Recording-Tab
    • Mode: Transparent: This means that the call will be recorded instantly.
    • Recorder: HTTP Server

Recordings-howto19.png

Configuring the App

Now you can put the "Recordings" and the "RecordingsAdmin" App to your home screen from the appstore on the bottom right.

You need to open the admin-app so you can configure it.

After opening it, you see that you get a message which says that no PBX name is configured which you need to set.

On the upper right is a menu button. After pressing it, a sidemenu will open. Down below you see the option "PBX name". Here you set the name you gave the PBX.

Recordings-howto20.png

After that, the configuration is done and you can freely use the app.