📞 PBX System
📚 Archive
☁️ Archive Files to Amazon S3

☁️ Archive Files to Amazon S3

IZT Cloud Voice supports archiving the system's call recordings and backup files to Amazon S3 on a regular interval or any given time you want. This topic describes how to add an Amazon S3 bucket as an archive server and schedule tasks to archive the desired files.

Requirements and Restrictions

Requirements

  • PBX Firmware: Version 84.15.0.2 or later
  • PBX Plan: Ultimate Plan

Restrictions

  • Archive Server: 10
  • Archive Task: 200

Introduction

To enable archiving of call recordings and backup files to a specific bucket in Amazon S3, you need to complete the following steps:

  1. Prepare an eligible Amazon S3 account and create buckets.
  2. Use IAM to create users with access permissions.
  3. Configure the Amazon S3 bucket as an archive server on the PBX.
  4. Create and schedule archive tasks to automatically transfer files from the PBX to Amazon S3.

Step 1: Create an IAM User with Full Access to Amazon S3 Bucket on AWS

  1. Log in to AWS Management Console.
  2. Navigate to IAM Service and click Users.
  3. Click Add User.
Add IAM User
  1. On the Specify user details page, enter a name in the User name field to help you identify the IAM user. Then click Next.
Specify IAM Username
  1. On the Set permissions page, grant the user full access to Amazon S3 buckets, then click Next.
Grant S3 Access
  1. On the Review and create user page, click Create user.
IAM User Created Success
  1. The IAM user with full access to Amazon S3 bucket is created and displayed on the users list.
Click Created IAM User
  1. Create an access key for the IAM user:
  • On the IAM users list, click the newly created IAM user to enter its details page.
IAM User Create Access Key
  • In the Security credentials tab, click Create access key.
  • On the Access key best practices & alternatives page, select Third-party service and confirm your operation, then click Next.
IAM Third Party Service Permission
  • On the Set description tag page, enter a description for the access key as needed, then click Create access key.
IAM Create Access Key
  1. Copy the generated Access Key ID and Secret Access Key to add to your PBX server:
Download Access Key File

Step 2: Create an Amazon S3 Bucket on AWS

  1. In the AWS Management Console, search S3 in the top-left search bar, then choose S3.
Search S3 Service
  1. At the top-right corner, select the region in which you want to create an S3 bucket.
  2. Click Create bucket.
Amazon Select Bucket Button
  1. On the Create bucket page, enter a name for the bucket to help you identify it. Configure other settings based on your needs:
Create S3 Bucket
Bucket SettingDescription
Bucket NameEnter a name to help you identify the bucket.
RegionCheck the region where the bucket will be created.
Additional SettingsConfigure settings according to your needs.
  1. Click Create bucket.
S3 Bucket Created Success

🔔 Note: If you want to group the archived PBX files in Amazon S3, you can create folders in the bucket. This way, you can specify PBX files to be archived to the designated folders in the following settings.

Step 3: Add Amazon S3 Bucket as Archive Server on PBX

  1. Log in to the PBX web portal, go to System > Archive.
  2. Under the Archive Task tab, click Archive Server.
Click Archive Server
  1. Click Add.
  2. In the pop-up window, complete the following settings:
Add S3 as Archive Server
SettingDescription
NameEnter a name to help you identify the server.
Server TypeSelect Amazon S3.
Access Key IDEnter the Access Key ID generated from the AWS.
Secret Access KeyEnter the Secret Access Key generated from AWS.
Bucket NameEnter the name of your created S3 bucket.
  1. Click Save.

Step 4: Create a Task to Archive Files to Amazon S3 on PBX

  1. Under the Archive Task tab, click Add Task.
  2. Create a one-time or recurring archive task:
Create S3 Archive Task
SettingDescription
NameEnter a name to help you identify the task.
File TypeSelect Recording Files & Backup Files as needed.
TimeSpecify a date and time for this task.
Sync FrequencyChoose between Once, Daily, or Weekly and set the respective frequency and timescales where appropriate.
Archive ServerSelect the Amazon S3 server that you have added.
Select Folder/PathSpecify the bucket or folder in which you want to store archived files. The system automatically adds the folder in the bucket based on the task.
  1. Click Save.

Result

The specified files will be archived to the designated bucket or folder in Amazon S3 immediately or at the scheduled time.

  • Scheduled Execution: The system executes only one task at a time to avoid affecting system performance. If there are multiple tasks, they will be queued up one after another.
  • Archive Result: You can check the archive result on PBX or directly on Amazon S3:

🔍 Note: If the task is failed, the Failed to Archive File(s) event will be triggered. You can click Retry to retry the task.

Check the Archive Result on PBX

  1. Go to PBX web portal > Archive > Archival Logs.
  2. If the Result column for the task shows Succeeded, it indicates that the archive was successful.
S3 Archival Logs

Check the Archive Result on AWS

  1. On the AWS Management Console, go to the created S3 bucket.
  2. If the specified files appear in the bucket, it indicates that the archive is successful.
Backup File on AWS