Recordings Access Accounts

Configure S3 Browser to access call recordings from your CommPeak Cloud PBX or Dialer instance or connect using the AWS CLI V2, configure access rules, and view access log in CommPeak Portal.

You can create accounts for your Cloud PBX or Dialer to access files with call recordings via the S3 protocol.

👍

TIP

We recommend using the S3 protocol to access the Cloud PBX or Dialer bucket and download the call recording files.

Creating Access Accounts

To create an access account:

  1. In the CommPeak Portal, expand Dialer and click Dialer Instances. Alternatively, expand Cloud PBX and click PBX Instances.

  2. Click the Recording Access Accounts button in the controls on the right of the PBX or Dialer instance:

    Screenshot of the Recording Access Accounts button

    Recording Access Accounts button

  3. In the Recording Access Accounts sidebar that opens click the plus icon.

    Screenshot of the Recording Access Accounts sidebar

    Recording Access Accounts sidebar

  4. Choose S3 or FTP protocol and access type:​

    • View Only to allow downloading recording files or​

    • View and write to enable downloading and deleting the files.

      Screenshot of creating an account for accessing recordings

      Creating an account for accessing recordings

  5. Click CREATE ACCOUNT.

  6. A message box with a new S3 token and secret or FTP account credentials will appear on the screen.

❗️

IMPORTANT

Before closing the message box, make sure to copy the FTP password or S3 secret because it will not be shown again.

You will be able to reset your FTP account password later. Resetting the S3 secret is not possible.

The new account appears in the sidebar:

Screenshot of the sidebar with accounts for accessing recordings

The sidebar with accounts for accessing recordings

To remove an account, click the delete icon. This action is irreversible!

Connecting Using the S3 Browser

📘

NOTE

Ensure that the public IP address of your remote server or PC is whitelisted in the Access Control List.

  1. Once you've downloaded and installed the S3 browser, go to Accounts > Add new account at the top left. Fill in the following information:
  • Display name (alias only): enter your PBX or Dialer name

  • Account type: select S3 Comptabile Storage

  • REST Endpoint: enter recordings.commpeak.com

  • Access Key ID: enter your S3 account token

  • Secret Access Key: enter the secret key you copied while creating your S3 account

  • ensure that you select the Use secure transfer (SSL/TLS) checkbox

    Screenshot of adding an account in S3

    Adding an account in S3

  1. Click Add new account.

  2. In the advanced settings of your S3 browser, select the following options:

  • Singature version: Singature V2 or Siganture V4

  • Addressing model: Path style

    Screenshot of the advanced S3 storage settings

    Advanced S3 storage settings

👍

TIP

If your recordings bucket contains a large number of files or directories, consider using the Pagination feature. This allows you to divide large bucket listings into manageable pages.

Please refer to the S3 Browser page about bucket pagination.

Configuration Example Using AWS CLI V2

Those who prefer command-line tools can use the AWS Command Line Interface (AWS CLI), a unified tool to manage AWS services. It allows you to control multiple AWS services and automate them through scripts.

Download link: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html

Please run the following commands to connect to your recordings storage via AWS CLI V2:

  1. To begin, open your computer's command line interface (CLI). This can typically be found by searching for "command prompt" or "terminal" in the search bar.
  2. Enter the following command:
    $ aws configure --profile "your PBX or Dialer name"
    
    This will create a new profile for your PBX or Dialer in AWS CLI V2.
  3. Next, you will be prompted to enter your AWS Access Key ID (your S3 account token) and Secret Access Key (your S3 account secret). These can be found in your S3 account settings. Enter them when prompted.
  4. You will also be asked for your Default region name and Default output format. Please feel free to leave these blank for now.
  5. Now that you have configured your new profile, you can use it to connect to your recordings storage. Enter the following command:
    $ aws s3 ls s3:// --endpoint-url https://recordings.commpeak.com/ --profile "your PBX or Dialer name"
    

This will list the bucket name for your recordings storage. Please note that the bucket name will be a long string of numbers and letters, such as

a123465-7891-4234-9c5c-9a1231322ea

To sync your recording files to your local directory, use the following command:

aws s3 sync s3://bucket_name/recordings/ /home/local_directory/ --endpoint-url https://recordings.commpeak.com --profile "your PBX or Dialer name" --page-size 100

This will sync all of your recording files with the specified local directory.

Example:

aws s3 sync s3://a123465-7891-4234-9c5c-9a1231322ea/recordings/2024/10/01/14/ /home/root/ --endpoint-url https://recordings.commpeak.com --profile "mypbx" --page-size 100

📘

NOTE

Please replace "your PBX or Dialer name" with the real name and your bucket name with the one you obtained in the previous step.

If you encounter any issues or need more information about AWS CLI V2 commands, you can use the --debug flag in your commands to view a full debug report. You can also refer to the AWS CLI V2 documentation for more detailed explanations and examples.

Storage Directory Structure

  • _/{year}/{month}/{day}/{hour}/"audio file with outgoing or incoming call recording.flac"

Example:

/2023/11/11/02/out-441632960770-101-20211111-125343-1636635223.0.flac
/2023/11/11/02/out-3655759816-394-20211111-142929-1636640969.74.flac
/2023/06/07/13/in-16135550146-611900654321-20210607-085238-1623055958.18.flac
/2023/06/10/13/in-16135550146-559552757804-20210610-090143-1623315703.97.flac

Access Control List

To access your storage, you must configure access rules for your FTP and S3 accounts.

To set IP ACL:

  1. Go to the IP ACL tab in the Recordings Access Accounts sidebar.

  2. Enter an IP address with a subnet mask for an account.

  3. Click the plus icon.

  4. Repeat the steps to add more IPs.

    Screenshot of the ACL rule settings for accessing the recordings' storage

    ACL rule settings for accessing the recordings' storage

If the CommPeak system blocks your FTP username for violating the maximum concurrent connections, you can unblock it in Current Blocks.

Screenshot of the ACL rule settings with current blocks

ACL rule settings with current blocks

Access Log

You can view a summary for the selected date range or download a log file with more detailed information.

To view access details:

  1. Go to the Access Summary tab in the Recordings Access Accounts sidebar.

    Screenshot of viewing the access summary

    Viewing the access summary

  2. Select a date range in the interactive calendar or use presets.

  3. Click Search.

  4. You will see how many files were opened or deleted and the amount of uploaded and downloaded data during the selected period.

  5. Click the download icon to save a .csv file with the access log. The log contains more details, such as IP address, exact time, action, downloaded file path, and errors, if any.