AWS S3

Figure 1: The AWS S3 module.

IMPORTANT: This is an advanced module. Some setup is required before use.

Function

This module uses the supported third-party service AWS S3. The module allows you to integrate an S3 bucket into your application to upload audio recorded during a call.

You can select and use any S3 integration that has been added to your Fuse account.

NOTE: Integrations are shared with all users in a Fuse account. You can always check existing integrations by going to the My Account page and viewing the Integrations tab.

For recording call audio only

The AWS S3 module is designed to work alongside the Record and Call Recording modules. It can only handle the call recordings generated by those two modules. The AWS S3 module will not work for any other type of object storage.

Audio file format

Call recordings are uploaded in different formats depending on the source module:

Module	Output format
Record	.wav
Call Recording	.ulaw

Prerequisites

To use this module, you must have an account with AWS (Amazon Web Services). You must also have a working Amazon S3 bucket added as an integration to your Fuse account.

Complete the following in order:

In AWS:

1. Get an AWS account. (Website)

2. Set up a working bucket with Amazon S3. (AWS documentation)

3. Set up an IAM user with access keys and an IAM policy for S3. (Guide)

In Fuse:

1. Admin-only task: Add your S3 bucket as an integration in the My Account page.

Once finished, the AWS S3 module can be used successfully.

Input Fields

Figure 2: AWS S3 module fields.

As shown in Figure 2, the following fields are available. Completing an active field enables the next:

• Select Bucket: Select one of your AWS S3 integrations.

• Select Path: Select the path in your S3 bucket where your recording will be uploaded.

• Select Recording: Select the name of the recording module that will generate the recording to be uploaded.

• File Name: Enter a filename for the recording as a string or variable.

  • Note: A timestamp will also be automatically appended to each filename before uploading.

  • Uploaded recordings will have the following, final syntax: [filename]-[timestamp]

Module Settings

Figure 3: Module settings for AWS S3.

Hold Music

Enable this setting to play audio while an end-user is on hold. To upload a file for hold music, go to Application Settings > Connection Settings > Webservices > Webservice fetch audio.

Timeout Length

This allows users to set the maximum time, in seconds, that elapse before returning a timeout error. This applies to modules that fetch outside scripts, like the SOAP, REST, or subdialog modules. The default value for Timeout Length is 30 seconds. Acceptable number values range from 1 to 120.

Private

This setting controls the logging function of a module. Enabling the 'Private' setting instructs the module to not record, report, or retain the information input to that module for reporting or any other purposes. When enabled any information entered into a module during a call will be lost immediately when the call terminates. The 'Private' setting is critical for businesses that need to maintain PCI-DSS or HIPAA compliance. The module icon, in the upper left-hand corner, becomes grayed-out when this setting is enabled. See more details here.

Show Custom Errors

Enabling this setting overrides the default, global error options set in the Application Settings > User Input Settings. This allows users to establish custom error handling in order to act on errors in a specific way in that module. Instead of progressing to the next module in the call-flow, custom error handling allows users to re-prompt the same module, to provide a custom error message, to re-direct the call based on the error, or any other desired behavior. Adding multiple errors () to a module functions behave the same way as a counter. The first error follows the path for the first error listed, if a second error occurs in the same module it follows the second listed error, and so on until all errors are exhausted or an error directs the end-user away from that module. No Input occurs when the caller does not provide an input based on the timeout settings. This is based on the “Initial input timeout” in User Input Settings. No Match occurs when the caller input does not match the module's criteria for the input module.