Dokumentation voixen upload

Transcription

1 Dokumentation voixen upload This document describes how to upload voicefiles and voicefile-metadata to voixen. If you run into problems or have any questions regarding the upload of files to voixen the please contact us via How to upload files All uploads to voixen are done using the S3-protocol. Just like FTP or SCP the S3-Protocol allows to upload, download, delete files and list directories (so called "buckets"). voixen will provide with the required credentials and server information: S3 Access Key S3 Secret Access Key S3 Bucket name S3 Region or S3 Endpoint S3 Protocol Version If you are a programmer you can probably use S3 by using your preferred programming language. Often a command line client is however sufficient. Here a list of commonly used cli-tools and software libraries: Client Type Protocol minio mc cli-tool v2, v4 supported OS windows, Link powershell cli-tool v2, v4 windows aws cli cli-tool v4 s3cmd cli-tool v2, v4 windows, boto python v2, v4 aws-sdk java aws-sdk javascript java v2, v4 javascript v2, v4 Some tools require the "Region" some the Endpoint-Url in their configuration: Region Name Region Protocol Endpoint-Url EU (Ireland) eu-west-1 v2,v4 EU (Frankfurt) eu-central-1 v4 voixen Germany v2 Here an example using the minio mc command line tool:

2

3 # download mc.exe from # open a terminal and navigate to the folder where mc.exe is located # test if the mc.exe works./mc.exe --help # register endpoint for for "voixen Germany" using "voixen-de" as an alias. # Calling the command repeatedly will just update the configuration for the given alias../mc.exe config host add voixen-de <ENDPOINT-URL> <YOUR-ACCESS-KEY> <YOUR-SECRET-KEY> --api "s3v2" # if you would want to upload to EU (Ireland) instead you could use: #./mc.exe config host add voixen-eu-central-1 <YOUR-ACCESS-KEY> <YOUR-SECRET-KEY> # upload a file called sample.wav./mc.exe cp sample.wav voixen-de/<bucket>/sample.wav # list your bucket - DON'T forget the / at the end./mc.exe ls voixen-de/<bucket>/ Now you know how to upload files to voixen. Required Files In order to import calls into voixen the audio file along with an XML file that contains metadata like agent, caller number etc. is required. In rare cases when all required information are contained in the audio file name the XML file can be omitted. The audio file can either be a.wav, which we prefer, or a.mp3 file. Filenames of metadata and audio filename must match. Filenames should be adhere to the following conventions: Allowed characters Alphanumeric characters (A-Za-z0-9) Underscore (_) Hyphen (-) Not allowed characters: Whitespaces Vowel mutation (ä,ü,ö) Special characters (,?!@$&:^~ %{}[] etc.) Supported Audio Formats The audiofiles have to either in the.wav format or the mp3 format. Important specifications for.wav: Codecs: uncompressed, a-law, µ-law, PCM Precision: 16-bit Sample Rate: 8000 Hz Bit Rate: 128k Channels: 2 (Stereo) or 1 (Mono)

4 Specifications for.mp3: Sample Rate: 8000Hz Bit Rate: >= 48k XML Metadata The XML file must be in UTF-8. Make sure that you send valid XML. For that it is important to escape certain characters. The XML-standard requires the following characters to be escaped: Character XML Notation < \< > \> & \& " \" ' \&apos; The following snippet shows an valid example file: <?xml version="1.0" encoding="utf-8"?> <Recording> <CR_ID>31234xD</CR_ID> <Datum> </Datum> <Zeit>09:38:31</Zeit> <Anmeldename>Max Mustermann</Anmeldename> <Dienst>Project name</dienst> <Dauer>120</Dauer> <AnrufendeNummer> </AnrufendeNummer> <Dateiname>/root/audiofiles/test.wav</Dateiname> <ExterneId>Contract</ExterneId> </Recording> The following table explains all XML tags. Please note: The XML elements need to be specified in the order they are listed Optional Elements are marked with a * Element Name Example Value Discription Recording Root Element CR_ID * 31234xD Unique identifier from e.g. your database Datum Date of recording in a DD.MM.YYYY format. Zeit 07:22:42 Time of recording in a hh:mm:ss 24h format. With leading zeros if necessary. Anmeldename Peter Pan Alphanumeric identifier of the agent. Correct names are preferred because they can be used in the voixen search Dienst Tasty Food GmbH Project name Dauer 242 Duration of the recoring in seconds AnrufendeNummer Caller number. Prefixes like '+' are allowed

5 Element Name Example Value Discription Dateiname * /root/audio/test.wav Name and Path of the file on you system ExterneId * see below An external id which can be used as an tag and contain sub elements. For example a link. More about the this field on the next section. See below for further information. ExterneId The external id works as an additional extension of the meta data and can be either text or structured data. XML sub elements will be shown in the voixen GUI. Examples below. Links will added as hyperlinks in the GUI and can point to any other website or application. For simplicity we leave all other tags apart of the ExterneId tag in this example: Option XML Apperance in the GUI Only Text Identifier and text Multiple Identifier and Text and a Link When the upload is complete After uploading a wav and xml pair the uploaded files will remain in that bucket until they are imported. When they are imported successfully they will disappear from the bucket and instead appear on voixen.com. Valid files should disappear within 2 to 10 minutes. If they don't disappear that can mean: The import has not yet been enabled for your account The XML is not vaild Check for syntactic errors? Check the spelling of the XML-Tags? Are any required tags missing? Did you specify the tags in the wrong order?