How Can We Help?

How to integrate with a Voxjar hosted FTP server

Voxjar can connect with your existing FTP servers to download call recordings and metadata for quality assurance.

The connection allows Voxjar to download call recordings and metadata from your server on a schedule or when manually triggered.

You can create multiple FTP server connections by creating multiple integrations.

To create a new FTP integration, go to Settings>Integrations (app.voxjar.com/settings/integrations) and click on SFTP.

voxjar sftp integration

Formatting Your FTP Data

voxjar sftp server call recording metadata options

First, make sure you select the "Send to Voxjar's FTP" tab on the popup modal.

Since you'll be sending data to Voxjar, you will receive credentials to access your private Voxjar FTP once the integration is created.

Enter a nickname for this integration so you can recognize it later and select the format of the metadata you'll be using.

If you don't have metadata to connect to your calls, select "Audio  files only"

Then you will need to upload a sample of your selected file type so Voxjar is able to parse it correctly on upload.

Metadata Sources

Metadata lets Voxjar label your call recordings with standard and custom fields. This is useful for filtering results, identifying specific calls, linking calls to agents, and selecting which call recordings should be evaluated.

There are three options when you send data to a Voxjar FTP server:

  1. Parse metadata from the audio file name eg. call-id_agent-id_timestamp.wav
  2. Extract metadata from a single CSV file that includes the call recordings' file names
  3. Extract metadata from JSON files (1 per audio file) that includes the call recordings' file names
  4. Extract metadata from a single CSV file that includes a public download url to the call recording (no audio files sent to the server)
  5. Extract metadata from JSON files (1 per audio file) that includes a public download url to the call recording (no audio files sent to the server)

After your data is downloaded and processed by Voxjar it will be deleted from the FTP server. 

Parse Audio File Name Metadata

Parsing metadata from your call recording file names is the simplest way to start if you don't have detailed metadata files.

Voxjar will extract metadata from your file names based on rules you set in the next step.

audio file metadata ftp integration

CSV Metadata File

upload sample csv file for metadata parsing from Voxjar's ftp server

If you save your metadata in a CSV file you can send that data to Voxjar's FTP server.

Only 1 CSV file will be downloaded on every data collection run. That means that if you schedule data to be pulled every 7 days, all metadata for that 7 day period needs to be stored in a single CSV file.

Each row in a CSV metadata file should represent 1 call.

Voxjar will only download calls that are included in your CSV file and that match the rules you set in your Queues.

Your CSV file must contain a column that references the call recording's file name (if you are also sending audio files to the FTP server) or a public download url for the audio so Voxjar can link the data to the call. You do not need to provide the full call recording path in the CSV file since you have already provided that. Just the file name or url.

During set up, you will need to provide a sample CSV file so you can map your columns to metadata fields in Voxjar.

Any changes to your CSV columns could break this integration. When you make changes you will need to create a new integration and map the new metadata fields.

JSON Metadata Files

If you save your metadata as JSON files you can send those files to Voxjar's FTP server too.

Each JSON metadata file should represent 1 call.

Voxjar will only download calls that have a matching JSON file and that match the rules you set in your Queues.

Your JSON file must contain a field that references the call recording's file name (if you are also sending audio files to the FTP server) or a public download url for the audio, so Voxjar can link the data to the call. You do not need to provide the full call recording path in the JSON file since you have already provided that. Just the file name or url.

During set up, you will need to provide a sample JSON file so you can map your columns to metadata fields in Voxjar.

Any changes to your JSON fields and values could break this integration. When you make changes you will need to create a new integration and map the new metadata fields.

 

upload sample json file for metadata parsing from Voxjar's ftp server

Map your Metadata

Metadata lets Voxjar label your call recordings with standard and custom fields. This is useful for filtering results, identifying specific calls, linking calls to agents, and selecting which call recordings should be evaluated.

There are three options for AWS S3:

  1. Parse metadata from the audio file name eg. call-id_agent-id_timestamp.wav
  2. Extract metadata from a single CSV file
    1. that includes the call recordings' file names
    2. that includes a public download url for the audio file
  3. Extract metadata from JSON files (1 per audio file)
    1. that includes the call recordings' file names
    2. that includes a public download url for the audio file

Parse Audio File Name Metadata

Call recordings will often contain metadata in their file names. You can tell Voxjar how to parse that data and assign some of it to specific metadata fields in Voxjar.

Each field will need to be separated by the same delimiter. That delimiter should not be used anywhere else in the file name or Voxjar will not be able to successfully parse the call recording file names.

Custom metadata is not supported for file name parsing.

The supported fields are:

  • Call Identifier
  • Call Timestamp
  • AgentId
  • AgentName
  • CustomerId
  • CustomerName
  • CustomerPhone
select delimiter and metadata fields for Voxjar's SFTP server call recordings

CSV/JSON File Mappings

Voxjar will parse as many CSV columns or JSON fields as it can from your provided files to give you flexibility in labelling your calls.

You can assign each one to a Standard or Custom Voxjar metadata field.

Custom metadata mapping uses the field or column name as the label in Voxjar and requires that you select a data type so Voxjar can treat it correctly.

Currently, only the String/Text type custom fields are used to filter your Queues

Supported data types are:

  • String/Text
  • Number (whole numbers)
  • Boolean (true/false)
  • Duration 
  • Percent (decimals)
  • DateTime

The standard Voxjar fields are:

  • AudioFileName - This is the only required mapping if using audio file names
  • DownloadURL - This is the only required mapping if using download urls
  • Transcript - (how to bring your own transcripts)
  • Call Identifier
  • Call Timestamp
  • AgentId
  • AgentName
  • CustomerId
  • CustomerName
  • CustomerPhone
JSON metadata mapping for call recordings on Voxjar's sftp server

Credentials

Once you have saved your metadata map, Voxjar will generate a private SFTP folder and unique credentials for you.

You can now send data to this FTP server and create a Queue to download and assign your calls to your QA team or to Voxjar's AI evaluator.

Voxjar FTP credentials