With SFTP you can send a lot more than just audio files to Authenticx for processing. However, when you decide to upload an interaction you must also provide a separate metadata file for that interaction. In this guide we will go over the different types of interactions that you can upload via SFTP as well as how to format metadata and associate it with an interaction.

Since we accept various formats of metadata and metadata of various purposes we determined that a custom file extension enumeration would be the best approach. Simply, we define the file formats we accept as well as the file purposes we accept which you can then combine in a way that meets your metadata needs.

Accepted Metadata Formats

• JSON
• XML
• CSV (Limited support, manual metadata only)

Text File Purpose

We accept 4 different kinds of text based files being:

• Chat
• ProcessedChat
• Metadata
• MetadataExtended

Combining Purpose and Format

With the above purposes and formats you can mix and match them to create extensions that match your criteria. The general format is as follows: .<format>_<purpose>. Some example combinations are listed below

• .json_chat
• .json_meta
• .xml_meta
• .csv_meta_ext

Example Contents

.xml_meta

<CallData>  
  <CallID>9874478975</CallID>  
  <CallDirection>Inbound</CallDirection>  
  <CallDateTime>2023-01-17T08:20:32</CallDateTime>  
  <AgentUID>1163014</AgentUID>  
  <Agent>Steve Smith</Agent>  
</CallData>  

.json_meta

{  
  "InteractionIDKey": "400151927320230225",  
  "StartDateTimeUTC": "2/24/2023 11:12:15 PM",  
  "Direction": "Inbound",  
  "AgentId": "A5555",  
  "FirstName": "Joe",  
  "LastName": "Smith",  
  "Email": "[email protected]",  
  "Queue": "Support",  
  "filename": "directory/400151927320230225.wav"  
}  

Associating Interactions and Metadata

To associate an interaction file with metadata all you have to do is give the two files the same name. An example of the names of an audio interaction file and its associated metadata are below:

Audio: 2023-06-28_95810234.wav Metadata: 2023-06-28_95810234.json_meta

Metadata Consistency

Location of information stored in metadata should not vary. For example, if I have some metadata that contains the agent id I will select one key for representing that agent id and keep it consistent such as "AgentId". Do not attempt to provide that information in another place as we do not support dynamic source to target maps within metadata.

FAQ's

How should I format date fields?

All date fields should be ISO-8601 compliant. The most common ways you will see dates will either just be a Date (ex. 2013-01-17) or a Date Time (ex. 2023-01-17T08:20:32). See here for more information about the ISO-8601 standard.