Evo Voice

<back to all web services

AppGetFiles

Requires Authentication
The following routes are available for this service:
GET/portal/files
AppGetFiles Parameters:
NameParameterData TypeRequiredDescription
AccountIdquerystringNo
CustomerIdquerystringNo
DateCreatedStartquerystringNo
DateCreatedEndquerystringNo
FileNameFilterquerystringNo
TypequeryFileTypes?No
ListRequest<T> Parameters:
NameParameterData TypeRequiredDescription
PageformintNoThe page of data to retrieve
AllformboolNoIf you want all objects to be returned. This should be used with care
CountPerPageformintNoThe number per page to retrieve
SpecificIdsformList<string>NoSpecific IDs
SortFieldformstringNoSpecify a sort field
SortOrderformSortOrdersNoSpecify a sort order
SimplifiedPagingformboolNoDisables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
SortOrders Enum:
Ascend
Descend
FileInfo Parameters:
NameParameterData TypeRequiredDescription
TypeformFileTypesNoThe type of file this is
AccountIdformstringNoThe account ID this file is associated with
AccountNameformstringNoThe name of the account this file is associated with
CustomerIdformstringNoThe ID of the customer this file is associated with
CustomerNameformstringNoThe name of the customer this file is associated with
CustomerBreadcrumbformList<CustomerBreadcrumb>NoThe breadcrumb to the customer for this file
UserIdformstringNoThe ID of the user this file is assocaited with
UserNameformstringNoThe name of the user this file is associated with
FileNameformstringNoThe original file name for the file
UriformstringNoThe URI of the file
ContentTypeformstringNoThe Content type of the file
ContentLengthformlongNoThe size of the file
RecordingSidformstringNoThe Twilio ID of the recording
RecordingDurationformintNoThe duration of the recording in seconds
RecordingFromformstringNoWho is the recording from?
TranscriptionformstringNoTranscription (if available)
FromAddressformstringNoFrom Address (e.g. caller ID) for incoming calls
ToAddressformstringNoTo Address (e.g. dialed number) for outgoing calls
EntityInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe ID of the object
DateCreatedformstringNoThe date the object was created
DateLastModifiedformstringNoThe date the object was last modified
CreatedByformstringNoThe user that created this object
LastModifiedByformstringNoThe user that last modified this object
FileTypes Enum:
Upload
VoiceMessage
CallRecording
Fax
Attachment
FaxOutgoing
CustomerBreadcrumb Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
ListResponse<AccountInfo> Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<AccountInfo>NoThe items
TotalCountformintNoThe total number of items
TotalPagesformintNoThe total number of pages
HasMorePagesformboolNoAre there more pages of items? Used with simplified paging
AccountInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoThe name of this account
ParentAccountIdformstringNoThe ID of this account's parent
TwilioAccountSidformstringNoThe twilio account SID
AncestorIdsformList<string>NoThe ancestors of this account. Useful for breadcrumbs
MaxPhoneNumbersformintNoThe max number of phone numbers this account can have
IsBYOAformboolNoThis account is BYOA
TrustHubProfileSidformstringNoTrustHub Profile Sid
LogoIdformstringNoThe ID of the logo file
LogoUriformstringNoThe URI of the logo file
BillingSettingsformBillingSettingsNoThe billing settings for this account
BillingSettings Parameters:
NameParameterData TypeRequiredDescription
BaseformBillingItemNo
LocalNumbersformBillingItemNo
TollFreeNumbersformBillingItemNo
InboundVoiceCallsformBillingItemNo
OutboundVoiceCallsformBillingItemNo
InboundFaxesformBillingItemNo
OutboundFaxesformBillingItemNo
InboundSmsMessagesformBillingItemNo
OutboundSmsMessagesformBillingItemNo
BillingItem Parameters:
NameParameterData TypeRequiredDescription
BaseCostformdoubleNo
RawUnitMultiplierformdoubleNo
UnitCostformdoubleNo
AllowanceformintNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /portal/files HTTP/1.1 
Host: evovoice.io 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"items":[{"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"}],"totalCount":0,"totalPages":0,"hasMorePages":false}