| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /files/{fileId} |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Files
Imports Voice.Api
Imports Voice.Api.Customers
Namespace Global
Namespace Voice.Api
Public Partial Class EntityInfo
'''<Summary>
'''The ID of the object
'''</Summary>
<ApiMember(Description:="The ID of the object")>
Public Overridable Property Id As String
'''<Summary>
'''The date the object was created
'''</Summary>
<ApiMember(Description:="The date the object was created")>
Public Overridable Property DateCreated As String
'''<Summary>
'''The date the object was last modified
'''</Summary>
<ApiMember(Description:="The date the object was last modified")>
Public Overridable Property DateLastModified As String
'''<Summary>
'''The user that created this object
'''</Summary>
<ApiMember(Description:="The user that created this object")>
Public Overridable Property CreatedBy As String
'''<Summary>
'''The user that last modified this object
'''</Summary>
<ApiMember(Description:="The user that last modified this object")>
Public Overridable Property LastModifiedBy As String
End Class
End Namespace
Namespace Voice.Api.Customers
Public Partial Class CustomerBreadcrumb
Public Overridable Property Id As String
Public Overridable Property Name As String
End Class
End Namespace
Namespace Voice.Api.Files
Public Partial Class FileInfo
Inherits EntityInfo
Public Sub New()
CustomerBreadcrumb = New List(Of CustomerBreadcrumb)
End Sub
'''<Summary>
'''The type of file this is
'''</Summary>
<ApiMember(Description:="The type of file this is")>
Public Overridable Property Type As FileTypes
'''<Summary>
'''The account ID this file is associated with
'''</Summary>
<ApiMember(Description:="The account ID this file is associated with")>
Public Overridable Property AccountId As String
'''<Summary>
'''The name of the account this file is associated with
'''</Summary>
<ApiMember(Description:="The name of the account this file is associated with")>
Public Overridable Property AccountName As String
'''<Summary>
'''The ID of the customer this file is associated with
'''</Summary>
<ApiMember(Description:="The ID of the customer this file is associated with")>
Public Overridable Property CustomerId As String
'''<Summary>
'''The name of the customer this file is associated with
'''</Summary>
<ApiMember(Description:="The name of the customer this file is associated with")>
Public Overridable Property CustomerName As String
'''<Summary>
'''The breadcrumb to the customer for this file
'''</Summary>
<ApiMember(Description:="The breadcrumb to the customer for this file")>
Public Overridable Property CustomerBreadcrumb As List(Of CustomerBreadcrumb)
'''<Summary>
'''The ID of the user this file is assocaited with
'''</Summary>
<ApiMember(Description:="The ID of the user this file is assocaited with")>
Public Overridable Property UserId As String
'''<Summary>
'''The name of the user this file is associated with
'''</Summary>
<ApiMember(Description:="The name of the user this file is associated with")>
Public Overridable Property UserName As String
'''<Summary>
'''The original file name for the file
'''</Summary>
<ApiMember(Description:="The original file name for the file")>
Public Overridable Property FileName As String
'''<Summary>
'''The URI of the file
'''</Summary>
<ApiMember(Description:="The URI of the file")>
Public Overridable Property Uri As String
'''<Summary>
'''The Content type of the file
'''</Summary>
<ApiMember(Description:="The Content type of the file")>
Public Overridable Property ContentType As String
'''<Summary>
'''The size of the file
'''</Summary>
<ApiMember(Description:="The size of the file")>
Public Overridable Property ContentLength As Long
'''<Summary>
'''The Twilio ID of the recording
'''</Summary>
<ApiMember(Description:="The Twilio ID of the recording")>
Public Overridable Property RecordingSid As String
'''<Summary>
'''The duration of the recording in seconds
'''</Summary>
<ApiMember(Description:="The duration of the recording in seconds")>
Public Overridable Property RecordingDuration As Integer
'''<Summary>
'''Who is the recording from?
'''</Summary>
<ApiMember(Description:="Who is the recording from?")>
Public Overridable Property RecordingFrom As String
'''<Summary>
'''Transcription (if available)
'''</Summary>
<ApiMember(Description:="Transcription (if available)")>
Public Overridable Property Transcription As String
'''<Summary>
'''From Address (e.g. caller ID) for incoming calls
'''</Summary>
<ApiMember(Description:="From Address (e.g. caller ID) for incoming calls")>
Public Overridable Property FromAddress As String
'''<Summary>
'''To Address (e.g. dialed number) for outgoing calls
'''</Summary>
<ApiMember(Description:="To Address (e.g. dialed number) for outgoing calls")>
Public Overridable Property ToAddress As String
End Class
Public Enum FileTypes
Upload
VoiceMessage
CallRecording
Fax
Attachment
FaxOutgoing
End Enum
'''<Summary>
'''Get the specific file
'''</Summary>
<Api(Description:="Get the specific file")>
Public Partial Class GetFile
Implements IGet
'''<Summary>
'''The ID of the file
'''</Summary>
<ApiMember(Description:="The ID of the file")>
Public Overridable Property FileId As String
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /files/{fileId} HTTP/1.1
Host: evovoice.io
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"type":"Upload","accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"userId":"String","userName":"String","fileName":"String","uri":"String","contentType":"String","contentLength":0,"recordingSid":"String","recordingDuration":0,"recordingFrom":"String","transcription":"String","fromAddress":"String","toAddress":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}