| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /files |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* Query for files
*/
@Api(Description="Query for files")
open class ListFiles : ListRequest<FileInfo>()
{
/**
* Filter by account id
*/
@ApiMember(Description="Filter by account id")
var accountIds:ArrayList<String> = ArrayList<String>()
/**
* Filter by customer id
*/
@ApiMember(Description="Filter by customer id")
var customerIds:ArrayList<String> = ArrayList<String>()
/**
* Filter by specific session
*/
@ApiMember(Description="Filter by specific session")
var sessionId:String? = null
/**
* Filter by file name (contains filter)
*/
@ApiMember(Description="Filter by file name (contains filter)")
var fileName:String? = null
/**
* Filter by content type (contains filter)
*/
@ApiMember(Description="Filter by content type (contains filter)")
var contentType:String? = null
/**
* Filter by type
*/
@ApiMember(Description="Filter by type")
@SerializedName("type") var Type:FileTypes? = null
/**
* Filter by date created (start of range)
*/
@ApiMember(Description="Filter by date created (start of range)")
var dateCreatedStart:String? = null
/**
* Filter by date created (end of range)
*/
@ApiMember(Description="Filter by date created (end of range)")
var dateCreatedEnd:String? = null
/**
* Filter by agent ID
*/
@ApiMember(Description="Filter by agent ID")
var userId:String? = null
/**
* Search transcription
*/
@ApiMember(Description="Search transcription")
var transcriptionContains:String? = null
}
open class ListRequest<T> : IGet
{
/**
* The page of data to retrieve
*/
@ApiMember(Description="The page of data to retrieve")
var page:Int? = null
/**
* If you want all objects to be returned. This should be used with care
*/
@ApiMember(Description="If you want all objects to be returned. This should be used with care")
var all:Boolean? = null
/**
* The number per page to retrieve
*/
@ApiMember(Description="The number per page to retrieve")
var countPerPage:Int? = null
/**
* Specific IDs
*/
@ApiMember(Description="Specific IDs")
var specificIds:ArrayList<String> = ArrayList<String>()
/**
* Specify a sort field
*/
@ApiMember(Description="Specify a sort field")
var sortField:String? = null
/**
* Specify a sort order
*/
@ApiMember(Description="Specify a sort order")
var sortOrder:SortOrders? = null
/**
* Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
*/
@ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")
var simplifiedPaging:Boolean? = null
}
enum class SortOrders
{
Ascend,
Descend,
}
open class FileInfo : EntityInfo()
{
/**
* The type of file this is
*/
@ApiMember(Description="The type of file this is")
@SerializedName("type") var Type:FileTypes? = null
/**
* The account ID this file is associated with
*/
@ApiMember(Description="The account ID this file is associated with")
var accountId:String? = null
/**
* The name of the account this file is associated with
*/
@ApiMember(Description="The name of the account this file is associated with")
var accountName:String? = null
/**
* The ID of the customer this file is associated with
*/
@ApiMember(Description="The ID of the customer this file is associated with")
var customerId:String? = null
/**
* The name of the customer this file is associated with
*/
@ApiMember(Description="The name of the customer this file is associated with")
var customerName:String? = null
/**
* The breadcrumb to the customer for this file
*/
@ApiMember(Description="The breadcrumb to the customer for this file")
var customerBreadcrumb:ArrayList<CustomerBreadcrumb> = ArrayList<CustomerBreadcrumb>()
/**
* The ID of the user this file is assocaited with
*/
@ApiMember(Description="The ID of the user this file is assocaited with")
var userId:String? = null
/**
* The name of the user this file is associated with
*/
@ApiMember(Description="The name of the user this file is associated with")
var userName:String? = null
/**
* The original file name for the file
*/
@ApiMember(Description="The original file name for the file")
var fileName:String? = null
/**
* The URI of the file
*/
@ApiMember(Description="The URI of the file")
var uri:String? = null
/**
* The Content type of the file
*/
@ApiMember(Description="The Content type of the file")
var contentType:String? = null
/**
* The size of the file
*/
@ApiMember(Description="The size of the file")
var contentLength:Long? = null
/**
* The Twilio ID of the recording
*/
@ApiMember(Description="The Twilio ID of the recording")
var recordingSid:String? = null
/**
* The duration of the recording in seconds
*/
@ApiMember(Description="The duration of the recording in seconds")
var recordingDuration:Int? = null
/**
* Who is the recording from?
*/
@ApiMember(Description="Who is the recording from?")
var recordingFrom:String? = null
/**
* Transcription (if available)
*/
@ApiMember(Description="Transcription (if available)")
var transcription:String? = null
/**
* From Address (e.g. caller ID) for incoming calls
*/
@ApiMember(Description="From Address (e.g. caller ID) for incoming calls")
var fromAddress:String? = null
/**
* To Address (e.g. dialed number) for outgoing calls
*/
@ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")
var toAddress:String? = null
}
open class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
var id:String? = null
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
var dateCreated:String? = null
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
var dateLastModified:String? = null
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
var createdBy:String? = null
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
var lastModifiedBy:String? = null
}
enum class FileTypes
{
Upload,
VoiceMessage,
CallRecording,
Fax,
Attachment,
FaxOutgoing,
}
open class CustomerBreadcrumb
{
var id:String? = null
var name:String? = null
}
open class ListResponse<AccountInfo>
{
/**
* The items
*/
@ApiMember(Description="The items")
var items:ArrayList<AccountInfo> = ArrayList<AccountInfo>()
/**
* The total number of items
*/
@ApiMember(Description="The total number of items")
var totalCount:Int? = null
/**
* The total number of pages
*/
@ApiMember(Description="The total number of pages")
var totalPages:Int? = null
/**
* Are there more pages of items? Used with simplified paging
*/
@ApiMember(Description="Are there more pages of items? Used with simplified paging")
var hasMorePages:Boolean? = null
}
open class AccountInfo : EntityInfo()
{
/**
* The name of this account
*/
@ApiMember(Description="The name of this account")
var name:String? = null
/**
* The ID of this account's parent
*/
@ApiMember(Description="The ID of this account's parent")
var parentAccountId:String? = null
/**
* The twilio account SID
*/
@ApiMember(Description="The twilio account SID")
var twilioAccountSid:String? = null
/**
* The ancestors of this account. Useful for breadcrumbs
*/
@ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
var ancestorIds:ArrayList<String> = ArrayList<String>()
/**
* The max number of phone numbers this account can have
*/
@ApiMember(Description="The max number of phone numbers this account can have")
var maxPhoneNumbers:Int? = null
/**
* This account is BYOA
*/
@ApiMember(Description="This account is BYOA")
var isBYOA:Boolean? = null
/**
* TrustHub Profile Sid
*/
@ApiMember(Description="TrustHub Profile Sid")
var trustHubProfileSid:String? = null
/**
* The ID of the logo file
*/
@ApiMember(Description="The ID of the logo file")
var logoId:String? = null
/**
* The URI of the logo file
*/
@ApiMember(Description="The URI of the logo file")
var logoUri:String? = null
/**
* The billing settings for this account
*/
@ApiMember(Description="The billing settings for this account")
var billingSettings:BillingSettings? = null
}
open class BillingSettings
{
var base:BillingItem? = null
var localNumbers:BillingItem? = null
var tollFreeNumbers:BillingItem? = null
var inboundVoiceCalls:BillingItem? = null
var outboundVoiceCalls:BillingItem? = null
var inboundFaxes:BillingItem? = null
var outboundFaxes:BillingItem? = null
var inboundSmsMessages:BillingItem? = null
var outboundSmsMessages:BillingItem? = null
}
open class BillingItem
{
var baseCost:Double? = null
var rawUnitMultiplier:Double? = null
var unitCost:Double? = null
var allowance:Int? = null
}
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /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}