External Storage Support


Overview


AmplifyReach supports external storage to store uploaded files on a third-party storage system like Amazon-S3. External support feature can be enabled/disabled seamlessly in Agent Terminal.

External Storage Configuration


External storage option is accessible from Setting -> Conversation Configuration -> under Files section

Clicking on “External upload configuration -> AWS-S3” tab will present below the screen

  • AWS Access Key & AWS Secret Key: To access your Amazon-S3 (AWS-S3) account automatically, the Access Key and the Secret Key are required. The Access Key and the Secret Key are not your standard username and password but are special tokens that allow our services to communicate with your AWS account by making secure REST or Query API requests to the AWS service API.

    Tip: Information on creating Access Key and Secret Key can be found on below page, https://aws.amazon.com/premiumsupport/knowledge-center/create-access-key/

  • Bucket Name: A valid AWS-S3 bucket name has to provided here. A bucket is a logical unit of storage in Amazon Web Services (AWS) object storage service S3. Buckets are used to store objects, which consist of data and metadata that describes the data.

    Tip: To create a bucket, you can use below link for reference: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html

  • Folder Name: As AWS has a Flat file structure, Folder helps in grouping objects in AWS bucket. AmplifyReach creates a new Folder per Chat using Chat ID as folder name, and all documents belonging to a Chat are stored under that folder.
  • Disable AWS S3 File Store: External storage can be enabled/disabled by a single click. Selecting “Disable AWS S3 File Store” disables external storage and can be enabled back again by deselecting it.
  • Upload File Size Configuration: Maximum File Upload Size and Allowed File Extensions can be easily configured from Setting -> Conversation configuration -> File upload Configuration

Callback URL


CallBack allows Customer to receive real-time HTTP notifications of file upload in the AmplifyReach Chatbot. For example, AmplifyReach could send Customer a notification, when either end user or Live Chat agent has upload/sent file in the chat conversation.

The customer can define their own callback URL (as defined in below table). AmplifyReach shall call URL to forward document with metadata information. Customer will able to configure the Callback URL in LiveChat Admin.

Clicking on “External upload configuration -> Callback” tab will present below the screen.

POST ABSOLUTE PATH TO CUSTOMER HOSTED CALLBACK URI


POST ABSOLUTE PATH TO CUSTOMER HOSTED CALLBACK URI
POST Request Payload: Multipart file upload request
chatID CHAT_ID
file FILE_LOCATION_PATH

The successful response as follow:

{
    "url": "<SAMPLE_URL>",
    "uid": "<UNIQIE ID OF FILE>",
    "status": 0
}

The failure response as follow:

{
    "message": "<FAILURE MESSAGE OR ERROR>",
    "status": 1
}