Evo Voice

<back to all web services

UploadFile

Create a new file and return the info

"use strict";
export class EntityInfo {
    /** @param {{id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the object */
    id;
    /**
     * @type {string}
     * @description The date the object was created */
    dateCreated;
    /**
     * @type {string}
     * @description The date the object was last modified */
    dateLastModified;
    /**
     * @type {string}
     * @description The user that created this object */
    createdBy;
    /**
     * @type {string}
     * @description The user that last modified this object */
    lastModifiedBy;
}
/** @typedef {'Upload'|'VoiceMessage'|'CallRecording'|'Fax'|'Attachment'|'FaxOutgoing'} */
export var FileTypes;
(function (FileTypes) {
    FileTypes["Upload"] = "Upload"
    FileTypes["VoiceMessage"] = "VoiceMessage"
    FileTypes["CallRecording"] = "CallRecording"
    FileTypes["Fax"] = "Fax"
    FileTypes["Attachment"] = "Attachment"
    FileTypes["FaxOutgoing"] = "FaxOutgoing"
})(FileTypes || (FileTypes = {}));
export class CustomerBreadcrumb {
    /** @param {{id?:string,name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    name;
}
export class FileInfo extends EntityInfo {
    /** @param {{type?:FileTypes,accountId?:string,accountName?:string,customerId?:string,customerName?:string,customerBreadcrumb?:CustomerBreadcrumb[],userId?:string,userName?:string,fileName?:string,uri?:string,contentType?:string,contentLength?:number,recordingSid?:string,recordingDuration?:number,recordingFrom?:string,transcription?:string,fromAddress?:string,toAddress?:string,aiTranscription?:string,id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {FileTypes}
     * @description The type of file this is */
    type;
    /**
     * @type {string}
     * @description The account ID this file is associated with */
    accountId;
    /**
     * @type {string}
     * @description The name of the account this file is associated with */
    accountName;
    /**
     * @type {string}
     * @description The ID of the customer this file is associated with */
    customerId;
    /**
     * @type {string}
     * @description The name of the customer this file is associated with */
    customerName;
    /**
     * @type {CustomerBreadcrumb[]}
     * @description The breadcrumb to the customer for this file */
    customerBreadcrumb;
    /**
     * @type {string}
     * @description The ID of the user this file is assocaited with */
    userId;
    /**
     * @type {string}
     * @description The name of the user this file is associated with */
    userName;
    /**
     * @type {string}
     * @description The original file name for the file */
    fileName;
    /**
     * @type {string}
     * @description The URI of the file */
    uri;
    /**
     * @type {string}
     * @description The Content type of the file */
    contentType;
    /**
     * @type {number}
     * @description The size of the file */
    contentLength;
    /**
     * @type {string}
     * @description The Twilio ID of the recording */
    recordingSid;
    /**
     * @type {number}
     * @description The duration of the recording in seconds */
    recordingDuration;
    /**
     * @type {string}
     * @description Who is the recording from? */
    recordingFrom;
    /**
     * @type {string}
     * @description Transcription (if available) */
    transcription;
    /**
     * @type {string}
     * @description From Address (e.g. caller ID) for incoming calls */
    fromAddress;
    /**
     * @type {string}
     * @description To Address (e.g. dialed number) for outgoing calls */
    toAddress;
    /**
     * @type {string}
     * @description The AI transcription for this call */
    aiTranscription;
}
export class UploadFile {
    /** @param {{data?:string,fileName?:string,contentType?:string,convertToWav?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The file data */
    data;
    /**
     * @type {string}
     * @description The file name */
    fileName;
    /**
     * @type {string}
     * @description The file's content type */
    contentType;
    /**
     * @type {boolean}
     * @description Convert the file to WAV to be safe? */
    convertToWav;
}

JavaScript UploadFile DTOs

POST /app/files HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UploadFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.App">
  <ContentType>String</ContentType>
  <ConvertToWav>false</ConvertToWav>
  <Data>AA==</Data>
  <FileName>String</FileName>
</UploadFile>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FileInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Files">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy>
  <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated>
  <DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id>
  <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy>
  <AITranscription>String</AITranscription>
  <AccountId>String</AccountId>
  <AccountName>String</AccountName>
  <ContentLength>0</ContentLength>
  <ContentType>String</ContentType>
  <CustomerBreadcrumb xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
    <d2p1:CustomerBreadcrumb>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:CustomerBreadcrumb>
  </CustomerBreadcrumb>
  <CustomerId>String</CustomerId>
  <CustomerName>String</CustomerName>
  <FileName>String</FileName>
  <FromAddress>String</FromAddress>
  <RecordingDuration>0</RecordingDuration>
  <RecordingFrom>String</RecordingFrom>
  <RecordingSid>String</RecordingSid>
  <ToAddress>String</ToAddress>
  <Transcription>String</Transcription>
  <Type>Upload</Type>
  <Uri>String</Uri>
  <UserId>String</UserId>
  <UserName>String</UserName>
</FileInfo>