Evo Voice

UploadFile

Create a new file and return the info

**Requires Authentication**
Required role:	User

The following routes are available for this service:
POST	/app/files

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EntityInfo:
    # @ApiMember(Description="The ID of the object")
    id: Optional[str] = None
    """
    The ID of the object
    """


    # @ApiMember(Description="The date the object was created")
    date_created: Optional[str] = None
    """
    The date the object was created
    """


    # @ApiMember(Description="The date the object was last modified")
    date_last_modified: Optional[str] = None
    """
    The date the object was last modified
    """


    # @ApiMember(Description="The user that created this object")
    created_by: Optional[str] = None
    """
    The user that created this object
    """


    # @ApiMember(Description="The user that last modified this object")
    last_modified_by: Optional[str] = None
    """
    The user that last modified this object
    """


class FileTypes(str, Enum):
    UPLOAD = 'Upload'
    VOICE_MESSAGE = 'VoiceMessage'
    CALL_RECORDING = 'CallRecording'
    FAX = 'Fax'
    ATTACHMENT = 'Attachment'
    FAX_OUTGOING = 'FaxOutgoing'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerBreadcrumb:
    id: Optional[str] = None
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FileInfo(EntityInfo):
    # @ApiMember(Description="The type of file this is")
    type: Optional[FileTypes] = None
    """
    The type of file this is
    """


    # @ApiMember(Description="The account ID this file is associated with")
    account_id: Optional[str] = None
    """
    The account ID this file is associated with
    """


    # @ApiMember(Description="The name of the account this file is associated with")
    account_name: Optional[str] = None
    """
    The name of the account this file is associated with
    """


    # @ApiMember(Description="The ID of the customer this file is associated with")
    customer_id: Optional[str] = None
    """
    The ID of the customer this file is associated with
    """


    # @ApiMember(Description="The name of the customer this file is associated with")
    customer_name: Optional[str] = None
    """
    The name of the customer this file is associated with
    """


    # @ApiMember(Description="The breadcrumb to the customer for this file")
    customer_breadcrumb: Optional[List[CustomerBreadcrumb]] = None
    """
    The breadcrumb to the customer for this file
    """


    # @ApiMember(Description="The ID of the user this file is assocaited with")
    user_id: Optional[str] = None
    """
    The ID of the user this file is assocaited with
    """


    # @ApiMember(Description="The name of the user this file is associated with")
    user_name: Optional[str] = None
    """
    The name of the user this file is associated with
    """


    # @ApiMember(Description="The original file name for the file")
    file_name: Optional[str] = None
    """
    The original file name for the file
    """


    # @ApiMember(Description="The URI of the file")
    uri: Optional[str] = None
    """
    The URI of the file
    """


    # @ApiMember(Description="The Content type of the file")
    content_type: Optional[str] = None
    """
    The Content type of the file
    """


    # @ApiMember(Description="The size of the file")
    content_length: Optional[int] = None
    """
    The size of the file
    """


    # @ApiMember(Description="The Twilio ID of the recording")
    recording_sid: Optional[str] = None
    """
    The Twilio ID of the recording
    """


    # @ApiMember(Description="The duration of the recording in seconds")
    recording_duration: Optional[int] = None
    """
    The duration of the recording in seconds
    """


    # @ApiMember(Description="Who is the recording from?")
    recording_from: Optional[str] = None
    """
    Who is the recording from?
    """


    # @ApiMember(Description="Transcription (if available)")
    transcription: Optional[str] = None
    """
    Transcription (if available)
    """


    # @ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
    from_address: Optional[str] = None
    """
    From Address (e.g. caller ID) for incoming calls
    """


    # @ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
    to_address: Optional[str] = None
    """
    To Address (e.g. dialed number) for outgoing calls
    """


# @Api(Description="Create a new file and return the info")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UploadFile(IPost):
    """
    Create a new file and return the info
    """

    # @ApiMember(Description="The file data")
    data: Optional[bytes] = None
    """
    The file data
    """


    # @ApiMember(Description="The file name")
    file_name: Optional[str] = None
    """
    The file name
    """


    # @ApiMember(Description="The file's content type")
    content_type: Optional[str] = None
    """
    The file's content type
    """


    # @ApiMember(Description="Convert the file to WAV to be safe?")
    convert_to_wav: Optional[bool] = None
    """
    Convert the file to WAV to be safe?
    """

Python UploadFile DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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>
  <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>